Sidehistorik
...
Dato | Version | Ændring | Ændret af | ||||
---|---|---|---|---|---|---|---|
| 1.0 | .9Første offentliggørelse af foreløbig grænsefladebeskrivelse | Interface til operationen Slet tilføjet, implementering af funktionaliteten udestår. | ||||
| 1.0 | .9Sammenfletning af Elevdata og Uddannelsesdata | Tilføjelse af valideringsregler Udd-15 og Udd-16 | ||||
3 feb | 1.0.9 | Opdatering af links | Thor Thomsen Krarup | 9. mar.Orientering om kommende slettefunktion | |||
| 1.0 | Valideringsregel Udd-12 er fjernet | |||||
Opdatering af valideringsregler vedr. Institutionsdata | 16. mar |
| 1.0 | .9Præcisering af fejlbeskederOpdateret jf. ny struktur i webservicen og udgivet i version 1.0 | |||
29 mar | 1.0.9 | Afgangsårsager udgår og fejlvalideringsregler opdateres | Ukendt bruger (jpe)Opdaterede eksempler iht. IPL struktur |
UI Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
...
...
|
...
|
...
|
Indhold
Indholdsfortegnelse maxLevel 3 exclude Indhold
Bemærk | ||
---|---|---|
| ||
Indberetning af afgangsårsager er udgået fra Elevdatabasens indberetningsflade |
Elevdatabasen
|
Indhold
Indholdsfortegnelse maxLevel 3 exclude Indhold|Dokumenthistorik
Elevdatabasen
Elevdatabasen er et nyt grunddatasystem i Styrelsen for It og Læring (STIL), indeholdende grunddata om elever på uddannelser under Børne- og Undervisningsministeriets (BUVM) ressortområde. De konkrete grunddata omfatter oplysninger om elevers aktuelle tilknytning til institutioner og uddannelser, herunder trin, start- og slutdatoer mv. De overordnede dataområder, Elevdatabasen opererer med, er persondata, institutionsdata og uddannelsesdata.
I dag indhenter en række fagsystemer i STIL helt eller delvist egne elevdata. Hertil kommer også månedlige og kvartalsvise statistikindberetninger til Datavarehuset. Elevdatabasen vil minimere antallet af indberetningsprocesser fra institutionerne til STIL's systemer, således indberetningen af grunddata om elever fremover kun sker til ét sted. Dette skal medvirke til at STIL's fagsystemer fremover trækker elevdata fra Elevdatabasen. Den skal således udgøre et fælles datagrundlag for elevdata, som understøtter datakvalitet og de administrative og statistiske opgaver på tværs af STIL. Det er derfor nødvendigt, at Elevdatabasen leverer et højaktuelt billede af hvilke elever, som går på hvilke gymnasiale uddannelser. Dette sikres gennem højfrekvente indberetninger af elevdata fra uddannelsesinstitutionerne.
Indberetninger til Elevdatabasen sker fra uddannelsesinstitutionernes studieadministrative systemer (SA-systemer) via en webservice udstillet på STIL’s integrationsplatform (Integrationsplatformen). Integrationsplatformen er knudepunktet for STIL’s eksternt rettede webservices. Den er en infrastrukturkomponent som via autentificering, autorisering, logning og kryptering (https) understøtter en sikker, ensartet og effektiv udveksling af data mellem STIL's centrale systemer og de eksterne systemer i sektoren. Yderligere oplysninger om tilslutning samt tekniske detaljer kan findes på STIL’s supportside for Integrationsplatformen. Det overordnede flow kan ses i diagrammet nedenfor:
...
Udvid | ||||
---|---|---|---|---|
| ||||
|
Gymnasieområdet
Alle elever, der går på en gymnasieuddannelse under formålsgruppe 2 eller 33 i Uddannelsesmodellen, skal indberettes til Elevdatabasen.
Brobygningselever og prøvedeltagere skal ikke indberettes.
|
Gymnasieområdet
Alle elever, der går på en gymnasieuddannelse under formålsgruppe 2 eller 33 i Uddannelsesmodellen, skal indberettes til Elevdatabasen.
Brobygningselever og prøvedeltagere skal ikke indberettes.
Udvid | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Udvid | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Integrationsmønstre
...
Da beskeder kan skifte rækkefølge i både netværk og på Integrationsplatformen (IPL), giver det en risiko for , at ændringer kan bliver blive overhalet, og dermed bliver data i Elevdatabasen forskellig fra den faktiske data i SA-systemet.
Rækkefølgen af indberetninger bliver først gjort endelig idet beskeden modtages af Elevdatabasen, og det er derfor ikke tilladt at indberette 2 ændringer på samme CPR-nummer i parallel.
Alle indberetninger på samme CPR-nummer skal således ske sekventielt - dvs. at næste indberetning først sendes, når svar er modtaget fra Elevdatabasen på første indberetningden sidste indberetning for det pågældende CPR-nummer.
Ønsker man at parallelisere indberetningerne, er det der derfor vigtigt at paralleliseringen sker grupperet på CPR-nummer.
...
Se tabellen i afsnittet Fejlhåndtering for yderligere detaljer om hvornår SA-systemet forventes at gensende en indberetning på et IndberetningsId.
Webservice
...
Elevdatabasens webservice udstilles på STIL's integrationsplatform (Integrationsplatformen). Integrationsplatformen anvender STIL's system Tilslutning til brug for oprettelse, administration og vedligehold af tilslutninger til services og dataadgange mellem institutioner og systemleverandører.
For at kunne indberette til Elevdatabasen er det påkrævet, at der er indgået en aftale om udveksling af data (dataadgang) mellem det studieadministrative system og den konkrete uddannelsesinstitution via Tilslutning. Dataadgangen skal oprettes på hovedinstitutionen, hvis der skal indberettes for en afdeling under en hovedinstitution.
Operationer
Der findes 3 4 operationer i Elevdatabasens indberetningswebservice.
Operation | Beskrivelse |
---|---|
Indberet | Selve indberetningen, dvs. data om elev, uddannelse mv. |
Status | Henter status for en indberetning ud fra IndberetningsId |
Slet | Sletter alle indberetninger for en elev på en institution. Kun til fejlindberetninger. |
Ping | Angiver om Elevdatabasen er funktionel |
...
Svaret fra Status-operationen er identisk med svaret på en indberetning, og operationen kan benyttes ved tvivl om hvorvidt en indberetning er gået godt.
...
Slet
Anvendes til at pinge Elevdatabasen og angiver om Elevdatabasen kan modtage indberetninger.
Fejlhåndtering
slette alle indberetninger for en bestemt elev på en institution. Operationen er udelukkende tiltænkt situationer, hvor der er indberettet elevdata på et forkert personnummer eller en forkert uddannelse. I situationer hvor der er indberettet forkerte data om en elevs skoleperioder, laves der en ny almindelig indberetning med elevens korrekte skoleperioder og data på institutionen.
Ping
Anvendes til at pinge Elevdatabasen og angiver om Elevdatabasen kan modtage indberetninger.
Fejlhåndtering
Elevdatabasen Elevdatabasen opererer med 3 typer af fejlkoder, ElevdbElevdb-XXXX, Indb-XXXX og Pers-XXXX. Elevdb-XXXX fejlkoderne dækker over interne fejl på Elevdatabasen. Indb-XXXX fejlkoderne dækker over fejl i indberetningen fra de studieadministrative systemer til Elevdatabasen. Pers-XXXX dækker over fejl i ved valideringen af personoplysninger mod CPR-oplysninger.
Tabellen nedenfor indeholder en oversigt over de enkelte fejlkoder og information om, hvordan disse fejl skal håndteres.
ErrorCodeException (SoapFault type) | Fejlbeskrivelse | Forklaring | 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 implementeringsspecifikke for det enkelte system. Som eksempel kunne dette være en "ConnectionClosed" eller "TimeoutException". | Ja | Nej | |
Elevdb-1000 | InternalServerException | Varierer alt efter fejl opstået i Elevdatabasen. Kendte scenarier listet op nedenfor fordelt på operationer: Status: Elevdatabasen kender ikke indberetningsId:
Der forespørges en status på en anden afdeling end den oprindelige indberetning blev lavet på:
Indberet: Indberetningen er endt i en ugyldig tilstand. Dette sker hvis indberetningen er fejlet under behandlingen af request og der forsøges indberettet igen på samme IndberetningsId:
Tilfælde hvor fejlen ikke er kendt:
Andre fejlbeskeder, hvor supporten for Elevdatabasen skal kontaktes
| Intern server fejl på Elevdatabasen | Ja | Ja |
Elevdb-1001 | InternalServerException | Ikke defineret | Intern fejl på Elevdatabasen. Kontakt STIL support. | Nej; Kontakt STIL support | N/A |
Indb-2003IndberetningOutOfOrderException | Data er tidligere modtaget med et højere transaktionsId end #transaktionsId | 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 afsnit om andre krav) ikke overholdes. Kontakt STIL's support, hvis fejlen opstår på trods af en korrekt implementering. | Nej; Der er lavet en implementeringsfejl der bør rettes | N/A | |
Indb-2004 | InvalidIndberetning | Indberetningen på indberetningsid #IndberetningsId er ugyldig | Data på indberetningen er ugyldig. | Nej; Data skal rettes manuelt | Ja |
Pers-1000 | InternalServerException | Der skete en fejl ved kald til Persondatamodulet | 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 |
...
Elevdatabasen returnerer både interne fejl og datafejl som SoapFaults. Elevdatabasens SoapFaults er bygget op omkring 2 overordnede elementer:
<soap:Reason> - Indeholder en overordnet beskrivelse af den pågældende fejl.
<soap:Detail> - Indeholder en mere detaljeret beskrivelse af fejlen (ErrorMessage) samt ErrorCode. I tilfælde af I tilfælde af valideringsfejl indeholder fejlbeskeden en liste af valideringsfejlkoder og dertilhørende fejlbeskrivelser indeholdt i elementet ServiceFaultDetailerV2.
Parametre for
...
ServiceFaultDetailerV2 besked ved
...
Elevdatabasens fejlbeskeder
Ved interne fejl valideringsfejl benyttes ved følgende format
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|
ServiceFaultDetailerV2 |
ServiceFaultDetailerV2 | Ingen/Ikke relevant | J | 1 |
Element, der rummer felterne med detaljer vedrørende fejlen |
ServiceFaultDetailerV2
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
CorrelationID | UUID | Ingen/Ikke relevant | J | 1 |
Parametre for SoapFault besked ved valideringsfejl
Ved valideringsfejl benyttes ved følgende format
Unik ID der genereres af Integrationsplatformen. Skal medsendes i supportsager. | |||||
Timestamp | dateTime | Ingen/Ikke relevant | J | 1 | Tidsstempel sat af Integrationsplatformen. Skal medsendes i supportsager. |
ErrorCode | string |
Ingen/Ikke relevant | J | 1 | Fejlkode | |
ErrorMessage |
string | Ingen/Ikke relevant | J | 1 |
Kort fejlbesked | |||||
Details | string | Ingen/Ikke relevant | N | 1 | Overordnet beskrivelse |
af fejlen |
SourceSystemError |
SourceSystemError | Ingen/Ikke relevant | N |
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
Se afsnittet Fejlhåndtering for håndtering af fejl...
Element, der rummer felterne med detaljer vedrørende fejlen fra Elevdatabasen |
SourceSystemError
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|
SourceSystemName |
string | Ingen/Ikke relevant | J | 1 |
System der sender fejlsbeskeden via Integrationsplatformen. Dette vil ved brug af Elevdatabasens services altid være Elevdatabasen | |
ErrorCode | string |
Ingen/Ikke relevant | J | 1 |
Fault eksempel
Følgende viser et eksempel på en SoapFault ved indberetning af request hvor der er valideringsfejl.
Overordnet fejlkode | |||||
DetailsList | DetailsList | Ingen/Ikke relevant | N | 1 | Liste, der rummer valideringsfejlene |
DetailsList
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
Detail | Detail | Ingen/Ikke relevant | N | Unbounded | Element, der indeholder de enkelte fejl |
Detail
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
Code | string | Ingen/Ikke relevant | N | 1 | Elevdatabasens valideringsfejlkode |
Description | string | Ingen/Ikke relevant | N | 1 | Elevdatabasens fejlbeskrivelse |
Fault eksempel
Følgende viser et eksempel på en SoapFault ved indberetning af request hvor der er valideringsfejl. I eksemplet er fejlen pakket ind i det format, som udstilles via Integrationsplatformen.
UI Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
| |||||||
UI Expand | |||||||
| |||||||
|
Valideringsregler
Nedenfor er listet de valideringer, der foretages på Elevdatabasen. Valideringerne er delt op i tre dele: Persondata, Institutionsdata og Uddannelsesdata.
Ved brud på valideringsregler returneres en liste af valideringsfejl som Indberetningsdetaljer i en SoapFault.
Persondata
...
Fejlkode
...
Fejltekst
...
Institutionsdata
...
Afhængig af #Flyttekode.
(#Flyttekode=1): Institution #Institutionsnummer er flyttet til institution #NyInstitutionsnummer.
(#Flyttekode=2): Institution #Institutionsnummer er flyttet til institution #NyInstitutionsnummer.
...
Afdelingen #Afdelingsinstitutionsnummer hører ikke til den hovedinstitution #Hovedinstitutionsnummer der indberettes på.
...
|
Valideringsregler
Nedenfor er listet de valideringer, der foretages på Elevdatabasen. Valideringerne er delt op i tre dele: Persondata, Institutionsdata og Uddannelsesdata.
Ved brud på valideringsregler, returneres en liste af valideringsfejl DetailsList i en SoapFault.
Persondata
Fejlkode | Fejltekst |
---|---|
Pers-01 | CPR-nummeret #CPR-nummer findes ikke i Det Centrale Personregister (CPR) |
Pers-02 | CPR-nummeret #CPR-nummer er ikke aktivt i Det Centrale Personregister (CPR) |
Institutionsdata
Fejlkode | Fejltekst |
---|---|
Inst-01 | Institutionsnummeret #Institutionsnummer er ikke aktivt |
Inst-02 | Afhængig af #Flyttekode. (#Flyttekode=1): Institution #Institutionsnummer er flyttet til institution #NyInstitutionsnummer. (#Flyttekode=2): Institution #Institutionsnummer er flyttet til institution #NyInstitutionsnummer. |
Inst-03 | Afdelingen #Afdelingsinstitutionsnummer hører ikke til den hovedinstitution #Hovedinstitutionsnummer der indberettes på. |
Inst-04 | Afdelingen, der indberettes på, er en hovedinstitution med afdelinger. Der kan ikke indberettes elever på hovedinstitutioner. Der skal indberettes på den afdeling hvor eleven modtager undervisning. |
Uddannelsesdata
Fejlkode | Fejltekst |
---|---|
Udd-01 | Den indberettede kombination af uddannelseskode, uddannelsesversion, speciale og skoleperioder er ikke gyldig |
Udd-02 | Uddannelseskoden #uddannelseskode findes ikke i Uddannelsesmodellen. |
Udd-03 | Versionen #uddannelsesversion findes ikke for uddannelsen #uddannelseskode |
Udd-04 | Skoleperioderne #skoleperioder gælder ikke for uddannelsen #uddannelseskode i version #version. |
Udd-05 | Specialet #specialekode gælder ikke for uddannelsen #uddannelseskode i version #version med skoleperioderne #skoleperioder |
Udd-07 | Tidligste registrering af eleven #tidligsteSkoleperiodeStartdato ligger før startdato for uddannelsen med uddannelseskoden #uddannelseskode i version #Version |
Udd-10 | Elevskoleperiodens startdato #elevskoleperiodestart skal være før elevskoleperiodens slutdato #elevskoleperiodeslut |
Udd-13 | Adgangsvejen #adgangsvej på skoleperiode #skoleperiode er ikke tilknyttet uddannelsen #uddannelseskode" med version #Version |
Udd-15 | Skoleperiode #skoleperiode på uddannelsen #uddannelseskode i version #version mangler en adgangsvej |
Udd-16 | Elevtypen #elevtype på skoleperiode #skoleperiode er ikke tilknyttet specialet #speciale på uddannelsen #Uddannelseskode |
Teknisk beskrivelse af operationer
Dette afsnit beskriver de tekniske detaljer for hver operation på Elevdatabasens webservice.
Indberet
Operationens struktur for request og response er indkapslet i <Message> elementet fra Integrationsplatformen og er beskrevet nedenfor:
Parametre for request
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
IndberetElevRequest | IndberetElevRequest | Ingen/Ikke relevant | J | 1 | Request på Indberetning Se beskrivelsen i afsnittet IndberetElevRequest herunder. |
IndberetElevRequest
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
IndberetningsId | UUID | Ingen/Ikke relevant | J | 1 | UUID for indberetning, genereres af indberettende system |
IndberetElev | IndberetElev | Ingen/Ikke relevant | J | 1 | Elev der indberettes data på |
IndberetElev
Uddannelsesdata
...
Den indberettede kombination af uddannelseskode, uddannelsesversion, speciale og skoleperioder er ikke gyldig
...
Teknisk beskrivelse af operationer
Dette afsnit beskriver de tekniske detaljer for hver operation på Elevdatabasens webservice.
Indberet
Operationen har følgende struktur for request og response:
Parametre for request
...
IndberetElevRequest
...
IndberetElevRequest
...
IndberetElevRequest
...
IndberetningsId
...
IndberetElev
...
IndberetElev
...
Elev der indberettes data på
IndberetElev
...
Personoplysninger
...
Institutionsoplysninger
...
Institutionsnummeret for afdelingen hvor eleven modtager undervisning
Er institutionen en selvstændig institution uden hovedinstitution skal samme institutionsnummer angives i Hovedinstitution og Afdeling.
Uddannelsesoplysninger
...
Minimums længde: 1, max længde: 4, ingen whitespace tegn
...
Den officielle uddannelseskode (CØSA-formål) for uddannelsen.
Se Uddannelsesmodellen for de gældende uddannelseskoder.
...
Elevskoleperioder
...
Elevskoleperiode
...
Skoleperiode eller trin for elevskoleperioden.
Se Uddannelsesmodellen for de gældende skoleperioder.
...
Startdato
...
Slutdato
...
Uddannelsesversion
...
Den version af uddannelsen som eleven går på.
Se Uddannelsesmodellen for de gældende versioner.
...
String
...
Minimums længde: 1, max længde: 2, ingen whitespace tegn
...
Speciale for uddannelsen, hvis uddannelsen har et speciale.
Se Uddannelsesmodellen for de gældende specialer.
...
Information om eleven er prøvefri, får specialundervisning mv.
OBS: Kun relevant for grundskoleområdet
...
Min længde 1
Max længde 4
...
Adgangsvej for elevens optag på uddannelsen.
Se Uddannelsesmodellen for de gældende adgangsveje.
...
Min længde 1
Max længde 50
...
Parametre for response
...
IndberetElevResponse
...
Response på Indberetning.
Se beskrivelsen i afsnittet IndberetElevResponse herunder.
IndberetElevResponse
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|
Personoplysninger | Personoplysninger | Ingen/Ikke relevant | J | 1 | Personoplysninger om eleven |
Institutionsoplysninger | Institutionsoplysninger | Ingen/Ikke relevant |
J | 1 |
Status på indberetningen af den enkelte elev. DUPLICATE angiver, at data tidligere er modtaget på IndberetningsID'et, og behandlet uden fejl. Ingen data er blevet behandlet i dette request.
Se afsnittet Fejlhåndtering for håndtering af fejl.I tilfælde af at status er andet end COMPLETE eller DUPLICATE betyder det at indberetningen er endt i en ugyldig tilstand.Oplysninger om institutionen, hvor eleven går | |||||
Uddannelsesoplysninger | Uddannelsesoplysninger | Ingen/Ikke relevant | J | 1 | Oplysninger om uddannelsen eleven er i gang med |
Personoplysninger
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
CPRNummer | String | Længde: 10 | J | 1 | CPR-nummer (personnummer) på eleven. Der kan ikke indberettes elever uden CPR-nummer. |
Institutionsoplysninger
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
Hovedinstitution | Heltal | Max cifre: 6 | J | 1 | Hovedinstitutionen for den afdeling hvor eleven modtager undervisning |
Afdeling | Heltal | Max cifre: 6 | J | 1 | Institutionsnummeret for afdelingen hvor eleven modtager undervisning Er institutionen en selvstændig institution uden hovedinstitution skal samme institutionsnummer angives i Hovedinstitution og Afdeling. Der kan ikke indberettes elever med en hovedinstitution som afdeling. Elever skal altid indberettes på den afdeling, de går på. |
Uddannelsesoplysninger
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
Uddannelseskode | String | Minimums længde: 1, max længde: 4, ingen whitespace tegn | J | 1 | Den officielle uddannelseskode (CØSA-formål) for uddannelsen. |
Elevskoleperioder | List<Elevskoleperiode> | Ingen/Ikke relevant | J | Unbounded | Liste af samtlige Elevskoleperioder for den pågældende elev. Elevskoleperiode er den skoleperiode eller det trin, som eleven har eller har haft på den pågældende uddannelse. |
Elevskoleperiode
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
Skoleperiode | String | Ingen/Ikke relevant | J | 1 | Skoleperiode eller trin for elevskoleperioden. |
Startdato | Date | Ingen/Ikke relevant | J | 1 | Startdato for elevskoleperioden |
Slutdato | Date | Ingen/Ikke relevant | N | 1 | Slutdato for elevskoleperioden |
Uddannelsesversion | Heltal | Max cifre: 4 | J | 1 | Den version af uddannelsen som eleven går på. |
Speciale | String | Minimums længde: 1, max længde: 2, ingen whitespace tegn | N | 1 | Speciale for uddannelsen, hvis uddannelsen har et speciale. |
Elevtype | String | Max længde: 10 | N | 1 | Information om eleven er prøvefri, får specialundervisning mv. OBS: Kun relevant for grundskoleområdet |
Adgangsvej | String | Min længde 1 Max længde 4 | N | 1 | Adgangsvej for elevens optag på uddannelsen. |
Klassebetegnelse | String | Min længde 1 Max længde 50 | N | 1 | Navnet på den klasse eleven går i |
Parametre for response
Felt | Datatype | Begrænsninger | Krævet | Beskrivelse |
---|---|---|---|---|
IndberetElevResponse | IndberetElevResponse | Ingen/Ikke relevant | J | Response på Indberetning. |
IndberetElevResponse
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
Status | Enum | DUPLICATE, COMPLETE | J | 1 | Status på indberetningen af den enkelte elev. DUPLICATE angiver, at data tidligere er modtaget på IndberetningsID'et, og behandlet uden fejl. Ingen data er blevet behandlet i dette request.
I tilfælde af at status er andet end COMPLETE eller DUPLICATE betyder det at indberetningen er endt i en ugyldig tilstand. |
UI Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
UI Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
|
Status
Operationens struktur for request og response er indkapslet i <Message> elementet fra Integrationsplatformen og er beskrevet nedenfor:
Parametre for request
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
StatusRequest | StatusRequest | Ingen/Ikke relevant | J | 1 | Request på status for indberetning. Se beskrivelsen i afsnittet StatusRequest herunder. |
StatusRequest
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
Institutionsoplysninger | Institutionsoplysninger | Ingen/Ikke relevant | J | 1 | Oplysninger om den indberettende institution |
IndberetningsId | GUID | Ingen/Ikke relevant | J | 1 | UUID for indberetningen der ønskes status for |
Institutionsoplysninger
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
Hovedinstitution | Heltal | Max cifre: 6 | J | 1 | Hovedinstitutionen for den afdeling hvor eleven modtager undervisning |
Afdeling | Heltal | Max cifre: 6 | J | 1 | Institutionsnummeret for afdelingen hvor eleven modtager undervisning Er institutionen en selvstændig institution uden hovedinstitution skal samme institutionsnummer angives i Hovedinstitution og Afdeling. |
Parametre for response
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
StatusResponse | StatusResponse | Ingen/Ikke relevant | J | 1 | Response på status. Se beskrivelsen i afsnittet StatusResponse herunder. |
StatusResponse
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
Status | Enum | CREATED, RECEIVED, DUPLICATE, PROCESSING, COMPLETE, FAILED | J | 1 | Status for behandling af indberetningen. I tilfælde at status er andet end FAILED, COMPLETE eller DUPLICATE betyder, det at indberetningen er endt i en ugyldig tilstand. |
Indberetningsdetaljer | List<Indberetningsdetalje> | Ingen/Ikke relevant | N | Unbounded | Udspecificeret liste med fejlkoder og beskrivelser |
Indberetningsdetalje
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
Fejlkode | String | Ingen/Ikke relevant | J | 1 | Elevdatabasens valideringsfejlkode |
Fejlbeskrivelse | String | Ingen/Ikke relevant | J | 1 | Beskrivelse af valideringsfejlen |
UI Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
UI Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
UI Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
Status
Status-operationen er stadig under udarbejdelse, og vi forventer at response-strukturen kommer til at matche Indberet-operationen
Parametre for request
...
StatusRequest
...
StatusRequest
...
StatusRequest
...
Institutionsoplysninger
...
Institutionsnummeret for afdelingen hvor eleven modtager undervisning
Er institutionen en selvstændig institution uden hovedinstitution skal samme institutionsnummer angives i Hovedinstitution og Afdeling.
|
Slet
Denne operation benyttes kun hvis der er indberettet data på et forkert CPR-nummer eller en forkert uddannelse.
Operationens struktur for request og response er indkapslet i <Message> elementet fra Integrationsplatformen og er beskrevet nedenfor:
Parametre for request
Parametre for response
...
StatusResponse
...
StatusResponse
...
StatusResponse
...
CREATED,
RECEIVED,
DUPLICATE,
PROCESSING,
COMPLETE,
FAILED
...
Status for behandling af indberetningen.
Se afsnittet Fejlhåndtering for information om status FAILED.
I tilfælde at status er andet end FAILED, COMPLETE eller DUPLICATE betyder, det at indberetningen er endt i en ugyldig tilstand.
...
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|
UI Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
SletRequest | SletRequest | Ingen/Ikke relevant | J | 1 | Element, der rummer detaljer om, hvad der anmodes slettes |
SletRequest
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
CPRNummer | String | Længde:10 | J | 1 | CPR-nummer (personnummer) på elevenhvis elevdata skal slettes. |
Hovedinstitution | Heltal | Max cifre: 6 | J | 1 | Institutionsnummeret for hovedinstitutionen hvor elevdata skal slettes. |
Afdeling | Heltal | Max cifre: 6 | J | 1 | Institutionsnummeret for afdelingen hvor elevdata skal slettes. Er institutionen en selvstændig institution uden hovedinstitution skal samme institutionsnummer angives i Hovedinstitution og Afdeling. |
Uddannelseskode | String | Minimum længde: 1, max længde: 4, ingen whitespace tegn | J | 1 | Den officielle uddannelseskode (CØSA-formål) for uddannelsen hvor elevdata skal slettes. |
Parametre for response
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
SletRequest | SletRequest | Ingen/Ikke relevant | J | 1 | Element, der indeholder svar på request om sletning |
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
SletStatus | Enum | Værdimængde: DELETED | J | 1 | Status på sletningen |
UI Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
| ||||||||||||||||||
UI Expand | ||||||||||||||||||
| ||||||||||||||||||
|
UI Expand | |||||
---|---|---|---|---|---|
| |||||
|
Ping
Operationen har følgende struktur for request og response
Parametre for request
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
Ping | Ping | Ingen/Ikke relevant | J | 1 | Ping kald til Elevdatabasen |
Parametre for response
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
PingReponse | PingSvar | Ingen/Ikke relevant | J | 1 | Ping svar fra Elevdatabasen |
Status | String | up, down | J | 1 | Status på ping svar fra Elevdatabasen |
UI Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
UI Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|