Versioner sammenlignet

Nøgle

  • Linjen blev tilføjet.
  • Denne linje blev fjernet.
  • Formatering blev ændret.
Kommentar: Tilføjet operationen Slet

...

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

...

Indholdsfortegnelse
maxLevel3
excludeIndhold|Dokumenthistorik

Bemærk
titleSlettefunktion

Slettefunktion Interface til operationen Slet er implementeret (skal anvendes ved fejloprettelse af elever) forventes implementeret i Elevdatabasens interface (WSDL) i løbet af uge 23 - 2022, funktionaliteten er endnu ikke implementeret.

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 aktuelle tilknytning til institutioner og uddannelser, herunder trin, start- og slutdatoer mv. De overordnede dataområder, Elevdatabasen opererer med, er persondata, institutionsdata og uddannelsesdata.

...

Udvid
titleUddannelseskoder for grundskolen der skal indberettes til Elevdatabasen

Uddannelseskode (CØSA formål)

UddannelseFormålsgruppe
332EUD1018
211910. klasseundervisning18
4800Folkeskole45
4801Ungdomsskoler45
4802Kommunale internationale grundskoler45
4803Frie skoler45
4804Efterskoler45Uddannelsesmodellen for grundskolen er under udarbejdelse


Gymnasieområdet

Alle elever, der går på en gymnasieuddannelse under formålsgruppe 2 eller 33 i Uddannelsesmodellen, skal indberettes til Elevdatabasen.

...

OperationBeskrivelse
IndberetSelve indberetningen, dvs. data om elev, uddannelse mv.
StatusHenter status for en indberetning ud fra IndberetningsId
SletSletter alle indberetninger for en elev på en institution. Kun til fejlindberetninger.
PingAngiver om Elevdatabasen er funktionel

...

Svaret fra Status-operationen er identisk med svaret på en indberetning, og operationen kan benyttes ved tvivl om hvorvidt en indberetning er gået godt.

...

Slet

Anvendes til at

...

slette alle indberetninger for en 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 skoleperiodehistorik på institutionen.

Ping

Anvendes til at pinge Elevdatabasen og angiver om Elevdatabasen kan modtage indberetninger.


...

Fejlhåndtering

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

...

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 #tidligsteSkoleperiodeStartdato ligger før startdato for uddannelsen med Uddannelseskoden #Uddannelseskode 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 #adgangsvej på skoleperiode #Skoleperiode #skoleperiode er ikke tilknyttet uddannelsen #Uddannelseskode#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 Teknisk beskrivelse af operationer

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

...

UI Expand
titleEksempel responses til Status
Kodeblok
languagexml
titleIndberetning gået godt (COMPLETE)
linenumberstrue
<StatusResponse xmlns="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
    <Status>COMPLETE</Status>
</StatusResponse>
Kodeblok
languagexml
titleFejl i indberetning
linenumberstrue
<soap:Fault>
         <soap:Code>
            <soap:Value>soap:Sender</soap:Value>
         </soap:Code>
         <soap:Reason>
            <soap:Text xml:lang="en">Input error</soap:Text>
         </soap:Reason>
         <soap:Detail>
            <ServiceFaultDetailerV2 xmlns:ns2="http://service.elevdatabasen.stil.dk/" xmlns="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
               <CorrelationID>b7618eba-a992-4460-81c5-4b39660d9450</CorrelationID>
               <Timestamp>2022-04-07T06:54:22</Timestamp>
               <ErrorCode>IPL171003</ErrorCode>
               <ErrorMessage>Indberetning is invalid</ErrorMessage>
               <Details>Indberetningen på indberetningsid 32ed0545-b6a0-4e91-bf7b-0fc0dff8ef73 er ugyldig</Details>
               <SourceSystemError>
                  <SourceSystemName>Elevdatabasen</SourceSystemName>
                  <ErrorCode>Indb-2004</ErrorCode>
                  <DetailsList>
                     <Detail>
                        <Code>Inst-04</Code>
                        <Description>Hovedinstitutionen 961851 er registreret som en hovedinstitution med afdelinger</Description>
                     </Detail>
                  </DetailsList>
               </SourceSystemError>
            </ServiceFaultDetailerV2>
         </soap:Detail>
      </soap:Fault>

Slet

Operationen har følgende struktur for request og response:

Parametre for request

Felt

Datatype

Begrænsninger

Krævet

Kardinalitet

Beskrivelse

SletRequest

SletRequest

Ingen/Ikke relevantJ1Request på Slet
Se beskrivelsen i afsnittet SletRequest herunder. 

SletRequest

Felt

Datatype

Begrænsninger

Krævet

Kardinalitet

Beskrivelse

Felt

Datatype

Begrænsninger

Krævet

Kardinalitet

Beskrivelse

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

Institutionsnummeret for afdelingen hvor  hvor elevdata skal slettes.

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

UddannelseskodeStringMinimums 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

SletStatus

Enum

Værdimængde: DELETEDJ1Response på slet
(Endnu ikke implementeret)
UI Expand
titleEksempel request til Slet

<ser:SletRequest>
         <ser:CPRNummer>1111112222</ser:CPRNummer>
         <ser:Hovedinstitution>101010</ser:Hovedinstitution>
         <ser:Afdeling>101010</ser:Afdeling>
         <ser:Uddannelseskode>3010</ser:Uddannelseskode>
</ser:SletRequest> 

UI Expand
titleEksempel response til Slet

(Operationen er endnu ikke implementeret)

<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>b44c62b8-56f2-449f-b4ea-99c592b88ea4</ns2:CorrelationID>
               <ns2:Timestamp>2022-06-08T07:07:43</ns2:Timestamp>
               <ns2:ErrorCode>IPL171001</ns2:ErrorCode>
               <ns2:ErrorMessage>An internal server error occurred on the source service</ns2:ErrorMessage>
               <ns2:Details>Slette funktion ikke implementeret</ns2:Details>
               <ns2:SourceSystemError>
                  <ns2:SourceSystemName>Elevdatabasen</ns2:SourceSystemName>
                  <ns2:ErrorCode>Elevdb-1001</ns2:ErrorCode>
                  <ns2:Details>Ikke implementeret</ns2:Details>
               </ns2:SourceSystemError>
            </ns2:ServiceFaultDetailerV2>
         </soap:Detail>
      </soap:Fault> 

Ping

Operationen har følgende struktur for request og response

Parametre for request

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse

Ping

Ping

Ingen/Ikke relevantJ1Ping kald til Elevdatabasen

Parametre for response

FeltDatatypeBegrænsningerKrævetKardinalitetBeskrivelse

PingReponse

PingSvar

Ingen/Ikke relevantJ1Ping svar fra Elevdatabasen
StatusStringup, downJ1Status på ping svar fra Elevdatabasen

...