Sidehistorik
...
Dato | Version | Ændring | Ændret af |
---|---|---|---|
| 0.9 | Opdatering af links | Thor Thomsen Krarup |
| 0.9 | Tekstuel ændring: Præcisering af dataområder under afsnittet Grunddata om elever | |
| 0.9 | Første offentliggørelse af foreløbig grænsefladebeskrivelse |
...
Håndtering af indberetninger, der ikke overholder valideringsreglerne, beskrives i afsnittet Fejlhåndtering.
Grundlæggende principper for indberetning
...
Hvis beskeden faktisk er behandlet korrekt i første omgang, vil svaret på gensendelsen af beskeden have status DUPLICATE. Var der fejl på den tidligere indberetning vil denne blive returneret som en SoapFault (se afsnittet SoapFaults for flere detajler).
IndberetningsID'et kan også bruges til at tjekke status på en indberetning med Status-operationen. Se afsnittet Operationer for flere detaljer.
Se tabellen i afsnittet Fejlhåndtering for yderligere detaljer om hvornår man forventes at gensende- eller generere en nyt IndberetningsID.
...
Elevdatabasen returnerer en status for hver indberetning som angiver om indberetningen er gået godt eller er fejlet. Alle fejl kastes som en SoapFault og er således ikke en del af Response-objektet. Soapfault indeholder fejlkoder og fejlbeskrivelser, som angiver, hvad der er galt. Se afsnittet Fejlhåndtering for en detaljeret beskrivelse om håndtering af disse fejl.
De tekniske detajler, og eksempel på request/response kan findes i afsnittet Teknisk beskrivelse af operationer
Anker | ||||
---|---|---|---|---|
|
Anvendes til at hente - eller genhente - status for en indberetning ud fra det ID som indberetningen er foretaget på. Ved status FAILED
, vil responset indeholde valideringsfejlene, der efterfølgende kan behandles af afhenter. Svaret fra Status-operationen er identisk med svaret på en indberetning, og kan benyttes ved tvivl om hvorvidt en indberetning er gået godt.
De tekniske detajler, og eksempel på request/response kan findes i afsnittet Teknisk beskrivelse af operationer
Ping
Anvendes til at pinge Elevdatabasen.
De tekniske detajler, og eksempel på request/response kan findes i afsnittet Teknisk beskrivelse af operationer
Anker | ||||
---|---|---|---|---|
|
...
Errorcode | Exception (SoapFault type) | Beskrivelse | Automatisk gensendelse mulig | Nyt IndberetningsID ved genindberetning |
---|---|---|---|---|
<ingen> | <ingen> | Hvis kaldet timer ud, eller andet går galt der gør at svar ikke kommer tilbage fra Elevdatabasen, vil fejlkode typisk være implementationsspecifikke for det enkelte system. Som eksempel kunne dette være en "ConnectionClosed" eller "TimeoutException". | Ja | Nej |
Elevdb-1000 | InternalServerException | Intern server fejl på Elevdatabasen | Ja | Ja |
Elevdb-1001 | InternalServerException | Denne fejl vises, hvis en operation endnu ikke er færdigimplementeret. Fejlen bør aldrig opstå på operationer beskrevet her. Kontakt STIL support hvis denne alligevel opstår. | Nej; Kontakt STIL support | N/A |
Indb-2003 | IndberetningOutOfOrderException | Denne fejl opstår, hvis Elevdatabasen modtager 2 indberetninger på samme elev samtidig. Dette kan kun ske, hvis kravet om håndtering af samtidighed (se afsnittet Integrationsmønstre) ikke overholdes. Kontakt STIL's support, hvis fejlen opstår på trods af en korrekt implementering. | Nej; der er lavet en implementationsfejl der bør rettes | N/A |
Indb-2004 | InvalidIndberetning | Data på indberetningen er ugyldig. | Nej, data skal rettes manuelt | Ja |
Indb-2005 | AfdelingDoesNotMatchHovedInstitutionException | Afdelingen skal hører til hovedinstitutionen, hvis Afdeling og Hovedinstitutionsnummer angivet i request er forskellige. | Nej, data skal rettes manuelt | Nej |
Pers-1000 | InternalServerException | Fejl ved validering af CPR-oplysninger. Selvom dette er en intern fejl der opstår, hvis fx CPR-registeret ikke svarer, så skal der i dette tilfælde genereres et nyt IndberetningsID for at sikre indberetningen håndteres igen. | Ja | Ja |
...
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
ErrorCode | String | Ingen/Ikke relevant | J | 1 | Fejlkode |
ErrorMessage | String | Ingen/Ikke relevant | J | 1 | Beskrivelse af fejlen |
Status | Enum | DUPLICATE, FAILED | J | 1 | Status på indberetningen. DUPLICATE angiver, at data tidligere er modtaget på IndberetningsID'et, og behandlet uden fejl. Ingen data er blevet behandlet i dette request, og fejl listet i Indberetningsdetaljer er således fejl fra den tidligere indberetning
|
Indberetningsdetaljer | List<Indberetningsdetalje> | Ingen/Ikke relevant | J | Unbounded | Udspecificeret liste med fejlkoder og beskrivelser |
...