Breadcrumbs

Sidehistorik

Versioner sammenlignet

Nøgle

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

Dokumenthistorik

Dato	Version	Ændring	Ændret af

jan

jun. 2022

1.0

	Interface til operationen Slet tilføjet, implementering af funktionaliteten udestår.	Poul Skaanning
8. jun

Første offentliggørelse af foreløbig grænsefladebeskrivelse

Ukendt bruger (jpe)

1. feb

. 2022

1.0

Sammenfletning af Elevdata og Uddannelsesdata

Tilføjelse af valideringsregler Udd-15 og Udd-16

Thor Thomsen Krarup

feb

jun. 2022

1.0

.9Opdatering af linksThor Thomsen Krarup 9. mar.

	Orientering om kommende slettefunktion	Ukendt bruger (jpe)
5. maj 2022	1.0

.9Opdatering af valideringsregler vedr. Institutionsdata

Thor Thomsen Krarup

	Valideringsregel Udd-12 er fjernet	Poul Skaanning
20. apr

16. mar

. 2022

1.0

.9Præcisering af fejlbeskeder

Opdateret jf. ny struktur i webservicen og udgivet i version 1.0

Ulrik Sølgaard-Nielsen

26.

mar

aug. 2022

1.0

.9Afgangsårsager udgår og fejlvalideringsregler opdateresUkendt bruger (jpe)

Opdaterede eksempler iht. IPL struktur

Thor Thomsen Krarup

UI Expand

title	Arkiveret dokumenthistorik

Dato	Version	Ændring	Ændret af
7. apr. 2022	0.9	Eksempler på fejlbeskeder, request og response er opdateret	Poul Skaanning

Indhold

Indholdsfortegnelse

maxLevel	3
exclude	Indhold

Bemærk

title	Afgangsårsager

Indberetning af afgangsårsager er udgået fra Elevdatabasens indberetningsflade

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) resortområde. De konkrete grunddata omfatter oplysninger om elevers aktuelle tilknytning til institutioner og uddannelser, herunder trin, start- og slutdatoer mv. samt elevernes årsager til afgang fra de enkelte uddannelsesforløb. 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 af elevdata fra institutionerne til STIL, således indberetningen af grunddata om elever fremover kun sker til ét sted, Elevdatabasen. 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 eksterne systemer. Yderligere oplysninger om tilslutning samt tekniske detaljer kan findes på STIL’s supportside for Integrationsplatformen. Det overordnede flow kan ses i diagrammet nedenfor:

Image Removed

Indberetning til Elevdatabasen

Grunddata om elever

Følgende sektion beskriver i overordnede træk de tre dataområder i Elevdatabasen, der til sammen udgør grunddata om elever, og mod hvilke kilder denne data valideres.

Elevdatabasens dataområder:

Persondata - Indeholder elevens personnummer
Institutionsdata - Indeholder hovedinstitution og afdeling for den indberettende institution
Uddannelsesdata - Data om den uddannelse, eleven går på - eksempelvis uddannelseskode, uddannelsesversion, skoleperioder, mv.

Elevdatabasen validerer den indberettede data fra de studieadministrative systemer mod Det Centrale Personregister (CPR), Uddannelsesmodellen og Institutionsregisteret som vist i diagrammet nedenfor.

Image Removed

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 pr. indberetningsdatoen.
En indberetning skal indeholde historisk data frem til indberetningsdatoen
Ved ændringer til data på eleven skal indberetning ske senest dagen efter, at ændringen træder i kraft
En indberetning må ikke indeholde forventede ændringer
Brobygningselever og prøvedeltagere skal ikke indberettes

Omfattede uddannelser

I første omgang er det alene grunddata om elever på det gymnasiale område der skal indberettes. Det gymnasiale område defineres af de uddannelser der til enhver tid fremgår under formålsgruppe 2 og 33 i Uddannelsesmodellen.

...

29. mar. 2022	0.9	Afgangsårsager udgår og fejlvalideringsregler opdateres	Ukendt bruger (jpe)
16. mar. 2022	0.9	Præcisering af fejlbeskeder	Ulrik Sølgaard-Nielsen
9. mar. 2022	0.9	Opdatering af valideringsregler vedr. Institutionsdata	Thor Thomsen Krarup
3. feb. 2022	0.9	Opdatering af links	Thor Thomsen Krarup
1. feb. 2022	0.9	Sammenfletning af Elevdata og Uddannelsesdata	Thor Thomsen Krarup
28. jan. 2022	0.9	Første offentliggørelse af foreløbig grænsefladebeskrivelse	Ukendt bruger (jpe)

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 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:

Image Added

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

Image Added

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.

Udvid

title	Uddannelseskoder for grundskolen der skal indberettes til Elevdatabasen

Uddannelseskode (CØSA formål)	Uddannelse	Formålsgruppe

