Versioner sammenlignet

Nøgle

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

...

DatoVersionÆndringÆndret af

 

1.0Interface til operationen Slet tilføjet, implementering af funktionaliteten udestår.

 

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

 

1.0Orientering om kommende slettefunktion

 

1.0Valideringsregel Udd-12 er fjernet

 

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

 

1.0Opdaterede eksempler iht. IPL struktur
UI Expand
titleArkiveret dokumenthistorik
DatoVersionÆndringÆndret af

 

0.9Eksempler på fejlbeskeder, request og response er opdateret

 

0.9Afgangsårsager udgår og fejlvalideringsregler opdateres

 

0.9Præcisering af fejlbeskeder

 

0.9Opdatering af valideringsregler vedr. Institutionsdata

 

0.9Opdatering af links

 

0.9Sammenfletning af Elevdata og Uddannelsesdata

 

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

...

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

ErrorCodeException (SoapFault type)FejlbeskrivelseForklaringAutomatisk gensendelse muligNyt IndberetningsId ved genindberetning
<ingen><ingen>-Hvis kaldet timer ud, eller andet går galt der gør at svar ikke kommer tilbage fra Elevdatabasen, vil fejlkode typisk være implementeringsspecifikke for det enkelte system. Som eksempel kunne dette være en "ConnectionClosed" eller "TimeoutException".JaNej
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å ElevdatabasenJaJa
Elevdb-1001InternalServerExceptionIkke defineretIntern fejl på Elevdatabasen. Kontakt STIL support.Nej; Kontakt STIL supportN/A
Indb-2003IndberetningOutOfOrderExceptionData 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 rettesN/A
Indb-2004InvalidIndberetningIndberetningen på indberetningsid #IndberetningsId er ugyldig

Data på indberetningen er ugyldig.

Nej; Data skal rettes manueltJa
Pers-1000InternalServerExceptionDer skete en fejl ved kald til PersondatamoduletFejl 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.JaJa

...

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

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
ErrorCode
ServiceFaultDetailerV2
String
ServiceFaultDetailerV2Ingen/Ikke relevantJ1
FejlkodeErrorMessageString
Element, der rummer felterne med detaljer vedrørende fejlen

ServiceFaultDetailerV2

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
CorrelationIDUUIDIngen/Ikke relevantJ1
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.
TimestampdateTimeIngen/Ikke relevantJ1Tidsstempel sat af Integrationsplatformen. Skal medsendes i supportsager.
ErrorCodestring
FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelseErrorCodeString
Ingen/Ikke relevantJ1Fejlkode
ErrorMessage
String
stringIngen/Ikke relevantJ1
Beskrivelse af fejlenStatusEnumDUPLICATE, FAILEDJ1

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

Kort fejlbesked




DetailsstringIngen/Ikke relevantN1Overordnet beskrivelse af fejlen
SourceSystemErrorSourceSystemError
Se afsnittet Fejlhåndtering for håndtering af fejlIndberetningsdetaljerList<Indberetningsdetalje>
Ingen/Ikke relevant
J
N
UnboundedUdspecificeret liste med fejlkoder og beskrivelser

...

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

SourceSystemError

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
Fejlkode
SourceSystemName
String
stringIngen/Ikke relevantJ1
Elevdatabasens valideringsfejlkodeFejlbeskrivelse
System der sender fejlsbeskeden via Integrationsplatformen. Dette vil ved brug af Elevdatabasens services altid være Elevdatabasen
ErrorCodestring
String
Ingen/Ikke relevantJ1
Beskrivelse af valideringsfejlen

Fault eksempel

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

Overordnet fejlkode
DetailsListDetailsListIngen/Ikke relevantN1Liste, der rummer valideringsfejlene

DetailsList

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
DetailDetailIngen/Ikke relevantNUnboundedElement, der indeholder de enkelte fejl

