Dokumenthistorik

Indhold

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, elevdata, institutionsdata og uddannelsesdata.

...

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:

Indberetning til Elevdatabasen

Grunddata om elever

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

Elevdatabasens fire dataområder:

• Persondata - Indeholder elevens personnummer
• Elevdata - Indeholder data der knytter sig til eleven - eksempelvis adgangsvej, afgangsårsag, mv. 
• Institutionsdata - Indeholder hovedinstitution og afdeling for Institutionsdata - Indeholder hovedinstitution og afdeling for den indberettende institution
• Uddannelsesdata - Indeholder data relateret til Data om den uddannelse eleven er i gang med , eleven går på - eksempelvis uddannelseskode, uddannelsesversion, skoleperioder, afgangsårsager mv. 

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

Image RemovedImage 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

1. En indberetning skal indeholde gældende data for en aktiv elev pr. indberetningsdatoen.
2. En indberetning skal indeholde historisk data frem til indberetningsdatoen
3. Ved ændringer til data på eleven skal indberetning ske senest dagen efter, at ændringen træder i kraft
4. En indberetning må ikke indeholde forventede ændringer, f.eks. forventet orlov eller skifte fra 1.G til 2.G
5. 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.

...

Integrationsmønstre

Følgende sektion beskriver de krav det 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.

...

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 overhalet, og dermed bliver data i Elevdatabasen forskellig fra den faktiske data i SA-systemet.

...

Ønsker man at parallelisere indberetninger er det 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 af typen GUID, for at undgå dobbeltindberetninger ved fejl i netværk elleranden infrastruktur.

...

Se tabellen i afsnittet Fejlhåndtering for yderligere detaljer om hvornår man forventes at gensende- eller generere en nyt IndberetningsID.

Webservice

Denne sektion beskriver den webservice der skal anvendes til brug for indberetning.

Anker
Adgang til webservice Adgang til webservice

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 og dataadgange mellem institutioner og systemleverandører (udbydere).

...

Yderligere oplysninger om tilslutning samt tekniske detaljer kan findes på STIL’s supportside for Integrationsplatformen.

Operationer

Der findes følgende 3 operationer i Elevdatabasen, Indberet, Status og Ping.

Anker
Indberet Indberet

Indberet

Indberetning af data til Elevdatabasen sker med operationen Indberet for én elev af gangen.

...

De tekniske detajler, og eksempel på request/response kan findes i afsnittet Teknisk beskrivelse af operationer

Anker
Status Status

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 kan benyttes ved tvivl om hvorvidt en indberetning er gået godt.

De tekniske detajler, og eksempel på request/response kan findes i afsnittet Teknisk beskrivelse af operationer

Ping

Anvendes til at pinge Elevdatabasen.

De tekniske detajler, og eksempel på request/response kan findes i afsnittet Teknisk beskrivelse af operationer

Anker
Fejlhåndtering Fejlhåndtering

Fejlhåndtering

Elevdatabasen opererer med 3 typer af fejlkoder, Elevdb-XXXX, Indb-XXXX og Pers-1000. 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. 

...

SoapFaults

Elevdatabasen returnere både Interne fejl, og ugyldig datafejl som SoapFaults. Elevdatabasens Soapfaults er bygget op omkring 2 overordnede elementer:

...

<soap:Detail> - Indeholder en exception og en mere detaljeret beskrivelse af fejlen samt errorcode. I tilfælde af valideringsfejl indeholder den en liste med valideringsfejlkoder og dertilhørende fejlbeskrivelser.

Parametre for SoapFault besked ved interne fejl

Ved interne fejl benyttes følgende format

Parametre for SoapFault besked ved valideringsfejl

Ved valideringsfejl benyttes ved følgende format

Indberetningsdetalje

Fault eksempel

Følgende viser et eksempel på en SoapFault ved indberetning af validt request, men hvor der er valideringsfejl.