...

332	EUD10	18
2119	10. klasseundervisning	18
4800	Folkeskole	45
4801	Ungdomsskoler	45
4802	Kommunale internationale grundskoler	45
4803	Frie skoler	45
4804	Efterskoler	45

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

title	Uddannelseskoder for gymnasieområdet pr. 1/1 2022

Uddannelseskode (CØSA formål)	Uddannelse	Formålsgruppe
1064	FGU-kombi med htx fagelementer	2
1080	Studierettet påbygning, tekniske uddannelser	2
3010	Højere Handelseksamen	2
3044	2-årigt hhx kursus	2
3310	Højere teknisk eksamen	2
3311	EUX, tekniske uddannelser	2
3315	EUX, merkantile uddannelser	2
1063	FGU-kombi med hf-fagelementer	33
2992	European

...

Baccalaureate	33
2999	Ingeniør Adgangskurser	33
3000	Optagelsesprøve gymnasiale uddannelser	33
3001	Et- og flerårige enkeltfag	33
3003	Pre International Baccalaureate	33
3009	stx	33
3017	hf	33
3021	Studenterkursus	33
3028	International Baccalaureate	33
3042	Laboratoriekurser for enkeltfagselever	33

...

3312	Dansk-Tysk studentereksamen	33
3313	Dansk-Fransk Bacalaurétte	33

Integrationsmønstre

Følgende Denne sektion beskriver de krav det 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 ogkravet om indberetning på samme CPR-nummer (krav #2Hå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, da fejlen kan være relateret til en overbelastning internt i Elevdatabasen.

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 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 det 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 man først sender næste indberetning først sendes, når første svar er modtaget fra Elevdatabasen på den sidste indberetning for det pågældende CPR-nummer.
Ønsker man at parallelisere indberetninger indberetningerne, er det derfor vigtigt , at paralleliseringen sker grupperet på CPR-nummer eller institution.

Håndtering af udfald i netværk og infrastruktur

Alle indberetninger skal påsættes et IndberetningsID IndberetningsId af typen GUID, UUID for at undgå dobbeltindberetninger ved fejl i netværk elleranden 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 at gensende gensender den samme besked med samme IndberetningsIDIndberetningsId.
Hvis beskeden faktisk er behandlet korrekt i ved første omgangindberetning, vil svaret på gensendelsen af beskeden have status DUPLICATE. Var der fejl valideringsfejl på den tidligere indberetning vil denne blive returneret som en SoapFault (se afsnittet SoapFaults for flere detajler).

IndberetningsIDIndberetningsId'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 SA-systemet forventes at gensende - eller generere en nyt IndberetningsIDen indberetning på et IndberetningsId.

Webservice

Denne sektion beskriver den webservice der skal anvendes til brug for 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 (udbydere).

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 (hovedinstitutionsniveau) via Tilslutning. Yderligere oplysninger om tilslutning samt tekniske detaljer kan findes på STIL’s supportside for IntegrationsplatformenDataadgangen skal oprettes på hovedinstitutionen, hvis der skal indberettes for en afdeling under en hovedinstitution.

Operationer

Der findes følgende 3 4 operationer i Elevdatabasen, Indberet, Status og PingElevdatabasens 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 SoapFault indeholder fejlkoder og fejlbeskrivelser, som angiver, hvad der er galt. Se 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

...

Status

...

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 operationen 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

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-1000XXXX. 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 forbindelse med validering af CPR-oplysninger og kommunikation med CPR-registeret. 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	Exception (SoapFault type)ErrorCode	Fejlbeskrivelse	Forklaring	Automatisk gensendelse mulig	Nyt IndberetningsID 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 implementeringsspecifikke for det enkelte system. Som eksempel kunne dette være en "ConnectionClosed" eller "TimeoutException".	Ja	Nej
Elevdb-1000InternalServerException	Varierer alt efter fejl opstået i Elevdatabasen. Kendte scenarier listet op nedenfor fordelt på operationer: Status: Elevdatabasen kender ikke indberetningsId: Fejlbesked: Ingen indberetning fundet på indberetningsid: #IndberetningsId Der forespørges en status på en anden afdeling under hovedinstitutionen end den oprindelige indberetning blev lavet på: Fejlbesked: Institutionsnummeret #Afdeling matcher ikke den tidligere indberetning 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 indberetningsidIndberetningsId: Fejlbesked: Indberetningen på indberetningsid #Indberetningsid #IndberetningsId er i en ugyldig tilstand. Kontakt supporten for Elevdatabasen. Tilfælde hvor fejlen ikke er kendt eller modeleret: Fejlbesked: Intern server fejl Nedenstående tilfælde bør ikke opstå, derfor bør disse håndteres straks ved detektering af fejlene. Hvis det ikke er muligt for Elevdatabasen at hente request data ud af databasen som en XML streng og deserialisere denne til Java objekt repræsentationen før validering: Andre fejlbeskeder, hvor supporten for Elevdatabasen skal kontaktes Fejlbesked: Der skete en fejl ved udlæsning af data fra databasen, kontakt supporten Hvis det ikke er muligt for Elevdatabasen at konvertere Javas objekt repræsentationen af request data om til en XML streng, før data gemmes i databasen: Fejlbesked: Der skete en fejl ved indberetning af Fejlbesked: Der skete en fejl ved indberetning af data, kontakt supporten Hvis Elevdatabasen ikke kan hashe requestet før tjek af duplikat data: Fejlbesked: Digest algorithm not available. Hvis der er blevet tilføjet en ny fejlkode, men denne ikke bliver håndteret i mapningen til SOAP faults: Fejlbesked: Uventet fejl	Intern server fejl på Elevdatabasen	Ja	Ja
Elevdb-1001	InternalServerException	Ikke defineret	Denne fejl vises, hvis en operation endnu ikke er færdigimplementeret. Fejlen bør aldrig opstå på operationer beskrevet herIntern fejl på Elevdatabasen. Kontakt STIL support hvis denne alligevel opstår.	Nej; Kontakt STIL support	N/A
Indb-2003	IndberetningOutOfOrderException	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 afsnittet Integrationsmønstreafsnit om andre krav) ikke overholdes. Kontakt STIL's support, hvis fejlen opstår på trods af en korrekt implementering.	Nej; Der er lavet en implementationsfejl implementeringsfejl der bør rettes	N/A
Indb-2004InvalidIndberetning	Indberetningen på indberetningsid #IndberetningsId er ugyldig	Data på indberetningen er ugyldig.	Nej; Data skal rettes manuelt	Ja
Pers-1000InternalServerException	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 IndberetningsId for at sikre indberetningen håndteres igen.	Ja	Ja