Detail

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
CodestringIngen/Ikke relevantN1Elevdatabasens valideringsfejlkode
DescriptionstringIngen/Ikke relevantN1Elevdatabasens 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
titleEksempler på fejlbeskeder
Kodeblok
languagexml
titleValideringsfejl
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-
UI Expand
titleEksempel på InvalidIndberetningException-fault (valideringsfejl)
Kodeblok
languagexml
<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">Indberetningen på indberetningsid 7622c460-51cc-4d73-ad1d-6b72f761b8a8 er ugyldig<>Input error</soap:Text>
         </soap:Reason>
         <soap:Detail>
            <InvalidIndberetning<ns2:ServiceFaultDetailerV2 xmlns:ns2="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0" xmlns="http://service.elevdatabasen.stil.dk/">
               <ErrorCode>Indb-2004</ErrorCode><ns2:CorrelationID>5eb3afa9-1b86-45c4-9add-3c04fbc22af2</ns2:CorrelationID>
               <ErrorMessage>Data på indberetningen er ugyldig.</ErrorMessage><ns2:Timestamp>2022-08-25T10:39:17</ns2:Timestamp>
               <Status>FAILED</Status>
<ns2:ErrorCode>IPL171003</ns2:ErrorCode>
               <ns2:ErrorMessage>Indberetning is <Indberetningsdetaljer>invalid</ns2:ErrorMessage>
               <ns2:Details>Indberetningen   <Indberetningsdetalje>indberetningsid 7642f9cc-4e86-4516-9135-f654ab81382f er ugyldig</ns2:Details>
               <ns2:SourceSystemError>
      <Fejlkode>Udd-01</Fejlkode>
            <ns2:SourceSystemName>Elevdatabasen</ns2:SourceSystemName>
         <Fejlbeskrivelse>Den indberettede kombination af uddannelseskode, uddannelsesversion, speciale og skoleperioder er ikke gyldig</Fejlbeskrivelse> <ns2:ErrorCode>Indb-2004</ns2:ErrorCode>
                  </Indberetningsdetalje><ns2:DetailsList>
                  <Indberetningsdetalje>
   <ns2:Detail>
                  <Fejlkode>Udd-02</Fejlkode>
      <ns2:Code>Udd-01</ns2:Code>
               <Fejlbeskrivelse>Uddannelseskoden 1234 findes ikke i Uddannelsesmodellen</Fejlbeskrivelse>
    <ns2:Description>Den indberettede kombination af uddannelseskode, uddannelsesversion, speciale og skoleperioder er ikke gyldig</ns2:Description>
   </Indberetningsdetalje>
                  <Indberetningsdetalje></ns2:Detail>
                     <Fejlkode>Udd-03</Fejlkode><ns2:Detail>
                     <Fejlbeskrivelse>Versionen 2   <ns2:Code>Udd-03</ns2:Code>
                        <ns2:Description>Versionen 1 findes ikke for uddannelsen 1234</Fejlbeskrivelse> 3310 på skoleperioden 1</ns2:Description>
                     </Indberetningsdetalje>ns2:Detail>
                   <Indberetningsdetalje>
  <ns2:Detail>
                        <Fejlkode>Udd<ns2:Code>Udd-04</Fejlkode>ns2:Code>
                     <Fejlbeskrivelse>Skoleperioden   <ns2:Description>Skoleperioden 1 gælder ikke for uddannelsen 12343310 i version 2<1</Fejlbeskrivelse>ns2:Description>
                     </Indberetningsdetalje>ns2:Detail>
               </Indberetningsdetaljer>      <ns2:Detail>
            </InvalidIndberetning>
            <ns2:Code>Udd-15</ns2:Code>
           </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 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
languagexml
titleUgyldig 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-01CPR-nummeret #CPR-nummer findes ikke i Det Centrale Personregister (CPR)
Pers-02CPR-nummeret #CPR-nummer er ikke aktivt i Det Centrale Personregister (CPR)

Institutionsdata

FejlkodeFejltekst
Inst-01Institutionsnummeret #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-04Institutionen #Hovedinstitution er indberettet som en institution uden afdelinger, men institutionen er registreret som en afdeling eller hovedinstitution.

Uddannelsesdata

