Dokumentoplysninger
Ændringshistorik
Arkiveret ændringshistorik
Indhold
Indledning
Dette dokument beskriver på overordnet niveau strukturen for de fraværsoplysninger for praktikrelevante elever, der skal indberettes til Praktikpladsen.dk fra de studieadministrative systemer, herunder EUX, og giver en beskrivelse af webservicen til indberetningen (herefter Webservicen) via eksempler.
Der skal ske en "system til system"-udveksling. Det betyder i praksis, at institutionens studieadministrative system har funktioner til at eksportere data og varetage selve dataudvekslingen ved hjælp af kald af en webservice i Praktikpladsen.dk.
Den enkelte institution eller det enkelte studieadministrative system skal dagligt overvåge eventuelle fejlmeldinger fra dataoverførslen og enten selv afhjælpe eventuelle problemer eller indberette dem til leverandøren af det studieadministrative system, der, hvis nødvendigt, kan indberette disse til STIL's support.
Webservicen
Webservicen kaldes via STIL’s integrationsplatform IPL (se afsnittet Webservicen).
IPL er en integrationsplatform, som understøtter udveksling af data mellem STIL's centrale systemer og eksterne systemer. IPL anvendes af uddannelsesinstitutioner, myndigheder og organisationer på førskole-, grundskole-, ungdomsuddannelses-, voksen- og efteruddannelsesområdet.
Platformen tilbyder ensartede webservices for indberetning til og afhentning af data fra STIL's centrale systemer inkl. autentificering, autorisering og logning af hændelser i forbindelse med dataudvekslingen. IPL er en ren infrastrukturkomponent, og har ingen brugergrænseflade, ligesom den ikke opbevarer data. Platformen understøtter, at systemleverandører, blandt andet leverandører af studieadministrative systemer på de ovennævnte uddannelsesområder, kan udveksle data med STIL's systemer på en institutions vegne på en ensartet, transparent og sikker måde.
Alle relevante oplysninger om tilslutning og tekniske detaljer kan findes på STIL’s support site via https://viden.stil.dk/x/KgAGAQ.
Hvem skal indberette?
Alle institutioner, som administrerer grundforløb og/eller hovedforløb på erhvervsuddannelsesområdet, og som ikke benytter EASY-A.
Hvad skal indberetningen omfatte?
Elever under CØSA's formålsgruppe 01, Erhvervsuddannelser (EUD), og formålsgruppe 02, Erhvervsgymnasiale uddannelser.
Indberetningen omfatter følgende:
- Fravær:Alle registreringer af fravær på praktikrelevante personer på skolen. Praktikrelevante personer defineres som personer der er tilknyttet en uddannelse under formålsgruppe 01 (EUD) eller 02 (Erhvervsgymnasiale uddannelser).
Hvornår skal der indberettes?
Der skal indberettes, når der sker registrering af fravær.
Indberetningerne skal ske løbende dagligt. Det vil sige, at hvis der er data at indberette, skal indberetningen ske mindst 4 gange i timen.
Institutionens studieadministrative system skal have funktioner til at forsøge gentagelse af overførslen såfremt overførslen fejler.
Hvis en fraværsregistrering slettes i det studieadministrative system, skal dette ligeledes indberettes. Dette gøres ved
- at lave en indberetning, som sletter alt fravær for den pågældende person på den pågældende dag
- og derefter, hvis den pågældende person har fravær den pågældende dag, en indberetning, som indberetter alt det korrekte fravær for den pågældende person på den pågældende dag
Data indlæses ikke i Praktikpladsen.dk i forbindelse med indberetningen, men indlæses asynkront. Dvs. data modtages, valideres og gemmes i grænsefladetabeller. Herfra indlæses de modtagne data i produktionstabeller via batchjobs i Praktikpladsen.dk. Hvis der opstår fejl under indlæsningen i Praktikpladsen.dk, adviseres personen/personerne angivet i "KontaktEmail" (som angives i noden Indberetning).
Hvilke oplysninger skal indberettes?
Indberetningerne skal ske via IPL. Se afsnit 2.
Beskrivelserne i afsnit 7 omhandler kun den indre del af webservicekaldet, som videresendes til Praktikpladsen.dk.
Fravær indberettes med 1 af de 3 bogstavkoder:
- "G" betyder Godkendt fravær
- "I" betyder Ikke godkendt fravær
- "F" betyder For sent.
Hvad skal data indeholde?
IPL-servicen Praktikpladsen_Fravaer
Der udstilles en webservice på IP-Ung med navnet Praktikpladsen_Fravaer. Denne webservice udstiller 2 operationer:
- Opret_Fravaersregistrering
- Slet_Fravaersregistrering
Operationen Opret_Fravaersregistrering
Denne operation anvendes til at indberette fravær for en elev på en given uddannelsesinstitution for en given dato.
Input
Input til operationen Opret_Fraversregistrering består af følgende felter:
Navn | Type | Obligatorisk | Minimal længde | Maksimal længde | Beskrivelse |
---|---|---|---|---|---|
Cpr | Tal | Ja | 10 | 10 | CPR-nummer. |
Fravaersdato | Dato | Ja | Fraværsdato. | ||
Afdeling | Tekst | Nej | 6 | 6 | Nummer på den institutionsafdeling, der indberetter fraværet. I produktion er dette et 6-cifret tal. Ved test kan der forekomme bogstaver. |
Afdelingsnavn | Tekst | Nej | 100 | Navn på institutionsafdelingen der indberetter fraværet. | |
CosaFormal | Tekst | Ja | 1 | 4 | Cøsa-formålsnummer. |
Version | Tal | Ja | 1 | 4 | Uddannelsesversion. |
CentralKode | Tekst | Ja | 1 | 1 | Fraværskode: G, I, eller F. |
LokalKode | Tekst | Nej | 20 | Eventuel lokal fraværskode. | |
LokalBeskrivelse | Tekst | Nej | 100 | Eventuel beskrivelse af lokal fraværskode | |
Minutter | Tal | Ja | 1 | 4 | Fravær i antal minutter. |
Nummer | Tekst | Nej | 20 | Lektionsnummer / -betegnelse. | |
Start | Tidspunkt | Ja | Lektions starttidspunkt for fraværet. | ||
Slut | Tidspunkt | Ja | Lektions sluttidspunkt for fraværet. |
Hvis fraværssystemet ikke understøtter lektion start og slut, kan der i stedet indberettes start og slut for en normal skoledag.
Output
Navn | Type | Obligatorisk | Eksempler (tilhørende statuskode) |
---|---|---|---|
Fejlkode | Tekst | Ja | "ok" (200), "fejl" (400, 401). |
Fejlmeddelelse | Tekst | Ja | "Fravaersdato skal være på formatet YYYY-MM-DD" |
Operationen Slet_Fravaersregistrering
Denne operation anvendes til at slette alt registreret fravær for en elev tilknyttet en given uddannelsesinstitution, på en given dato.
Input
Navn | Type | Obligatorisk | Minimal længde | Maksimal længde | Beskrivelse |
---|---|---|---|---|---|
Cpr | Tal | Ja | 10 | 10 | CPR-nummer. |
Fravaersdato | Dato | Ja | Fraværsdato. |
Output
Output fra operationen Slet_Fravaersregistrering er beskrevet i tabellen nedenfor.
Navn | Type | Obligatorisk | Eksempler |
---|---|---|---|
Fejlkode | Tekst | Ja | "ok" (200), "fejl" (400, 401) |
Fejlmeddelelse | Tekst | Nej | "Fravaersdato skal være på formatet YYYY-MM-DD" |
Bilag 1. Eksempel på valide XML-data
Opret fraværsregistrering:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://stil.dk/ipung/services/praktikpladsen/fravaer/v1.0"> <soap:Header/> <soap:Body> <v1:OpretFravaersregistrering> <v1:Identifier> <v1:SystemName>XXXXX</v1:SystemName> <v1:SystemTransactionID>7d061fe5-7f2a-4dc1-869b-5449c9c35ad2</v1:SystemTransactionID> </v1:Identifier> <v1:Cpr>0809991234</v1:Cpr> <v1:Fravaersdato>2019-12-24</v1:Fravaersdato> <!-Optional:-> <v1:Afdeling>123456</v1:Afdeling> <!-Optional:-> <v1:Afdelingsnavn>Roskilde</v1:Afdelingsnavn> <v1:Uddannelse> <v1:CosaFormal>1912</v1:CosaFormal> <v1:Version>8</v1:Version> </v1:Uddannelse> <v1:Fravaer> <v1:CentralKode>I</v1:CentralKode> <!-Optional:-> <v1:LokalKode>X</v1:LokalKode> <!-Optional:-> <v1:LokalBeskrivelse>Ikke godkendt</v1:LokalBeskrivelse> <v1:Minutter>120</v1:Minutter> <v1:Lektion> <!-Optional:-> <v1:Nummer>1</v1:Nummer> <v1:Start>08:00</v1:Start> <v1:Slut>09:59</v1:Slut> </v1:Lektion> </v1:Fravaer> </v1:OpretFravaersregistrering> </soap:Body> </soap:Envelope> Slet fraværsregistrering: <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://stil.dk/ipung/services/praktikpladsen/fravaer/v1.0"> <soap:Header/> <soap:Body> <v1:SletFravaersregistrering> <v1:SystemName>XXXXX</v1:SystemName> <v1:SystemTransaktionID>7d061fe5-7f2a-4dc1-869b-5449c9c35ad2</v1:SystemTransaktionID> <v1:Cpr>0809991234</v1:Cpr> <v1:Dato>2019-12-24</v1:Dato> </v1:SletFravaersregistrering> </soap:Body> </soap:Envelope>