SoapFaults

Elevdatabasen returnere returnerer både Interne interne fejl , og ugyldig 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 exception og en mere detaljeret beskrivelse af fejlen samt errorcode. I tilfælde af valideringsfejl indeholder den fejlbeskeden en liste med 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

ErrorCode
ServiceFaultDetailerV2
String
ServiceFaultDetailerV2 Ingen/Ikke relevant J 1
FejlkodeErrorMessageStringIngen/Ikke relevantJ1Beskrivelse af fejlen

Parametre for SoapFault besked ved valideringsfejl

...

Element, der rummer felterne med detaljer vedrørende fejlen

ServiceFaultDetailerV2

Felt	Datatype	Begrænsninger	Krævet	Kardinalitet	Beskrivelse

ErrorCode
CorrelationID
String
UUID Ingen/Ikke relevant J 1
FejlkodeErrorMessage
Unik ID der genereres af Integrationsplatformen. Skal medsendes i supportsager.
Timestamp dateTime
String
Ingen/Ikke relevant J 1
Beskrivelse af fejlenStatusEnum
Tidsstempel sat af Integrationsplatformen. Skal medsendes i supportsager.
ErrorCode string Ingen/Ikke relevant
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
Fejlkode
ErrorMessage string Ingen/Ikke relevant J 1
Kort fejlbesked

Details string Ingen/Ikke relevant N 1 Overordnet beskrivelse af fejlen
SourceSystemError SourceSystemError
Se afsnittet Fejlhåndtering for håndtering af fejlIndberetningsdetaljerList<Indberetningsdetalje>
Ingen/Ikke relevant
J
N
UnboundedUdspecificeret liste med fejlkoder og beskrivelser

...

1	Element, der rummer felterne med detaljer vedrørende fejlen fra Elevdatabasen

SourceSystemError

Felt	Datatype	Begrænsninger	Krævet	Kardinalitet	Beskrivelse

Fejlkode
SourceSystemName
String
string Ingen/Ikke relevant J 1
Elevdatabasens valideringsfejlkodeFejlbeskrivelse
System der sender fejlsbeskeden via Integrationsplatformen. Dette vil ved brug af Elevdatabasens services altid være Elevdatabasen
ErrorCode string
String
Ingen/Ikke relevant J 1
Beskrivelse af valideringsfejlen

Fault eksempel

Følgende viser et eksempel på en SoapFault ved indberetning af validt request, men 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

title	Eksempler på fejlbeskeder

Kodeblok

language	xml
title	Valideringsfejl

<soap:Envelope xmlns:soap

UI Expand

title	Eksempel på InvalidIndberetningException-fault (valideringsfejl)

Kodeblok

language	xml