FejlkodeFejltekst
Udd-01

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

Udd-02Uddannelseskoden #uddannelseskode findes ikke i Uddannelsesmodellen.
Udd-03Versionen #uddannelsesversion findes ikke for uddannelsen #uddannelseskode
Udd-04Skoleperioderne #skoleperioder gælder ikke for uddannelsen #uddannelseskode i version #version.
Udd-05Specialet #specialekode gælder ikke for uddannelsen #uddannelseskode i version #version med skoleperioderne #skoleperioder
Udd-06
Udd-07Tidligste registrering af eleven #tidligsteSkoleperiodeStartdato ligger før startdato for uddannelsen med uddannelseskoden #uddannelseskode i version #Version
Udd-08
Udd-09
Udd-10Elevskoleperiodens startdato #elevskoleperiodestart skal være før elevskoleperiodens slutdato #elevskoleperiodeslut
Udd-11
Udd-12
Udd-13Adgangsvejen #adgangsvej på skoleperiode #skoleperiode er ikke tilknyttet uddannelsen #uddannelseskode" med version #Version
Udd-14
Udd-15Skoleperiode #skoleperiode på uddannelsen #uddannelseskode i version #version mangler en adgangsvej
Udd-16Elevtypen #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

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse

IndberetElevRequest

IndberetElevRequest

Ingen/Ikke relevantJ1Request på Indberetning
Se beskrivelsen i afsnittet IndberetElevRequest herunder. 

IndberetElevRequest

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse

IndberetningsId

UUIDIngen/Ikke relevantJ1UUID for indberetning, genereres af indberettende system

IndberetElev

IndberetElev

Ingen/Ikke relevantJ1

Elev der indberettes data på

IndberetElev

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
PersonoplysningerPersonoplysningerIngen/Ikke relevantJ1Personoplysninger om eleven
InstitutionsoplysningerInstitutionsoplysningerIngen/Ikke relevantJ1Oplysninger om institutionen, hvor eleven går
UddannelsesoplysningerUddannelsesoplysningerIngen/Ikke relevantJ1Oplysninger om uddannelsen eleven er i gang med

Personoplysninger

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
CPRNummerStringLængde: 10J1CPR-nummer (personnummer) på eleven. Der kan ikke indberettes elever uden CPR-nummer.

Institutionsoplysninger

Uddannelsesdata

...

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

...

Teknisk beskrivelse af operationer

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

Indberet

Operationen har følgende struktur for request og response:

Parametre for request

...

IndberetElevRequest

...

IndberetElevRequest

...

IndberetElevRequest

...

IndberetningsId

...

IndberetElev

...

IndberetElev

...

Elev der indberettes data på

IndberetElev

...

Personoplysninger

...

Institutionsoplysninger

...

Institutionsnummeret for afdelingen hvor eleven modtager undervisning

Er institutionen en selvstændig institution uden hovedinstitution skal samme institutionsnummer angives i Hovedinstitution og Afdeling.

Uddannelsesoplysninger

...

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

...

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

...

Elevskoleperioder

...

Elevskoleperiode

...

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

...

Startdato

...

Slutdato

...

Uddannelsesversion

...

Den version af uddannelsen som eleven går på.
Se Uddannelsesmodellen for de gældende versioner.

...

String

...

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

...

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

...

Information om eleven er prøvefri, får specialundervisning mv.

OBS: Kun relevant for grundskoleområdet

...

Min længde 1

Max længde 4

...

Adgangsvej for elevens optag på uddannelsen.
Se Uddannelsesmodellen for de gældende adgangsveje.

...

Min længde 1

Max længde 50

...

Parametre for response

...

IndberetElevResponse

...

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

...

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
Status
Hovedinstitution
EnumDUPLICATE, COMPLETE
HeltalMax cifre: 6J1

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.

Hovedinstitutionen for den afdeling hvor eleven modtager undervisning
AfdelingHeltalMax 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.

Uddannelsesoplysninger

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
UddannelseskodeString

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

J1

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

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.

Elevskoleperiode

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
SkoleperiodeStringIngen/Ikke relevantJ1

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