<soap:Fault>
    <soap:Code>
        <soap:Value>soap:Receiver</soap:Value>
    </soap:Code>
    <soap:Reason>
        <soap:Text xml:lang="en">Indberetningen på indberetningsid 7814 er ugyldig</soap:Text>
    </soap:Reason>
    <soap:Detail>
        <InvalidIndberetning xmlns="http://service.elevdatabasen.stil.dk/">
            <ErrorCode>Indb-2004</ErrorCode>
            <ErrorMessage>Data på indberetningen er ugyldig.</ErrorMessage>
            <Status>FAILED</Status>
            <Indberetningsdetaljer>
                <Indberetningsdetalje>
                    <Fejlkode>Elev<Fejlkode>Udd-07<01</Fejlkode>
                    <Fejlbeskrivelse>Den indberettede kombination af uddannelseskode, <Fejlbeskrivelse>Adgangsvejenuddannelsesversion, TDspeciale erog ugyldigskoleperioder forer skoleperioderne (5)<ikke gyldig</Fejlbeskrivelse>
                </Indberetningsdetalje>
                <Indberetningsdetalje>
                    <Fejlkode>Udd-01<04</Fejlkode>
                    <Fejlbeskrivelse>Den<Fejlbeskrivelse>Skoleperioden indberettede5 kombinationgælder afikke uddannelseskode,for uddannelsesversion,uddannelsen speciale3017 ogi skoleperioder er ikke gyldig<version 2</Fejlbeskrivelse>
                </Indberetningsdetalje>
                <Indberetningsdetalje>
                    <Fejlkode>Udd-04<06</Fejlkode>
                    <Fejlbeskrivelse>Skoleperioden 5 gælder ikke <Fejlbeskrivelse>Elevens startdato 2022-01-01 ligger efter slutdato for uddannelsen 3017med iUddannelseskoden version 2</Fejlbeskrivelse>
                </Indberetningsdetalje>3017 og Uddannelsesversionen 2 hvor uddannelsen er lukket for optag</Fejlbeskrivelse>
                <Indberetningsdetalje>
                    <Fejlkode>Udd-06</Fejlkode>
      </Indberetningsdetalje>
				<Indberetningsdetalje>
					<Fejlkode>Udd-13</Fejlkode>
					<Fejlbeskrivelse>Adgangsvejen TD er ugyldig for skoleperioderne (5)</Fejlbeskrivelse>
              <Fejlbeskrivelse>Elevens startdato 2022-01-01 ligger efter slutdato for uddannelsen med Uddannelseskoden 3017 og Uddannelsesversionen 2 hvor uddannelsen er lukket for optag</Fejlbeskrivelse>
                </Indberetningsdetalje>
            </Indberetningsdetaljer>
        </InvalidIndberetning>
    </ </Indberetningsdetalje>
			</Indberetningsdetaljer>
        </InvalidIndberetning>
    </soap:Detail>
</soap:Fault>

Anker
Valideringsregler Valideringsregler

Valideringsregler

Nedenfor er listet de valideringer, der foretages på Elevdatabasen. Valideringerne er delt op i fire tre dele: Persondata, Elevdata, Institutionsdata og Uddannelsesdata.

Ved brud på valideringsregler returneres en liste af valideringsfejl som Indberetningsdetaljer i en SoapFault.

Persondata

...

Institutionsdata

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å.

Uddannelsesdata

...

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

...

Elevens startdato #Startdato ligger efter slutdato for uddannelsen med Uddannelseskoden #Uddannelseskode og Uddannelsesversionen #Uddannelsesversionen hvor uddannelsen er lukket for optag

...

Uddannelsesdata

Anker
Teknisk beskrivelse af operationer

...

Teknisk beskrivelse af operationer

Teknisk beskrivelse af operationer

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

Anker

...

Operationen har følgende struktur for request og response:

Parametre for request

...

IndberetElevRequest

...

IndberetElevRequest

...

IndberetElevRequest

...

IndberetningsId

...

IndberetElev

...

IndberetElev

...

Elev der indberettes data på

Indberet Indberet

Indberet

Operationen har følgende struktur for request og response:

Parametre for request

...

Felt	Datatype	Begrænsninger	Krævet	Kardinalitet	Beskrivelse

Personoplysninger

IndberetElevRequest

Personoplysninger

IndberetElevRequest

Ingen/Ikke relevant

J

1