<soap:Fault>
	<soap:Code>
		<soap:Value>soap:Sender</soap:Value>
	</soap:Code>
	<soap:Reason>
		<soap:Text xml:lang="en">Input error</soap:Text>
	</soap:Reason>
	<soap:Detail>
		<ServiceFaultDetailerV2 xmlns:ns2="http://servicewww.elevdatabasenw3.stil.dk/" xmlns="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
			<CorrelationID>21519f93-f730-49cf-b5cb-3c36bc7b0522</CorrelationID>
			<Timestamp>2022-04-07T12:38:15</Timestamp>
			<ErrorCode>IPL171003</ErrorCode>
			<ErrorMessage>Indberetning is invalid</ErrorMessage>
			<Details>Indberetningen på indberetningsid b9b7516a-9e20-4833-869c-23d8b2b374e1 er ugyldig</Details>
			<SourceSystemError>
				<SourceSystemName>Elevdatabasen</SourceSystemName>
				<ErrorCode>Indb-2004</ErrorCode>
				<DetailsList>
					<Detail>
						<Code>Inst-04</Code>
						<Description>Hovedinstitutionen 961851 er registreret som en hovedinstitution med afdelinger</Description>
					</Detail>
					<Detail>
						<Code>Udd-13</Code>
						<Description>Adgangsvejen TD er ugyldig for skoleperioderne (5)</Description>
					</Detail>
				</DetailsList>
			</SourceSystemError>
		</ServiceFaultDetailerV2>
	</soap:Detail>
</soap:Fault>

...

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.

...

Institutionen #Hovedinstitution er indberettet som en institution uden afdelinger, men institutionen er registreret som en afdeling eller hovedinstitution.

Uddannelsesdata

...

Den indberettede kombination af uddannelseskode, uddannelsesversion, speciale og skoleperioder er ikke gyldig

...

org/2003/05/soap-envelope">
   <soap:Body>
      <soap:Fault>
         <soap:Code>
            <soap:Value>soap:Sender</soap:Value>
         </soap:Code>
         <soap:Reason>
            <soap:Text xml:lang="en">Input error</soap:Text>
         </soap:Reason>
         <soap:Detail>
            <ns2:ServiceFaultDetailerV2 xmlns:ns2="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0" xmlns="http://service.elevdatabasen.stil.dk/">
               <ns2:CorrelationID>5eb3afa9-1b86-45c4-9add-3c04fbc22af2</ns2:CorrelationID>
               <ns2:Timestamp>2022-08-25T10:39:17</ns2:Timestamp>
               <ns2:ErrorCode>IPL171003</ns2:ErrorCode>
               <ns2:ErrorMessage>Indberetning is invalid</ns2:ErrorMessage>
               <ns2:Details>Indberetningen på indberetningsid 7642f9cc-4e86-4516-9135-f654ab81382f er ugyldig</ns2:Details>
               <ns2:SourceSystemError>
                  <ns2:SourceSystemName>Elevdatabasen</ns2:SourceSystemName>
                  <ns2:ErrorCode>Indb-2004</ns2:ErrorCode>
                  <ns2:DetailsList>
                     <ns2:Detail>
                        <ns2:Code>Udd-01</ns2:Code>
                        <ns2:Description>Den indberettede kombination af uddannelseskode, uddannelsesversion, speciale og skoleperioder er ikke gyldig</ns2:Description>
                     </ns2:Detail>
                     <ns2:Detail>
                        <ns2:Code>Udd-03</ns2:Code>
                        <ns2:Description>Versionen 1 findes ikke for uddannelsen 3310 på skoleperioden 1</ns2:Description>
                     </ns2:Detail>
                     <ns2:Detail>
                        <ns2:Code>Udd-04</ns2:Code>
                        <ns2:Description>Skoleperioden 1 gælder ikke for uddannelsen 3310 i version 1</ns2:Description>
                     </ns2:Detail>
                     <ns2:Detail>
                        <ns2:Code>Udd-15</ns2:Code>
                        <ns2:Description>Skoleperioden 1 på uddannelsen 3310 i version 1 mangler en adgangsvej</ns2:Description>
                     </ns2:Detail>
                  </ns2:DetailsList>
               </ns2:SourceSystemError>
            </ns2:ServiceFaultDetailerV2>
         </soap:Detail>
      </soap:Fault>
   </soap:Body>
</soap:Envelope>

Kodeblok