Startdato

DateIngen/Ikke relevantJ1Startdato for elevskoleperioden

Slutdato

DateIngen/Ikke relevantN1Slutdato for elevskoleperioden

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.

ElevtypeStringMax længde: 10N1

Information om eleven er prøvefri, får specialundervisning mv.

OBS: Kun relevant for grundskoleområdet

AdgangsvejString

Min længde 1

Max længde 4

N1

Adgangsvej for elevens optag på uddannelsen.
Se Uddannelsesmodellen for de gældende adgangsveje.

KlassebetegnelseString

Min længde 1

Max længde 50

N1Navnet på den klasse eleven går i


Parametre for response

FeltDatatypeBegrænsningerKrævetBeskrivelse
IndberetElevResponse

IndberetElevResponse

Ingen/Ikke relevantJ

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

IndberetElevResponse

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
StatusEnumDUPLICATE, COMPLETEJ1

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
titleEksempel på request til Indberet
Kodeblok
languagexml
linenumberstrue
<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>
UI Expand
titleEksempel på request til Indberet
Kodeblok
languagexml
linenumberstrue
<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>TESTSYSTEM</v1:SystemName>
            <v1:SystemTransactionID>123456789</v1:SystemTransactionID>
         </v1:Identifier>
         <v1:Message>
            <ser:IndberetElevRequest>
               <ser:IndberetningsId>32ed0545-b6a0-4e91-bf7b-0fc0dff8ef73</ser:IndberetningsId>
                     <ser:IndberetElev>
                  <ser:Personoplysninger>
                     <ser:CPRNummer>0101011231<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>2<Skoleperiode>1</ser:Skoleperiode>
                           <ser:Startdato>2021Startdato>2020-08-01</ser:Startdato>
                           <ser:Uddannelsesversion>1</ser:Uddannelsesversion><!--Optional:-->
                           <ser:Speciale>3<Slutdato>2021-06-22</ser:Speciale>Slutdato>
                           <ser:Adgangsvej>TD<Uddannelsesversion>1</ser:Adgangsvej>Uddannelsesversion>
                           <ser:Klassebetegnelse>2020TD</ser:Klassebetegnelse><!--Optional:-->
                        <   <ser:Speciale>3</ser:Elevskoleperiode>Speciale>
                           <ser:Elevskoleperiode><!--Optional:-->
                           <ser:Skoleperiode>1<Adgangsvej>TD</ser:Skoleperiode>Adgangsvej>
                           <ser<!--Optional:Startdato>2020-08-01</ser:Startdato>>
                           <ser:Slutdato>2021-06-22<Klassebetegnelse>1.X</ser:Slutdato>Klassebetegnelse>
                        </ser:Elevskoleperiode>
   <ser:Uddannelsesversion>1</ser:Uddannelsesversion>
                  </ser:Elevskoleperioder>
                 <ser:Speciale>3< </ser:Speciale>Uddannelsesoplysninger>
               </ser:IndberetElev>
            <ser:Adgangsvej>TD<</ser:Adgangsvej>IndberetElevRequest>
         </v1:Message>
      </v1:IndberetElevRequest>
            <ser:Klassebetegnelse>2020TD</ser:Klassebetegnelse>
                        </ser:Elevskoleperiode></soap:Body>
</soap:Envelope>
UI Expand
titleEksempel på response til Indberet
Kodeblok
languagexml
titleSuccesfuld indberetning
linenumberstrue
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
                     </ser:Elevskoleperioder>
         <v1:IndberetElevResponse xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
         </ser<v1:Uddannelsesoplysninger>Identifier>
               </ser:IndberetElev><v1:SystemName>Test</v1:SystemName>
            </ser:IndberetElevRequest>
         <<v1:SystemTransactionID>Test</v1:Message>SystemTransactionID>
      </v1:IndberetElevRequest>
   </soap:Body>
</soap:Envelope>
UI Expand
titleEksempel på response til Indberet
Kodeblok
languagexml
linenumberstrue
<IndberetElevResponse xmlns="http://service.elevdatabasen.stil.dk/">
	<Status>COMPLETE</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

