Breadcrumbs

Sidehistorik

Versioner sammenlignet

Nøgle

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

...

Dato	Version	Ændring	Ændret af
8. jun. 2022	1.0	Interface til operationen Slet tilføjet, implementering af funktionaliteten udestår.	Poul Skaanning
8. jun. 2022	1.0	Tilføjelse af valideringsregler Udd-15 og Udd-16	Thor Thomsen Krarup
1. jun. 2022	1.0	Orientering om kommende slettefunktion	Ukendt bruger (jpe)
5. maj 2022	1.0	Valideringsregel Udd-12 er fjernet	Poul Skaanning
20. apr. 2022	1.0	Opdateret jf. ny struktur i webservicen og udgivet i version 1.0	Ulrik Sølgaard-Nielsen
26. aug. 2022	1.0	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
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)

...

Indholdsfortegnelse

maxLevel	3
exclude	Indhold\|Dokumenthistorik

...

title	Slettefunktion

...

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.

...

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	21980	Studierettet påbygning, merkantile 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
3046	hf 3 årigt forløb	33
3047	3 årigt studenterkursus	33
3079	stx 4 årigt forløb	33
3312	Dansk-Tysk studentereksamen	33
3313	Dansk-Fransk Bacalaurétte	33

...

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.

...

Tabellen nedenfor indeholder en oversigt over de enkelte fejlkoder og information om, hvordan disse fejl skal håndteres.

<ingen>

ErrorCodeException (SoapFault type)	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-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 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 IndberetningsId: Fejlbesked: Indberetningen på indberetningsid #IndberetningsId er i en ugyldig tilstand. Kontakt supporten for Elevdatabasen. Tilfælde hvor fejlen ikke er kendt: Fejlbesked: Intern server fejl Andre fejlbeskeder, hvor supporten for Elevdatabasen skal kontaktes Fejlbesked: Der skete en fejl ved udlæsning af data fra databasen, kontakt supporten Fejlbesked: Der skete en fejl ved indberetning af data, kontakt supporten Fejlbesked: Digest algorithm not available. Fejlbesked: Uventet fejl	Intern server fejl på Elevdatabasen	Ja	Ja
Elevdb-1001	InternalServerException	Ikke Ikke defineret	Intern fejl på Elevdatabasen. Kontakt STIL support.	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 afsnit om andre krav) ikke overholdes. Kontakt STIL's support, hvis fejlen opstår på trods af en korrekt implementering.	Nej; Der er lavet en implementeringsfejl der bør rettes	N/A
Indb-2004	InvalidIndberetning	Indberetningen på indberetningsid #IndberetningsId er ugyldig	Data på indberetningen er ugyldig.	Nej; Data skal rettes manuelt	Ja
Pers-1000	InternalServerException	Der skete en fejl ved kald til Persondatamodulet	Fejl ved validering af CPR-oplysninger. Selvom dette er en intern fejl der opstår, hvis fx CPR-registeret ikke svarer, så skal der i dette tilfælde genereres et nyt IndberetningsId for at sikre indberetningen håndteres igen.	Ja	Ja

...

Elevdatabasen returnerer både tekniske interne fejl og datafejl som SoapFaults. Elevdatabasens SoapFaults er bygget op omkring 2 overordnede elementer:

<soap:Reason> - Indeholder en overordnet beskrivelse af den pågældende fejl.

<soap:Detail> - Indeholder en mere detaljeret beskrivelse af fejlen (ErrorMessage) samt ErrorCode. I tilfælde af valideringsfejl indeholder fejlbeskeden en liste af valideringsfejlkoder og dertilhørende fejlbeskrivelser indeholdt i elementet ServiceFaultDetailerV2.

Parametre for

...

ServiceFaultDetailerV2 besked ved

...

Elevdatabasens fejlbeskeder

Ved tekniske fejl valideringsfejl benyttes ved følgende format

Felt	Datatype	Begrænsninger	Krævet	Kardinalitet	Beskrivelse

ErrorCode

ServiceFaultDetailerV2

String

ServiceFaultDetailerV2

Ingen/Ikke relevant

FejlkodeErrorMessageString

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

Beskrivelse af fejlen

Parametre for SoapFault-besked ved valideringsfejl

Ved valideringsfejl benyttes ved følgende format