language	xml
title	Ugyldig indberetning

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <soap:Fault>
         <soap:Code>
            <soap:Value>soap:Receiver</soap:Value>
         </soap:Code>
         <soap:Reason>
            <soap:Text xml:lang="en">Internal error</soap:Text>
         </soap:Reason>
         <soap:Detail>
            <ns2:ServiceFaultDetailerV2 xmlns:ns2="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0" xmlns="http://service.elevdatabasen.stil.dk/">
               <ns2:CorrelationID>edf6818e-70ad-4a76-aef0-b0b58b9355e3</ns2:CorrelationID>
               <ns2:Timestamp>2022-08-26T09:11:43</ns2:Timestamp>
               <ns2:ErrorCode>IPL171001</ns2:ErrorCode>
               <ns2:ErrorMessage>An internal server error occurred on the source service</ns2:ErrorMessage>
               <ns2:Details>Uventet fejl</ns2:Details>
               <ns2:SourceSystemError>
                  <ns2:SourceSystemName>Elevdatabasen</ns2:SourceSystemName>
                  <ns2:ErrorCode>Elevdb-1000</ns2:ErrorCode>
                  <ns2:Details>Intern server fejl</ns2:Details>
               </ns2:SourceSystemError>
            </ns2:ServiceFaultDetailerV2>
         </soap:Detail>
      </soap:Fault>
   </soap:Body>
</soap:Envelope>

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-06~~
Udd-07	Tidligste registrering af eleven #tidligsteSkoleperiodeStartdato ligger før startdato for uddannelsen med uddannelseskoden #uddannelseskode i version #Version
~~Udd-08~~
~~Udd-09~~
Udd-10	Elevskoleperiodens startdato #elevskoleperiodestart skal være før elevskoleperiodens slutdato #elevskoleperiodeslut
~~Udd-11~~
~~Udd-12~~
Udd-13	Adgangsvejen #adgangsvej på skoleperiode #skoleperiode er ikke tilknyttet uddannelsen #uddannelseskode" med version #Version
~~Udd-14~~
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

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

Hovedinstitutionen for den afdeling hvor eleven modtager undervisning

Afdeling

Heltal

Max cifre: 6

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. Se Uddannelsesmodellen for de gældende uddannelseskoder.
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. Se Uddannelsesmodellen for de gældende skoleperioder.
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å. Se Uddannelsesmodellen for de gældende versioner.
Speciale	String	Minimums længde: 1, max længde: 2, ingen whitespace tegn	N	1	Speciale for uddannelsen, hvis uddannelsen har et speciale. Se Uddannelsesmodellen for de gældende specialer.
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. Se Uddannelsesmodellen for de gældende adgangsveje.
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. Se beskrivelsen i afsnittet IndberetElevResponse herunder.

IndberetElevResponse

Felt

Datatype

Begrænsninger

Krævet

Kardinalitet

Beskrivelse

Status

Enum

DUPLICATE, COMPLETE

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.

UI Expand

title	Eksempel på request til Indberet

Kodeblok

language	xml
linenumbers	true

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0" xmlns:ser="http://service.elevdatabasen.stil.dk/">
   <soap:Header/>
   <soap:Body>
      <v1:IndberetElevRequest>
         <v1:Identifier>
            <v1:SystemName>Test</v1:SystemName>
            <v1:SystemTransactionID>Test</v1:SystemTransactionID>
         </v1:Identifier>
         <v1:Message>
            <ser:IndberetElevRequest>
               <ser:IndberetningsId>32ed0545-b6a0-4e91-bf7b-0fc0dff8ef73</ser:IndberetningsId>
               <ser:IndberetElev>
                  <ser:Personoplysninger>
                     <ser:CPRNummer>0101010101</ser:CPRNummer>
                  </ser:Personoplysninger>
                  <ser:Institutionsoplysninger>
                     <ser:Hovedinstitution>961851</ser:Hovedinstitution>
                     <ser:Afdeling>961851</ser:Afdeling>
                  </ser:Institutionsoplysninger>
                  <ser:Uddannelsesoplysninger>
                     <ser:Uddannelseskode>3017</ser:Uddannelseskode>
                     <ser:Elevskoleperioder>
                        <!--1 or more repetitions:-->
                        <ser:Elevskoleperiode>
                           <ser:Skoleperiode>1</ser:Skoleperiode>
                           <ser:Startdato>2020-08-01</ser:Startdato>
                           <!--Optional:-->
                           <ser:Slutdato>2021-06-22</ser:Slutdato>
                           <ser:Uddannelsesversion>1</ser:Uddannelsesversion>
                           <!--Optional:-->
                           <ser:Speciale>3</ser:Speciale>
                           <!--Optional:-->
                           <ser:Adgangsvej>TD</ser:Adgangsvej>
                           <!--Optional:-->
                           <ser:Klassebetegnelse>1.X</ser:Klassebetegnelse>
                        </ser:Elevskoleperiode>
                     </ser:Elevskoleperioder>
                  </ser:Uddannelsesoplysninger>
               </ser:IndberetElev>
            </ser:IndberetElevRequest>
         </v1:Message>
      </v1:IndberetElevRequest>
   </soap:Body>
</soap:Envelope>

UI Expand

title	Eksempel på response til Indberet

Kodeblok