...

Institutionsoplysninger

...

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

...

StatusResponse

...

StatusResponse

...

StatusResponse

...

CREATED,

RECEIVED,

DUPLICATE,

PROCESSING,

COMPLETE,

FAILED

...

Status for behandling af indberetningen.
Se afsnittet Fejlhåndtering for information om status FAILED.

I tilfælde at status er andet end FAILED, COMPLETE eller DUPLICATE betyder, det at indberetningen er endt i en ugyldig tilstand.

...

    </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
languagexml
titleDuplicate

Indberetningsdetalje

...

UI Expand
titleEksempel request til Status
Kodeblok
languagexml
linenumberstrue
<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//05/soap-envelope">
   <soap:Body>
      <v1:StatusRequest>:IndberetElevResponse xmlns:v1="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
         <v1:Identifier>
            <v1:SystemName>TESTSYSTEM<SystemName>Test</v1:SystemName>
            <v1:SystemTransactionID>123456789<SystemTransactionID>Test</v1:SystemTransactionID>
         </v1:Identifier>
         <v1:CorrelationID>5e16ac8a-6d3c-476b-82d1-853f3373f0af</v1:CorrelationID>
         <v1:Message>
            <IndberetElevResponse <ser:StatusRequest>xmlns="http://service.elevdatabasen.stil.dk/">
               <ser:Institutionsoplysninger>
<Status>DUPLICATE</Status>
            </IndberetElevResponse>
          <ser:Hovedinstitution>961851</ser:Hovedinstitution></v1:Message>
                  <ser:Afdeling>961851</ser:Afdeling>
               </ser:Institutionsoplysninger>
               <ser:IndberetningsId>32ed0545-b6a0-4e91-bf7b-0fc0dff8ef73</ser:IndberetningsId>
            </ser:StatusRequest>
         </v1:Message>
      </v1:StatusRequest>
   </soap:Body>
</soap:Envelope></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

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse

StatusRequest

StatusRequest

Ingen/Ikke relevantJ1Request på status for indberetning.
Se beskrivelsen i afsnittet StatusRequest herunder. 

StatusRequest

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
InstitutionsoplysningerInstitutionsoplysningerIngen/Ikke relevantJ1Oplysninger om den indberettende institution
IndberetningsIdGUIDIngen/Ikke relevantJ1UUID for indberetningen der ønskes status for

Institutionsoplysninger

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
HovedinstitutionHeltalMax cifre: 6J1Hovedinstitutionen for den afdeling hvor eleven modtager undervisning
AfdelingHeltalMax 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

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse

StatusResponse

StatusResponse

Ingen/Ikke relevantJ1Response på status.
Se beskrivelsen i afsnittet StatusResponse herunder. 

StatusResponse

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
StatusEnum

CREATED,

RECEIVED,

DUPLICATE,

PROCESSING,

COMPLETE,

FAILED

J1

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

Indberetningsdetalje

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse
FejlkodeStringIngen/Ikke relevantJ1Elevdatabasens valideringsfejlkode
FejlbeskrivelseStringIngen/Ikke relevantJ1Beskrivelse af valideringsfejlen
UI Expand
titleEksempel responses request til Status
Kodeblok
languagexml
titleIndberetning gået godt (COMPLETE)
linenumberstrue
<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
languagexml
titleFejl i indberetning
linenumberstrue
<soap:Envelopeindberetning/v1.0" xmlns:soapser="http://wwwservice.elevdatabasen.w3stil.org/2003/05/soap-envelope"dk/">
   <soap:Header/>
   <soap:Body>
      <soap<v1:Fault>StatusRequest>
         <soap<v1:Code>Identifier>
            <soap:Value>soap:Sender</soap:Value><v1:SystemName>test</v1:SystemName>
            <v1:SystemTransactionID>test</v1:SystemTransactionID>
         </soapv1:Code>Identifier>
         <soap<v1:Reason>Message>
            <soap:Text xml:lang="en">Input error</soap:Text><ser:StatusRequest>
               <ser:Institutionsoplysninger>
         </soap:Reason>
         <soap:Detail>