Unik ID der genereres af Integrationsplatformen. Skal medsendes i supportsager.
Timestamp	dateTime	Ingen/Ikke relevant	J	1	Tidsstempel sat af Integrationsplatformen. Skal medsendes i supportsager.
ErrorCode	string

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelseErrorCodeString

	Ingen/Ikke relevant	J	1	Fejlkode
ErrorMessage

String

string

Ingen/Ikke relevant

Beskrivelse

Kort fejlbesked

Details

string

Ingen/Ikke relevant

Overordnet beskrivelse af fejlen

Status

SourceSystemError

EnumDUPLICATE, FAILED

SourceSystemError

Ingen/Ikke relevant

Status på indberetningen.

DUPLICATE angiver, at data tidligere er modtaget på IndberetningsId'et, og behandlet uden fejl.

Ingen data er blevet behandlet i dette request, og fejl listet i Indberetningsdetaljer er således fejl fra den tidligere indberetning

Se afsnittet Fejlhåndtering for håndtering af fejlIndberetningsdetaljerList<Indberetningsdetalje>Ingen/Ikke relevantJUnboundedUdspecificeret liste med fejlkoder og beskrivelser

Indberetningsdetalje

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

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

Beskrivelse af valideringsfejlen

Fault eksempel

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

Overordnet fejlkode
DetailsList	DetailsList	Ingen/Ikke relevant	N	1	Liste, der rummer valideringsfejlene

DetailsList

Felt	Datatype	Begrænsninger	Krævet	Kardinalitet	Beskrivelse
Detail	Detail	Ingen/Ikke relevant	N	Unbounded	Element, der indeholder de enkelte fejl

Detail

Felt	Datatype	Begrænsninger	Krævet	Kardinalitet	Beskrivelse
Code	string	Ingen/Ikke relevant	N	1	Elevdatabasens valideringsfejlkode
Description	string	Ingen/Ikke relevant	N	1	Elevdatabasens fejlbeskrivelse

Fault eksempel

Følgende viser et eksempel på en SoapFault ved indberetning af request hvor der er valideringsfejl. I eksemplet er fejlen pakket ind i det format, som udstilles via Integrationsplatformen.

UI Expand

title	Eksempler på fejlbeskeder

Kodeblok

language	xml
title	Valideringsfejl

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>

UI Expand

title	Eksempel på InvalidIndberetningException-fault (valideringsfejl)

Kodeblok

language	xml

<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>Fault>
         <soap:Code>
   <soap:Text xml:lang="en">Indberetningen på indberetningsid 7622c460-51cc-4d73-ad1d-6b72f761b8a8 er ugyldig</soap:Text>         <soap:Value>soap:Sender</soap:Value>
         </soap:Reason>Code>
         <soap:Detail>Reason>
            <InvalidIndberetning xmlns="http://service.elevdatabasen.stil.dk/"><soap:Text xml:lang="en">Input error</soap:Text>
               <ErrorCode>Indb-2004</ErrorCode></soap:Reason>
         <soap:Detail>
      <ErrorMessage>Data på indberetningen er ugyldig.</ErrorMessage>
   <ns2:ServiceFaultDetailerV2 xmlns:ns2="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0" xmlns="http://service.elevdatabasen.stil.dk/">
          <Status>FAILED</Status>
     <ns2:CorrelationID>5eb3afa9-1b86-45c4-9add-3c04fbc22af2</ns2:CorrelationID>
          <Indberetningsdetaljer>
     <ns2:Timestamp>2022-08-25T10:39:17</ns2:Timestamp>
             <Indberetningsdetalje>
  <ns2:ErrorCode>IPL171003</ns2:ErrorCode>
               <ns2:ErrorMessage>Indberetning    <Fejlkode>Udd-01</Fejlkode>