language	xml
title	Succesfuld indberetning
linenumbers	true

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <v1:IndberetElevResponse xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
         <v1:Identifier>
            <v1:SystemName>Test</v1:SystemName>
            <v1:SystemTransactionID>Test</v1:SystemTransactionID>
         </v1:Identifier>
         <v1:CorrelationID>8dea3f36-4deb-4e97-accd-1c4299806eb7</v1:CorrelationID>
         <v1:Message>
            <IndberetElevResponse xmlns="http://service.elevdatabasen.stil.dk/">
               <Status>COMPLETE</Status>
            </IndberetElevResponse>
         </v1:Message>
      </v1:IndberetElevResponse>
   </soap:Body>
</soap:Envelope>

Kodeblok

language	xml
title	Duplicate
linenumbers	true

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <v1:IndberetElevResponse xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
         <v1:Identifier>
            <v1:SystemName>Test</v1:SystemName>
            <v1:SystemTransactionID>Test</v1:SystemTransactionID>
         </v1:Identifier>
         <v1:CorrelationID>5e16ac8a-6d3c-476b-82d1-853f3373f0af</v1:CorrelationID>
         <v1:Message>
            <IndberetElevResponse xmlns="http://service.elevdatabasen.stil.dk/">
               <Status>DUPLICATE</Status>
            </IndberetElevResponse>
         </v1:Message>
      </v1:IndberetElevResponse>
   </soap:Body>
</soap:Envelope>

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

Hovedinstitutionen for den afdeling hvor eleven modtager undervisning

Afdeling

Heltal

Max cifre: 6

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

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.

Indberetningsdetaljer

List<Indberetningsdetalje>

Ingen/Ikke relevant

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

title	Eksempel request til Status

Kodeblok

language	xml
linenumbers	true

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0" xmlns:ser="http://service.elevdatabasen.stil.dk/">
   <soap:Header/>
   <soap:Body>
      <v1:StatusRequest>
         <v1:Identifier>
            <v1:SystemName>test</v1:SystemName>
            <v1:SystemTransactionID>test</v1:SystemTransactionID>
         </v1:Identifier>
         <v1:Message>
            <ser:StatusRequest>
               <ser:Institutionsoplysninger>
                  <ser:Hovedinstitution>961851</ser:Hovedinstitution>
                  <ser:Afdeling>961851</ser:Afdeling>
               </ser:Institutionsoplysninger>
               <ser:IndberetningsId>1c7f4754-9110-4a45-a251-f2c2ea2c7418</ser:IndberetningsId>
            </ser:StatusRequest>
         </v1:Message>
      </v1:StatusRequest>
   </soap:Body>
</soap:Envelope>

UI Expand

title	Eksempel responses til Status

Kodeblok

language	xml
title	Indberetning gået godt (COMPLETE)
linenumbers	true

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <v1:StatusResponse xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
         <v1:Identifier>
            <v1:SystemName>test</v1:SystemName>
            <v1:SystemTransactionID>test</v1:SystemTransactionID>
         </v1:Identifier>
         <v1:CorrelationID>e49467bf-545f-4348-b8a1-bb20efc32af4</v1:CorrelationID>
         <v1:Message>
            <StatusResponse xmlns="http://service.elevdatabasen.stil.dk/">
               <Status>COMPLETE</Status>
            </StatusResponse>
         </v1:Message>
      </v1:StatusResponse>
   </soap:Body>
</soap:Envelope>

Kodeblok

language	xml
title	Fejl i indberetning
linenumbers	true

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <soap:Fault>
         <soap:Code>
            <soap:Value>soap:Sender</soap:Value>
         </soap:Code>
         <soap:Reason>
            <soap:Text xml:lang="en">Input error</soap:Text>
         </soap:Reason>
         <soap:Detail>
            <ns2:ServiceFaultDetailerV2 xmlns:ns2="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0" xmlns="http://service.elevdatabasen.stil.dk/">
               <ns2:CorrelationID>9dd4ab7e-aace-4e09-b5fe-d3982dbc156e</ns2:CorrelationID>
               <ns2:Timestamp>2022-08-26T08:48:30</ns2:Timestamp>
               <ns2:ErrorCode>IPL171003</ns2:ErrorCode>
               <ns2:ErrorMessage>Indberetning is invalid</ns2:ErrorMessage>
               <ns2:Details>Indberetningen på indberetningsid fd18150e-8a8c-4bbb-ae6b-22e60f70916f er ugyldig</ns2:Details>
               <ns2:SourceSystemError>
                  <ns2:SourceSystemName>Elevdatabasen</ns2:SourceSystemName>
                  <ns2:ErrorCode>Indb-2004</ns2:ErrorCode>
                  <ns2:DetailsList>
                     <ns2:Detail>
                        <ns2:Code>Inst-03</ns2:Code>
                        <ns2:Description>Afdelingen 961851 hører ikke til denne hovedinstitution 666</ns2:Description>
                     </ns2:Detail>
                  </ns2:DetailsList>
               </ns2:SourceSystemError>
            </ns2:ServiceFaultDetailerV2>
         </soap:Detail>
      </soap:Fault>
   </soap:Body>
