Versioner sammenlignet

Nøgle

  • Linjen blev tilføjet.
  • Denne linje blev fjernet.
  • Formatering blev ændret.

...

UI Expand
expandedtrue
titleEcho

echo()

  • Tester forbindelsen til webservicen og leverer en OK ved succes.
  • Returnerer en kode 200 ved en connection og en 500 for fejl.= "Forbindelse oprettet" eller en 500 = "Forbindelse ikke oprettet"



UI Expand
expandedtrue
titleHent ansøgninger for en KUI institution
  • GetAnsoegningIdsByKUIInstitutionsNr (int KUIInstitutionsNr, int64 lastRequestTime, int? filterKommuneKode)
    • Tager imod tre parametre. KUIInstitutionsNr, en epoch for sidste hentninger af ansøgninger og en filterKommuneKode.
    • Returnerer en liste af objekter bestående af ansøgningsID samt en int64  unix epoch for hvornår ansøgningen er oprettet / opdateret samt en status.
    • Returnerer alle ansøgninger oprettet af ansøgere der bor i kommuner, som er serviceret af den angivne KUI institution, og hvor ansøgeren er under 25 år ved afhentningstidspunkt
    • Hvis man kun ønsker ansøgninger fra ansøgere der bor i en specifik kommune som KUI servicerer, angiver man en filterKommuneKode og servicen vil således kun returnere ansøgninger fra ansøgere i den pågældende kommune
    • Henter ansøgninger med status SENDT og SLETTET. 
    • Den returnerede liste består kun af ansøgningsIDer, hvor i der er sket ændringer siden lastRequestTime (ændringstidspunkt >= lastRequestTime) .
    • Ønsker man alle ansøgninger for en kommune, udlader man lastRequestTime.
    • Statuskoder:
      • 200: OK. Hentning gik godt.
      • 204: Ingen opdateringer. Der er ingen opdaterede ansøgninger siden sidste hentning
      • 401: Institutionsnummeret er ikke gyldigt til at hente. Institutionsnummeret findes ikke i Søg uddannelses database


  • GetAnsoegningListByIds(int KUIInstitutionsNr, int[] ansøgningIDs)
    • Tager imod en liste af ansøgningsID'er, samt KUIInstitutionsNr.
    • Returnerer et ansøgnings objekt som indeholder alle informationer om ansøgningen, samt en liste af bilag objekter som indeholder det originale filnavn, bilagets type samt en datetime for hvornår bilaget er oprettet og gemt.
    • Returnerer kun ansøgninger med status SENDT
    • returnerer kun ansøgninger for ansøgere der er under 25 år ved afhentningstidspunkt
      - OBS husk at opdatere hvornår sidste hentning er lavet.
    • Statuskoder: 
      • 200: OK. Hentning gik godt.
      • 401: Institutionsnummeret er ikke gyldigt til at hente. Institutionsnummeret findes ikke i Søg uddannelses database
      • 404: Ingen ansøgninger fundet. Der blev ikke fundet nogle ansøgninger som matcher parametrene



UI Expand
expandedtrue
titleHent bilag
  • GetTicketForBilagGetURLForBilag(int insitutionsNr / kommuneNummer, int ansoegningId, int bilagId)
    • Tager imod tre parametre. En int for institutionsNr
  • eller kommunenummer
    • , int for anøsgningsId samt en int for bilagID.
    • Returnerer en
  • ticket
    • URL som vil skulle bruges på filservicen til at hente det specifikke bilag.
    • InstitutionsNr er nummeret på institutionen som ansøgningen sendes til (ansøgningsinstitution)
    • Returnerer en fejl, hvis institutionen ikke har ret til at hente den angivne ansøgning eller det angivne Bilag
    • Hvis bilaget ikke eksisterer får man en bad request  med teksten 'Bilag findes ikke'
    • Hvis ansøgningen er slettet får man en bad
  • request 
    • request 'Ansøgningen findes ikke'

    • Statuskoder: 
      • 200: OK. Hentning gik godt.
      • 404: Bilag eller ansøgning ikke fundet. AnsoegningId eller bilagId matcher ikke med nogen værdi fra databasen.
      • 401: Institutionsnummeret er ikke gyldigt til at hente. Det angivne institutionsnummer er ugyldigt eller har ikke adgang til at hente bilaget
      • 400: Bilaget eksisterer ikke på ansøgningen. Det angivne bilag er ikke tilknyttet til ansøgningen
      • 503: Fejl i filservice. Der opstod en ukendt fejl i kommunikationen med filservice


  • GetURLForAlleBilag(string insitutionsNrGetTicketForAllBilagForAnsoegning(string insitutionsNr / kommuneNummer, string ansoegningID)
    • Tager imod to parametre. En string for institutionsNr eller kommunenummer, samt en string for ansøgningID.
    • Returnerer en ticket URL som vil skulle bruges i filservicen til at hente en zip-fil for alle bilagene for en specifik ansøgning.
    • InstitutionsNr er nummeret på institutionen ansøgningen sendes til (ansøgningsinstitution)
    • Statuskoder: 
      • 200: OK. Hentning gik godt.
      • 404: Ansøgning ikke fundet. AnsoegningId matcher ikke med nogen værdi fra databasen.
      • 401: Institutionsnummeret er ikke gyldigt til at hente. Det angivne institutionsnummer er ugyldigt eller har ikke adgang til at hente bilag fra ansøgningen
      • 503: Fejl i filservice. Der opstod en ukendt fejl i kommunikationen med filservice


Sekvens diagram


Image Modified



Image RemovedImage Added


Image RemovedImage Added