<ser:Hovedinstitution>961851</ser:Hovedinstitution>
             <ServiceFaultDetailerV2 xmlns:ns2="http://service.elevdatabasen.stil.dk/" xmlns="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">     <ser:Afdeling>961851</ser:Afdeling>
               <CorrelationID>9718cb0b-6072-45ce-9656-a0799f99a5de</CorrelationID></ser:Institutionsoplysninger>
               <Timestamp>2022-06-13T11:01:37</Timestamp><ser:IndberetningsId>1c7f4754-9110-4a45-a251-f2c2ea2c7418</ser:IndberetningsId>
            </ser:StatusRequest>
   <ErrorCode>IPL171003</ErrorCode>
      </v1:Message>
      </v1:StatusRequest>
   <ErrorMessage>Indberetning is invalid</ErrorMessage></soap:Body>
</soap:Envelope>
UI Expand
titleEksempel responses til Status
Kodeblok
languagexml
titleIndberetning gået godt (COMPLETE)
linenumberstrue
<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">
    <Details>Indberetningen  indberetningsid 32ed0545-b6a0-4e91-bf7b-0fc0dff8ef73 er ugyldig</Details> <v1:Identifier>
            <v1:SystemName>test</v1:SystemName>
   <SourceSystemError>
         <v1:SystemTransactionID>test</v1:SystemTransactionID>
         <SourceSystemName>Elevdatabasen<</SourceSystemName>v1:Identifier>
         <v1:CorrelationID>e49467bf-545f-4348-b8a1-bb20efc32af4</v1:CorrelationID>
         <ErrorCode>Indb-2004</ErrorCode><v1:Message>
            <StatusResponse xmlns="http://service.elevdatabasen.stil.dk/">
      <DetailsList>
         <Status>COMPLETE</Status>
            <Detail></StatusResponse>
         </v1:Message>
      </v1:StatusResponse>
   </soap:Body>
</soap:Envelope>
Kodeblok
languagexml
titleFejl i indberetning
linenumberstrue
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">      <Code>Inst-04</Code>
   <soap:Body>
      <soap:Fault>
         <soap:Code>
      <Description>Hovedinstitutionen 961851 er registreret som en hovedinstitution med afdelinger</Description>
         <soap:Value>soap:Sender</soap:Value>
             </Detail>soap:Code>
                  </DetailsList><soap:Reason>
            <soap:Text   </SourceSystemError>
   xml:lang="en">Input error</soap:Text>
         </ServiceFaultDetailerV2>soap:Reason>
         </soap<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.

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
titleEksempel request til Slet
Kodeblok
languagexml
<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><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>
         <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 relevantJ1Element, der rummer detaljer om, hvad der anmodes slettes

SletRequest

Felt

Datatype

Begrænsninger

Krævet

Kardinalitet

Beskrivelse

CPRNummerStringLængde:10J1CPR-nummer (personnummer) på elevenhvis elevdata skal slettes.
HovedinstitutionHeltalMax cifre: 6J1Institutionsnummeret for hovedinstitutionen hvor elevdata skal slettes.
AfdelingHeltalMax cifre: 6J1

Institutionsnummeret for afdelingen hvor elevdata skal slettes.

Er institutionen en selvstændig institution uden hovedinstitution skal samme institutionsnummer angives i Hovedinstitution og Afdeling.

UddannelseskodeStringMinimum længde: 1, max længde: 4, ingen whitespace tegnJ1Den 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 relevantJ1Element, der indeholder svar på request om sletning

Felt

Datatype

Begrænsninger

Krævet

Kardinalitet

Beskrivelse

SletStatus

Enum

Værdimængde: DELETEDJ1Status på sletningen
(Operationen er endnu ikke implementeret)
UI Expand
titleEksempel response request til Slet
Kodeblok
languagexml
<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
titleEksempel response til Slet
Kodeblok
languagexml
<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>

...