</soap:Envelope>

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

...

Dette afsnit beskriver de tekniske detaljer for hver Operation på Elevdatabasens webservice.

...

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.

...

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.

...

Elevskoleperioder

...

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 10

...

Elevskoleperiode

...

Skoleperiode eller trin for elevskoleperioden.
Se Uddannelsesmodellen for de gældende skoleperioder.

...

Startdato

...

Slutdato

...

Parametre for response

...

IndberetElevResponse

...

Response på Indberetning.
Se beskrivelsen i afsnittet IndberetElevResponse herunder.

IndberetElevResponse

...

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.

...

UI Expand

title	Eksempel på request til Indberet

Kodeblok

language	xml
linenumbers	true

<ser:IndberetElevRequest>
	<ser:IndberetningsId>32ed0545-b6a0-4e91-bf7b-0fc0dff8ef73</ser:IndberetningsId>
	<ser:IndberetElev>
		<ser:Personoplysninger>
			<ser:CPRNummer>1234561231</ser:CPRNummer>
		</ser:Personoplysninger>
		<ser:Institutionsoplysninger>
			<ser:Hovedinstitution>961851</ser:Hovedinstitution>
			<ser:Afdeling>961851</ser:Afdeling>
		</ser:Institutionsoplysninger>
		<ser:Uddannelsesoplysninger>
			<ser:Uddannelseskode>3017</ser:Uddannelseskode>
			<ser:Uddannelsesversion>1</ser:Uddannelsesversion>
			<ser:Speciale>3</ser:Speciale>
			<ser:Elevskoleperioder>
				<ser:Elevskoleperiode>
					<ser:Skoleperiode>1</ser:Skoleperiode>
					<ser:Startdato>2022-02-01</ser:Startdato>
					<ser:Slutdato>2022-02-27</ser:Slutdato>
				</ser:Elevskoleperiode>
			</ser:Elevskoleperioder>
			<ser:Adgangsvej>TD</ser:Adgangsvej>
			<ser:Klassebetegnelse>1A</ser:Klassebetegnelse>
		</ser:Uddannelsesoplysninger>		
	</ser:IndberetElev>
</ser:IndberetElevRequest>

UI Expand

title	Eksempel på response til Indberet

Kodeblok

language	xml
linenumbers	true

<IndberetElevResponse xmlns="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
	<Status>COMPLETE</Status>
</IndberetElevResponse>

...

Status-operationen er stadig under udarbejdelse, og vi forventer response-strukturen kommer til at matche response-strukturen for 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.

...

Felt
Datatype
Begrænsninger
Krævet
Kardinalitet
Beskrivelse
StatusResponse
SletRequest
StatusResponse
SletRequest
Ingen/Ikke relevant J 1
Response på status.
Se beskrivelsen i afsnittet StatusResponse herunder.
Element, der rummer detaljer om, hvad der anmodes slettes
SletRequestStatusResponse
Felt
Datatype
Begrænsninger
Krævet
Kardinalitet
Beskrivelse
Status
CPRNummer
EnumCREATED, RECEIVED, DUPLICATE, PROCESSING, COMPLETE
String Længde:10 J 1
Status for behandling af indberetningen.
Se afsnittet Fejlhåndtering for information om status FAILED.IndberetningsdetaljerList<Indberetningsdetalje>Ingen/Ikke relevantNUnboundedUdspecificeret liste med fejlkoder og beskrivelser
Indberetningsdetalje
...
title Eksempel request til Status
...
language xml
linenumbers true
...
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

title	Eksempel responses request til StatusSlet

Kodeblok

language	xml
title	Indberetning gået godt (COMPLETE)
linenumbers	true

<StatusResponse xmlns<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
    <Status>COMPLETE</Status>
</StatusResponse>

Kodeblok

language	xml
title	Fejl i indberetning
linenumbers	true