Personoplysninger om elevenInstitutionsoplysningerInstitutionsoplysningerIngen/Ikke relevantJ1Oplysninger om institutionen, hvor eleven gårUddannelsesoplysningerUddannelsesoplysninger

Request på Indberetning Se beskrivelsen i afsnittet IndberetElevRequest herunder.

IndberetElevRequest

Felt	Datatype	Begrænsninger	Krævet	Kardinalitet	Beskrivelse
IndberetningsId	GUID	Ingen/Ikke relevant	J	1

Oplysninger om uddannelsen eleven er i gang medElevoplysningerElevoplysninger

GUID for indberetning. Id'et genereres af det indberettende system
IndberetElev	IndberetElev	Ingen/Ikke relevant	J	1

Oplysninger om eleven

Elev der indberettes data på

IndberetElevPersonoplysninger

Felt	Datatype	Begrænsninger	Krævet	Kardinalitet	Beskrivelse

CPRNummer

Personoplysninger

StringLængde: 10

Personoplysninger

Ingen/Ikke relevant

J

1

CPR-nummer (personnummer) på eleven. Der kan ikke indberettes elever uden CPR-nummer.

Personoplysninger om eleven

Institutionsoplysninger

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelseHovedinstitutionHeltalMax cifre: 6

Institutionsoplysninger	Ingen/Ikke relevant	J	1	Oplysninger om institutionen, hvor eleven går
Uddannelsesoplysninger	Uddannelsesoplysninger	Ingen/Ikke relevant	J	1

Hovedinstitutionen for den afdeling hvor eleven modtager undervisningAfdelingHeltal

Oplysninger om uddannelsen eleven er i gang med
Elevoplysninger	Elevoplysninger	Ingen/Ikke relevant

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.

Uddannelsesoplysninger

Oplysninger om eleven

Personoplysninger

Felt	Datatype	Begrænsninger	Krævet	Kardinalitet	Beskrivelse

Uddannelseskode

CPRNummer

String

Minimums længde: 1, max længde: 4, ingen whitespace tegn

Længde: 10

J

1

Den officielle uddannelseskode (CØSA-formål) for uddannelsen.
Se Uddannelsesmodellen for de gældende uddannelseskoder.

Uddannelsesversion

HeltalMax cifre: 4J1

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

N1

Speciale for uddannelsen, hvis uddannelsen har et speciale.
Se Uddannelsesmodellen for de gældende specialer.

Elevskoleperioder

List<Elevskoleperiode>Ingen/Ikke relevantJUnboundedListe 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.

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.

UddannelsesoplysningerElevskoleperiode

Ingen/Ikke relevant

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.
Uddannelsesversion	Heltal	Max cifre: 4	Skoleperiode	String	Ingen/Ikke relevant	J	1	Skoleperiode eller trin for elevskoleperiodenDen version af uddannelsen som eleven går på. Se Uddannelsesmodellen for de gældende skoleperioderversioner.
StartdatoSpeciale	Date	Ingen/Ikke relevant	J	1	Startdato for elevskoleperioden	Slutdato	Date	String	Minimums længde: 1, max længde: 2, ingen whitespace tegn		N	1	Slutdato for elevskoleperioden

Elevoplysninger

Beskrivelse tilknyttet eleven sendes ved alle indberetninger.
Adgangsvej 4

Felt	Datatype	Begrænsninger	Krævet	Kardinalitet	Speciale for uddannelsen, hvis uddannelsen har et speciale. Se Uddannelsesmodellen for de gældende specialer.
Startdato	Date	Ingen/Ikke relevant	J	1	Datoen for hvornår eleven er startet på 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.
Afgangsaarsager	List<Afgangsaarsag>	Ingen/Ikke relevant	N	Unbounded	Årsager til elevens ophør på uddannelsen. Alle afgangsårsager	tilknyttet eleven sendes ved alle indberetninger.
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	10	N	1	Navnet på den klasse eleven går i

Elevskoleperiode

Adgangsvej for elevens optag på uddannelsen adgangsveje.

Min længde 1

Max længde 10Navnet på den klasse eleven går i