is invalid</ns2:ErrorMessage>
               <ns2:Details>Indberetningen på indberetningsid 7642f9cc-4e86-4516-9135-f654ab81382f er ugyldig</ns2:Details>
    <Fejlbeskrivelse>Den indberettede kombination af uddannelseskode, uddannelsesversion, speciale og skoleperioder er ikke gyldig</Fejlbeskrivelse> <ns2:SourceSystemError>
                  </Indberetningsdetalje><ns2:SourceSystemName>Elevdatabasen</ns2:SourceSystemName>
                  <Indberetningsdetalje><ns2:ErrorCode>Indb-2004</ns2:ErrorCode>
                     <Fejlkode>Udd-02</Fejlkode><ns2:DetailsList>
                     <Fejlbeskrivelse>Uddannelseskoden<ns2:Detail>
 1234 findes ikke i Uddannelsesmodellen</Fejlbeskrivelse>
                  </Indberetningsdetalje>
  <ns2:Code>Udd-01</ns2:Code>
                <Indberetningsdetalje>
        <ns2:Description>Den indberettede kombination af uddannelseskode, uddannelsesversion, speciale og skoleperioder er ikke gyldig</ns2:Description>
   <Fejlkode>Udd-03</Fejlkode>
                  </ns2:Detail>
   <Fejlbeskrivelse>Versionen 2 findes ikke for uddannelsen 1234</Fejlbeskrivelse>
            <ns2:Detail>
      </Indberetningsdetalje>
                  <Indberetningsdetalje><ns2:Code>Udd-03</ns2:Code>
                     <Fejlkode>Udd-04</Fejlkode>
   <ns2:Description>Versionen 1 findes ikke for uddannelsen 3310 på skoleperioden 1</ns2:Description>
         <Fejlbeskrivelse>Skoleperioden 1 gælder ikke for    uddannelsen 1234 i version 2<</Fejlbeskrivelse>
ns2:Detail>
                     </Indberetningsdetalje>
<ns2:Detail>
                    </Indberetningsdetaljer>
    <ns2:Code>Udd-04</ns2:Code>
               </InvalidIndberetning>
         </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 som Indberetningsdetaljer i en SoapFault.

Persondata

...

Fejlkode

...

Fejltekst

...

Institutionsdata

...

Afhængig af #Flyttekode.

