Dokumenthistorik
Dato | Ændring | Ændret af |
---|---|---|
| Kopieret fra v1.0 og nye felter tilføjet (Afgangsårsag, Slutdato, IndmeldtOptagetDato) | |
| Datovalidering på Elevskoleperioder ift. forløb indføjet. Kardinalitet på Elevskoleperioder præciseret | |
| Fejlmeldinger Inst-05 og Inst-06 tilføjet |
Indhold
Ændringer ift. v1.0
Der er tilføjet 3 nye felter for uddannelsesdata: IndmeldtOptagetDato, Afgangsårsag, Slutdato.
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 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 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:
Indberetning til Elevdatabasen
Grunddata om elever
Denne sektion beskriver i overordnede træk de tre dataområder i Elevdatabasen, der tilsammen udgør grunddata om elever, og mod hvilke kilder denne data valideres.
Elevdatabasens dataområder:
- Persondata - Indeholder elevens personnummer. Data valideres mod Det Centrale Personregister (CPR)
- Institutionsdata - Indeholder hovedinstitution og afdeling for den indberettende institution. Data valideres mod Institutionsregisteret
- Uddannelsesdata - Data om den uddannelse, eleven går på - eksempelvis uddannelseskode, uddannelsesversion, skoleperioder, mv. Data valideres mod Uddannelsesmodellen
For en detaljeret gennemgang af de enkelte valideringer, se afsnittet om Valideringsregler.
Håndtering af indberetninger, der ikke overholder valideringsreglerne, beskrives i afsnittet Fejlhåndtering.
Grundlæggende principper for indberetning
- En indberetning skal indeholde gældende data for en elev.
- En indberetning skal indeholde historisk data for eleven for den pågældende uddannelse og institution.
- Ved ændringer til data på eleven, skal indberetning ske senest dagen efter at ændringen er trådt i kraft.
- En indberetning må ikke indeholde forventede fremtidige ændringer
Omfattede uddannelser
Grundskole
Alle elever, der går på en grundskoleuddannelse, skal indberettes til Elevdatabasen, herunder folkeskoler, fri- og privatskoler, efterskoler mv.
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.
Integrationsmønstre
Denne sektion beskriver de krav som SA-systemet skal opfylde ved integration til Elevdatabasen. Kravene er vigtige for at sikre en stabil service og data af høj kvalitet.
Sikring af stabil drift
For at sikre stabil drift af Elevdatabasen, skal integrationen designes så der maksimalt sendes 20 requests i sekundet per SA-system.
Det er tilladt at indberette parallelt, så længe det samlede antal requests holdes under denne grænse og kravet om indberetning på samme CPR-nummer (Håndtering af samtidighed) overholdes.
Hvis en indberetning fejler, og der automatisk prøves igen, skal disse indberetninger stadig ske kontrolleret jf. dette krav. Det anbefales ydermere at man ved gentagende fejl øger forsinkelsen for hvornår der prøves igen.
Håndtering af samtidighed
Da beskeder kan skifte rækkefølge i både netværk og på Integrationsplatformen (IPL), giver det en risiko for at ændringer kan 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å den sidste indberetning for det pågældende CPR-nummer.
Ønsker man at parallelisere indberetningerne, er det derfor vigtigt at paralleliseringen sker grupperet på CPR-nummer.
Håndtering af udfald i netværk og infrastruktur
Alle indberetninger skal påsættes et IndberetningsId af typen UUID for at undgå dobbeltindberetninger ved fejl i netværk eller anden infrastruktur.
Hvis der ikke modtages et svar på en indberetning - f.eks. fordi svaret er gået tabt i netværket eller forbindelsen lukkes inden processeringen er færdig, forventes det at SA-systemet gensender den samme besked med samme IndberetningsId.
Hvis beskeden faktisk er behandlet korrekt ved første indberetning, vil svaret på gensendelsen af beskeden have status DUPLICATE. Var der valideringsfejl på den tidligere indberetning vil denne blive returneret som en SoapFault (se afsnittet SoapFaults for flere detajler).
IndberetningsId'et kan 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 SA-systemet forventes at gensende en indberetning på et IndberetningsId.
Webservice
Denne sektion beskriver webservicen til indberetning.
Adgang til 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 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 |
De tekniske detaljer og eksempler på request/response kan findes i afsnittet Teknisk beskrivelse af operationer.
Indberet
Indberetning af data til Elevdatabasen sker med operationen Indberet for én elev af gangen.
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.
Status
Anvendes til at hente 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 operationen kan benyttes ved tvivl om hvorvidt en indberetning er gået godt.
Slet
Anvendes til at 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 opererer med 3 typer af fejlkoder, Elevdb-XXXX, Indb-XXXX og Pers-XXXX. Elevdb-XXXX dækker over interne fejl på Elevdatabasen. Indb-XXXX dækker over fejl i indberetningen fra de studieadministrative systemer til Elevdatabasen. Pers-XXXX dækker over fejl ved valideringen af personoplysninger mod CPR.
Tabellen nedenfor indeholder en oversigt over de enkelte fejlkoder og information om, hvordan disse fejl skal håndteres.
ErrorCode | Fejlbeskrivelse | Forklaring | Automatisk gensendelse mulig | Nyt IndberetningsId ved genindberetning |
---|---|---|---|---|
<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 | 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 | Ikke defineret | Intern fejl på Elevdatabasen. Kontakt STIL support. | Nej; Kontakt STIL support | N/A |
Indb-2003 | 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 | Indberetningen på indberetningsid #IndberetningsId er ugyldig | Data på indberetningen er ugyldig. | Nej; Data skal rettes manuelt | Ja |
Pers-1000 | 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 |
SoapFaults
Elevdatabasen returnerer både interne fejl og datafejl som SoapFaults. 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 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 | 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 | 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 | 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.
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. |
Inst-05 | Eleven er startet efter 01-08-2023 og kan derfor ikke indberettes fra en hovedinstitution. |
Inst-06 | Personen kunne ikke findes |
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-08 | Afgangsårsagen #afgangsårsag findes ikke i Uddannelsesmodellen |
Udd-09 | Slutdato må ikke være tom, hvis afgangsårsag er udfyldt. Slutdato skal indeholde afgangsdatoen, hvis afgangsårsag er udfyldt |
Udd-10 | Elevskoleperiodens startdato #elevskoleperiodestart skal være før elevskoleperiodens slutdato #elevskoleperiodeslut |
Udd-11 | Slutdato #Slutdato må ikke ligge før IndmeldtOptagetDato #IndmeldtOptagetDato |
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 |
Udd-17 | Skoleperioden #skoleperiode på uddannelsen #uddannelseskode i version #version mangler et speciale |
Udd-18 | Skoleperioden #skoleperiode på uddannelsen #uddannelseskode i version #version mangler en elevtype |
Udd-19 | Det er ikke muligt at indberette på #uddannelseskode |
Udd-20 | Slutdato #Slutdato kan ikke bruges |
Udd-21 | IndmeldtOptagetDato #IndmeldtOptagetDato kan ikke bruges |
Udd-22 | Start- eller slutdato for skoleperioden #skoleperiode falder uden for den samlede periode for hele uddannelsesforløbet (#IndmeldtOptagetDato-#ForløbSlutdato) |
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
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 | 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. |
IndmeldtOptagetDato | Date | Ingen/Ikke relevant | J | 1 | Dato for elevens optagelse (eller indskrivning) på uddannelsen på denne institution/afdeling. Denne dato skal altid være defineret for elever, der indberettes. |
Afgangsaarsag | String | Max længde: 15 | N | 1 | Årsag til elevens ophør på uddannelsen. Feltet kan være tomt, indtil afgangsårsag er fastlagt for eleven. For ungdomsuddannelser (indtil videre GYM) anvendes de centralt udmeldte afgangsårsager (Reviderede afgangsårsager). Hvis en elev skifter afdeling og fortsætter samme uddannelse på en anden afdeling under samme hovedinstitution, indberettes tomt felt i Afgangsaarsag. Kun relevant for ungdomsuddannelserne. |
Slutdato | Date | Ingen/Ikke relevant | N | 1 | Sidste dag, eleven har tilknytning til institutionen/afdelingen. Kan være tom indtil tidspunktet er fastlagt. Hvis Afgangsaarsag er defineret, skal Slutdato også være defineret og udfyldt med elevens afgangsdato. Hvis en elev skifter afdeling og fortsætter samme uddannelse på en anden afdeling under samme hovedinstitution, registreres Slutdato, mens Afgangsaarsag er tom. |
Elevskoleperioder | List<Elevskoleperiode> | Ingen/Ikke relevant | J | 0..n | 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. |
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 |
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
Felt | Datatype | Begrænsninger | Krævet | Kardinalitet | Beskrivelse |
---|---|---|---|---|---|
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å eleven hvis 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 |
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 |