Felt	Datatype	Begrænsninger	Krævet	Kardinalitet	Beskrivelse
Skoleperiode	String	Ingen/Ikke relevant	J	1	Skoleperiode eller trin for elevskoleperioden	N	1	. Se Uddannelsesmodellen for de gældende	Klassebetegnelse	String	skoleperioder.
Startdato	Date	Ingen/Ikke relevant	J	1	Startdato for elevskoleperioden
Slutdato	Date	Ingen/Ikke relevant	N	1	Slutdato for elevskoleperioden

Afgangsaarsag

Årsag til elevens ophør på uddannelsen.

Felt	Datatype	Begrænsninger	Krævet	Kardinalitet	Beskrivelse
Afgangsaarsagskode	String	Max længde: 5	J	1	Afgangsårsagskode, for elevens afgangsårsag. Se Uddannelsesmodellen for de gældende centrale afgangsårsager.
GyldigFra	Date	Ingen/Ikke relevant	J	1	Angiver den dato, hvor eleven stopper på uddannelsen.
GyldigTil	Date	Ingen/Ikke relevant	N	1	Anvendes hvis eleven genoptager uddannelsen og angiver dato for genoptagelse.

Parametre for response

...

<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:Startdato>2022-01-01</ser:Startdato>
			<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:Uddannelsesoplysninger>
		<ser:Elevoplysninger>
			<ser:Startdato>2022-01-01</ser:Startdato>
			<ser:Afgangsaarsager>
				<ser:Afgangsaarsag>
					<ser:Afgangsaarsagskode>112</ser:Afgangsaarsagskode>
					<ser:GyldigFra>2022-03-31</ser:GyldigFra>
					<ser:GyldigTil>2022-08-01</ser:GyldigTil>
				</ser:Afgangsaarsag>
			</ser:Afgangsaarsager>
			<ser:Adgangsvej>TD</ser:Adgangsvej>
			<ser:Klassebetegnelse>1A</ser:Klassebetegnelse>
		</ser:Elevoplysninger>Uddannelsesoplysninger>		
	</ser:IndberetElev>
</ser:IndberetElevRequest>

<IndberetElevResponse xmlns="http://service.elevdatabasen.stil.dk/">
	<Status>COMPLETE</Status>
</IndberetElevResponse>

Anker
Status Status

Status

Status-operationen er stadig under udarbejdelse, og vi forventer response-strukturen kommer til at matche response-strukturen for Indberet-operationen

Parametre for request

...

Parametre for response

...

<StatusResponse xmlns="http://service.elevdatabasen.stil.dk/">
    <Status>COMPLETE</Status>
</StatusResponse>

<soap:Fault>
    <soap:Code>
        <soap:Value>soap:Receiver</soap:Value>
    </soap:Code>
    <soap:Reason>
        <soap:Text xml:lang="en">Indberetningen på indberetningsid 7814 er ugyldig</soap:Text>
    </soap:Reason>
    <soap:Detail>
        <InvalidIndberetning xmlns="http://service.elevdatabasen.stil.dk/">
            <ErrorCode>Indb-2004</ErrorCode>
            <ErrorMessage>Data på indberetningen er ugyldig.</ErrorMessage>
            <Status>FAILED</Status>        
            <Indberetningsdetaljer>
		        <Indberetningsdetalje>
			        <Fejlkode>Elev<Fejlkode>Udd-08<14</Fejlkode>
			        <Fejlbeskrivelse>Gyldig-fra dato 2022-03-01 for afgangsårsagen '27' skal ligge inden for afgangsårsagens gyldighedsperiode. Startdato: 1970-01-01, slutdato: 2022-01-31</Fejlbeskrivelse>
		        </Indberetningsdetalje>
		        <Indberetningsdetalje>
			        <Fejlkode>Inst-01</Fejlkode>
			        <Fejlbeskrivelse>Institutionsnummeret 213213 findes ikke</Fejlbeskrivelse>
		        </Indberetningsdetalje>
	        </Indberetningsdetaljer>
        </InvalidIndberetning>
    </soap:Detail>
</soap:Fault>

Ping

Operationen har følgende struktur for request og response

Parametre for request

Parametre for response

...