(#Flyttekode=1): Institution #Institutionsnummer er flyttet til institution #NyInstitutionsnummer.

(#Flyttekode=2): Institution #Institutionsnummer er flyttet til institution #NyInstitutionsnummer.

...

Afdelingen #Afdelingsinstitutionsnummer hører ikke til den hovedinstitution #Hovedinstitutionsnummer der indberettes på.

...

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

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

...

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

Indberet

Operationen har følgende 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.

...

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.

...

UI Expand

title	Eksempel på request til Indberet

Kodeblok

language	xml
linenumbers	true		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<soap:Envelope xmlns:soap="http://wwwservice.elevdatabasen.w3stil.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>
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>
            <v1:IndberetElevRequest>
         <v1:Identifier><ser:CPRNummer>0101010101</ser:CPRNummer>
            <v1:SystemName>TESTSYSTEM</v1:SystemName>
      </ser:Personoplysninger>
             <v1:SystemTransactionID>123456789</v1:SystemTransactionID>
     <ser:Institutionsoplysninger>
                     <<ser:Hovedinstitution>961851</v1ser:Identifier>Hovedinstitution>
         <v1:Message>
            <ser:Afdeling>961851</ser:IndberetElevRequest>Afdeling>
                  <ser:IndberetningsId>32ed0545-b6a0-4e91-bf7b-0fc0dff8ef73<</ser:IndberetningsId>Institutionsoplysninger>
                  <ser:IndberetElev>Uddannelsesoplysninger>
                     <ser:Uddannelseskode>3017</ser:Personoplysninger>Uddannelseskode>
                     <ser:CPRNummer>0101011231</ser:CPRNummer>Elevskoleperioder>
                   </ser:Personoplysninger>     <!--1 or more repetitions:-->
                        <ser:Institutionsoplysninger>Elevskoleperiode>
                           <ser:Hovedinstitution>961851<Skoleperiode>1</ser:Hovedinstitution>Skoleperiode>
                           <ser:Afdeling>961851<Startdato>2020-08-01</ser:Afdeling>Startdato>
                  </ser:Institutionsoplysninger>
         <!--Optional:-->
         <ser:Uddannelsesoplysninger>
                     <ser:Uddannelseskode>3017<Slutdato>2021-06-22</ser:Uddannelseskode>
Slutdato>
                           <ser:Elevskoleperioder>Uddannelsesversion>1</ser:Uddannelsesversion>
                        <ser:Elevskoleperiode>   <!--Optional:-->
                           <ser:Skoleperiode>2<Speciale>3</ser:Skoleperiode>Speciale>
                           <ser<!--Optional:Startdato>2021-08-01</ser:Startdato>>
                           <ser:Uddannelsesversion>1<Adgangsvej>TD</ser:Uddannelsesversion>Adgangsvej>
                           <ser:Speciale>3</ser:Speciale><!--Optional:-->
                           <ser:Adgangsvej>TD<Klassebetegnelse>1.X</ser:Adgangsvej>Klassebetegnelse>
                           <ser:Klassebetegnelse>2020TD<</ser:Klassebetegnelse>Elevskoleperiode>
                        </ser:Elevskoleperiode>Elevskoleperioder>
                        <ser:Elevskoleperiode></ser:Uddannelsesoplysninger>
               </ser:IndberetElev>
            <ser:Skoleperiode>1<</ser:Skoleperiode>IndberetElevRequest>
         </v1:Message>
      </v1:IndberetElevRequest>
            <ser:Startdato>2020-08-01</ser:Startdato>
    </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>
                        <ser:Slutdato>2021-06-22</ser:Slutdato><v1:IndberetElevResponse xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
         <v1:Identifier>
                  <ser:Uddannelsesversion>1</ser:Uddannelsesversion>
<v1:SystemName>Test</v1:SystemName>
            <v1:SystemTransactionID>Test</v1:SystemTransactionID>
         </v1:Identifier>
         <ser:Speciale>3</ser:Speciale><v1:CorrelationID>8dea3f36-4deb-4e97-accd-1c4299806eb7</v1:CorrelationID>
         <v1:Message>
            <IndberetElevResponse xmlns="http://service.elevdatabasen.stil.dk/">
     <ser:Adgangsvej>TD</ser:Adgangsvej>
          <Status>COMPLETE</Status>
            </IndberetElevResponse>
     <ser:Klassebetegnelse>2020TD</ser:Klassebetegnelse>
     </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>
       </ser:Elevskoleperiode><v1:IndberetElevResponse xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
         <v1:Identifier>
            <<v1:SystemName>Test</serv1:Elevskoleperioder>SystemName>
                  </ser:Uddannelsesoplysninger><v1:SystemTransactionID>Test</v1:SystemTransactionID>
               </serv1:IndberetElev>Identifier>
            </ser:IndberetElevRequest><v1:CorrelationID>5e16ac8a-6d3c-476b-82d1-853f3373f0af</v1:CorrelationID>
         </v1<v1:Message>
      </v1:IndberetElevRequest>
   </soap:Body>
</soap:Envelope>

UI Expand

title	Eksempel på response til Indberet

Kodeblok

language	xml
linenumbers	true

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

Status

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

Parametre for request

...

StatusRequest

...

StatusRequest

...

StatusRequest

...

            </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
Hovedinstitution
StatusRequest
HeltalMax cifre: 6
StatusRequest
Ingen/Ikke relevant J 1
Hovedinstitutionen for den afdeling hvor eleven modtager undervisningAfdelingHeltalMax cifre: 6J1
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

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

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse

StatusResponse

StatusResponse

Ingen/Ikke relevant

Response på status.
Se beskrivelsen i afsnittet StatusResponse herunder.

...

UUID for indberetningen der ønskes status for

Institutionsoplysninger

Felt	Datatype	Begrænsninger	Krævet	Kardinalitet	Beskrivelse

Status

Hovedinstitution

Enum

CREATED,

RECEIVED,

DUPLICATE,

PROCESSING,

COMPLETE,

FAILED

Heltal

Max cifre: 6

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.

IndberetningsdetaljerList<Indberetningsdetalje>Ingen/Ikke relevantNUnboundedUdspecificeret liste med fejlkoder og beskrivelser

...

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

Fejlkode

StatusResponse

String

StatusResponse

Ingen/Ikke relevant

Elevdatabasens valideringsfejlkodeFejlbeskrivelseStringIngen/Ikke relevantJ1Beskrivelse af valideringsfejlen

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

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>TESTSYSTEM</v1:SystemName>
            <v1:SystemTransactionID>123456789</v1:SystemTransactionID>
         </v1:Identifier>
         <v1:Message>
            <ser:StatusRequest>
               <ser:Institutionsoplysninger>
                  <ser:Hovedinstitution>961851</ser:Hovedinstitution>
                  <ser:Afdeling>961851</ser:Afdeling>
               </ser:Institutionsoplysninger>
               <ser:IndberetningsId>32ed0545-b6a0-4e91-bf7b-0fc0dff8ef73</ser:IndberetningsId>
            </ser:StatusRequest>
         </v1<v1:Message>Identifier>
        </v1:StatusRequest>
   </soap:Body>
</soap:Envelope>

UI Expand

title	Eksempel responses til Status

Kodeblok

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

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

Kodeblok

language	xml
title	Fejl i indberetning
linenumbers	true

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body> <v1:SystemName>test</v1:SystemName>
            <v1:SystemTransactionID>test</v1:SystemTransactionID>
         </v1:Identifier>
         <v1:Message>
      <soap:Fault>
      <ser:StatusRequest>
               <soap<ser:Code>Institutionsoplysninger>
                <soap:Value>soap:Sender</soap:Value>
  <ser:Hovedinstitution>961851</ser:Hovedinstitution>
                 </soap:Code> <ser:Afdeling>961851</ser:Afdeling>
         <soap:Reason>
      </ser:Institutionsoplysninger>
             <soap:Text  xml:lang="en">Input error</soap:Text>
<ser:IndberetningsId>1c7f4754-9110-4a45-a251-f2c2ea2c7418</ser:IndberetningsId>
            </soapser:Reason>StatusRequest>
         <soap</v1:Detail>Message>
      </v1:StatusRequest>
      <ServiceFaultDetailerV2 xmlns:ns2</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://servicewww.elevdatabasen.stil.dk/" xmlnsw3.org/2003/05/soap-envelope">
   <soap:Body>
      <v1:StatusResponse xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
               <CorrelationID>9718cb0b-6072-45ce-9656-a0799f99a5de</CorrelationID>
               <Timestamp>2022-06-13T11:01:37</Timestamp>
               <ErrorCode>IPL171003</ErrorCode>
               <ErrorMessage>Indberetning is invalid</ErrorMessage>>
         <v1:Identifier>
      <Details>Indberetningen  på indberetningsid 32ed0545-b6a0-4e91-bf7b-0fc0dff8ef73 er ugyldig</Details><v1:SystemName>test</v1:SystemName>
               <SourceSystemError><v1:SystemTransactionID>test</v1:SystemTransactionID>
         </v1:Identifier>
         <SourceSystemName>Elevdatabasen</SourceSystemName><v1:CorrelationID>e49467bf-545f-4348-b8a1-bb20efc32af4</v1:CorrelationID>
                  <ErrorCode>Indb-2004</ErrorCode><v1:Message>
                  <DetailsList><StatusResponse xmlns="http://service.elevdatabasen.stil.dk/">
                     <Detail><Status>COMPLETE</Status>
            </StatusResponse>
            <Code>Inst-04</Code></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>
   <Description>Hovedinstitutionen 961851 er registreret som en hovedinstitution med afdelinger</Description> <soap:Code>
            <soap:Value>soap:Sender</soap:Value>
         </Detail>soap:Code>
         <soap:Reason>
         </DetailsList>
   <soap:Text xml:lang="en">Input error</soap:Text>
          </SourceSystemError>soap:Reason>
         <soap:Detail>
     </ServiceFaultDetailerV2>
       <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.

Bemærk

title	Slettefunktion

Interface til operationen Slet er implementeret (skal anvendes ved fejloprettelse af elever), funktionaliteten er endnu ikke implementeret.

Operationen har følgende struktur for request og response:

Parametre for request

...

Felt

...

Datatype

...

Begrænsninger

...

Krævet

...

Kardinalitet

...

Beskrivelse

...

SletRequest

...

SletRequest

...

SletRequest

...

Felt

...

Datatype

...

Begrænsninger

...

Krævet

...

Kardinalitet

...

Beskrivelse

...

Institutionsnummeret for afdelingen hvor elevdata skal slettes.

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

...

SletStatus

...

Enum

...

UI Expand

title	Eksempel request til Slet

Kodeblok

language	xml

<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:SletRequest>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>
         <v1:Identifier>
               <v1:SystemName>TESTSYSTEM</v1:SystemName>
<ns2:Description>Afdelingen 961851 hører ikke til denne hovedinstitution 666</ns2:Description>
                     <v1:SystemTransactionID>123456789<</v1ns2:SystemTransactionID>Detail>
         </v1:Identifier>
         <v1</ns2:Message>DetailsList>
            <ser:SletRequest>
   </ns2:SourceSystemError>
            <ser:CPRNummer>0101011231<</serns2:CPRNummer>ServiceFaultDetailerV2>
         </soap:Detail>
      <ser:Hovedinstitution>961851<</sersoap:Hovedinstitution>Fault>
               <ser:Afdeling>961851</ser:Afdeling>
               <ser:Uddannelseskode>3017</ser:Uddannelseskode>
            </ser:SletRequest>
         </v1:Message>
      </v1:SletRequest>
   </soap:Body>
</soap:Envelope></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

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

(Operationen er endnu ikke implementeret)

UI Expand

title	Eksempel response request til Slet

Kodeblok

language	xml

<soap:Envelope:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0" xmlns:soapser="http://wwwservice.elevdatabasen.w3stil.org/2003/05/soap-envelope"dk/">
   <soap:Header/>
   <soap:Body>
      <soap<v1:Fault>SletRequest>
         <soap<v1:Code>Identifier>
            <soap<v1:Value>soap:Receiver<SystemName>Test</soapv1:Value>SystemName>
            <<v1:SystemTransactionID>Test</soapv1:Code>SystemTransactionID>
         <soap</v1:Reason>Identifier>
            <soap:Text xml:lang="en">Internal error</soap:Text><v1:Message>
         </soap:Reason>
         <soap:Detail>
<ser:SletRequest>
              <ServiceFaultDetailerV2 xmlns:ns2="http://service.elevdatabasen.stil.dk/" xmlns="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0"><ser:CPRNummer>0101010101</ser:CPRNummer>
               <CorrelationID>4422fe65-0b42-451b-b942-f54df0ab95ac</CorrelationID><ser:Hovedinstitution>961851</ser:Hovedinstitution>
               <Timestamp>2022-06-13T11:02:52</Timestamp><ser:Afdeling>961851</ser:Afdeling>
               <ErrorCode>IPL171001</ErrorCode><ser:Uddannelseskode>3017</ser:Uddannelseskode>
            </ser:SletRequest>
         </v1:Message>
      </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>
<ErrorMessage>An internal server error occurred on the source service</ErrorMessage>
               <Details>Slette funktion ikke implementeret</Details><v1:SletResponse xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
         <v1:Identifier>
      <SourceSystemError>
      <v1:SystemName>Test</v1:SystemName>
            <SourceSystemName>Elevdatabasen</SourceSystemName><v1:SystemTransactionID>Test</v1:SystemTransactionID>
         </v1:Identifier>
         <ErrorCode>Elevdb-1001</ErrorCode><v1:CorrelationID>1e5b81da-2e19-494c-ae56-af82c5b8f4f8</v1:CorrelationID>
         <v1:Message>
         <Details>Ikke implementeret</Details>   <SletResponse xmlns="http://service.elevdatabasen.stil.dk/">
               <<SletStatus>DELETED</SourceSystemError>SletStatus>
            </ServiceFaultDetailerV2>SletResponse>
         </soapv1:Detail>Message>
      </soapv1:Fault>SletResponse>
   </soap:Body>
</soap:Envelope>

...

Content

Rum-værktøjer

Versioner sammenlignet

Gammel version 20

Ny version Nuværende

Nøgle

Elevdatabasen

Andre fejlbeskeder, hvor supporten for Elevdatabasen skal kontaktes

Parametre for

ServiceFaultDetailerV2 besked ved

Elevdatabasens fejlbeskeder

Parametre for SoapFault-besked ved valideringsfejl

Indberetningsdetalje

Fault eksempel

Fault eksempel

Valideringsregler

Persondata

Institutionsdata

Valideringsregler

Persondata

Institutionsdata

Uddannelsesdata

Uddannelsesdata

Indberet

Parametre for request

Status

Parametre for request

Status

Parametre for request

Parametre for response

Parametre for response

Slet

Parametre for request

Parametre for response

Slet

Parametre for request

Parametre for response