<soap:Fault>
         <soap:Code>
            <soap:Value>soap:Sender</soap:Value>
         </soap:Code>
         <soap:Reason>
            <soap:Text xml:lang="en">Input error</soap:Text> xmlns:ser="http://service.elevdatabasen.stil.dk/">
   <soap:Header/>
   <soap:Body>
         </soap:Reason><v1:SletRequest>
         <soap<v1:Detail>Identifier>
            <ServiceFaultDetailerV2 xmlns:ns2="http://service.elevdatabasen.stil.dk/" xmlns="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0"><v1:SystemName>Test</v1:SystemName>
            <v1:SystemTransactionID>Test</v1:SystemTransactionID>
   <CorrelationID>b7618eba-a992-4460-81c5-4b39660d9450</CorrelationID>
      </v1:Identifier>
         <Timestamp>2022-04-07T06:54:22</Timestamp><v1:Message>
            <ser:SletRequest>
   <ErrorCode>IPL171003</ErrorCode>
            <ser:CPRNummer>0101010101</ser:CPRNummer>
   <ErrorMessage>Indberetning is invalid</ErrorMessage>
          <ser:Hovedinstitution>961851</ser:Hovedinstitution>
     <Details>Indberetningen på indberetningsid a40d3166-e0ca-4530-8374-285a6f81b75b er ugyldig</Details>
      <ser:Afdeling>961851</ser:Afdeling>
         <SourceSystemError>
      <ser:Uddannelseskode>3017</ser:Uddannelseskode>
            <SourceSystemName>Elevdatabasen<</SourceSystemName>ser:SletRequest>
         </v1:Message>
         <ErrorCode>Indb-2004</ErrorCode></v1:SletRequest>
   </soap:Body>
</soap:Envelope>

UI Expand

title	Eksempel response til Slet

Kodeblok

language	xml

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
               <DetailsList><v1:SletResponse xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
                     <Detail><v1:Identifier>
                        <Code>Inst-04</Code><v1:SystemName>Test</v1:SystemName>
            <v1:SystemTransactionID>Test</v1:SystemTransactionID>
         </v1:Identifier>
   <Description>Hovedinstitutionen 961851 er registreret som en hovedinstitution med afdelinger</Description> <v1:CorrelationID>1e5b81da-2e19-494c-ae56-af82c5b8f4f8</v1:CorrelationID>
         <v1:Message>
            </Detail><SletResponse xmlns="http://service.elevdatabasen.stil.dk/">
                  </DetailsList><SletStatus>DELETED</SletStatus>
               </SourceSystemError>SletResponse>
            </ServiceFaultDetailerV2>v1:Message>
        </v1:SletResponse>
   </soap:Detail>
      Body>
</soap:Fault>Envelope>

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

title	Eksempel request til Ping

Kodeblok

language	xml
linenumbers	true

linenumbers	true

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
   <soap:Header/>
   <soap:Body>
      <v1:Ping/>
   </soap:Body>
</soap:Envelope>

UI Expand

title	Eksempel response til Ping

Kodeblok

language	xml
linenumbers	true

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <PingResponse xmlns="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
         <Status>up</Status>
      </PingResponse>
   </soap:Body>
</soap:Envelope>

Unik ID der genereres af Integrationsplatformen. Skal medsendes i supportsager.
Timestamp	dateTime

Tidsstempel sat af Integrationsplatformen. Skal medsendes i supportsager.
ErrorCode	string	Ingen/Ikke relevant

Fejlkode
ErrorMessage	string	Ingen/Ikke relevant	J	1	Kort fejlbesked
Details	string	Ingen/Ikke relevant	N	1	Overordnet beskrivelse af fejlen
SourceSystemError	SourceSystemError

System der sender fejlsbeskeden via Integrationsplatformen. Dette vil ved brug af Elevdatabasens services altid være Elevdatabasen
ErrorCode	string

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.

Content

Rum-værktøjer

Breadcrumbs

Sidehistorik

Versioner sammenlignet

Gammel version 14

Ny version Nuværende

Nøgle

Dokumenthistorik

Indhold

Elevdatabasen

Indberetning til Elevdatabasen

Grunddata om elever

Grundlæggende principper for indberetning

Omfattede uddannelser

Indhold

Elevdatabasen

Indberetning til Elevdatabasen

Grunddata om elever

Grundlæggende principper for indberetning

Omfattede uddannelser

Grundskole

Gymnasieområdet

Integrationsmønstre

Sikring af stabil drift

Håndtering af samtidighed

Håndtering af udfald i netværk og infrastruktur

Webservice

Adgang til webservice

Operationer

Indberet

Status

Ping

Slet

Ping

Fejlhåndtering

Nedenstående tilfælde bør ikke opstå, derfor bør disse håndteres straks ved detektering af fejlene.

Andre fejlbeskeder, hvor supporten for Elevdatabasen skal kontaktes

SoapFaults

Parametre for

ServiceFaultDetailerV2 besked ved

Elevdatabasens fejlbeskeder

Parametre for SoapFault besked ved valideringsfejl

Fault eksempel

Fault eksempel

Persondata

Institutionsdata

Uddannelsesdata

Valideringsregler

Persondata

Institutionsdata

Uddannelsesdata

Teknisk beskrivelse af operationer

Indberet

Parametre for request

Parametre for response

Status

Parametre for request

Parametre for response

Slet

Parametre for request

Parametre for request

Parametre for response

Parametre for request

Parametre for response

Ping

Parametre for request

Parametre for response