Dato
15-11-2021
VersionStatus
1.0Gældende fra den 1. januar 2022.
Ansvarlig
Jørgen Bloch Vejbæk
Ændringshistorik
Version | Gældende fra | Kapitel/afsnit | Beskrivelse |
1.0 | 1/1 2022 | Dokumentet oprettet |
Indhold
1 Indledning
2 Hvem kan hente data?
3 Hvilke data kan hentes?
4 Webservice: HentInstitutionKontakt
4.1 Hent
4.1.1 Struktur for Hent
4.1.2 Hent
4.1.3 Elev
4.2 HentSvar
4.2.1 Struktur for HentSvar
4.2.2 HentSvar
4.2.3 ElevKontaktPerson
5 Valideringer
6 Endpoints til testmiljø
Indledning
Ungedatabasen indeholder oplysninger om kontaktperson tilknyttet den unge fra uddannelsesinstitutionen i de tilfælde, hvor den unge har et uddannelsespålæg. Disse oplysninger skal afhentes af jobcentrene.
Afhentning af oplysningerne fra Ungedatabasen, som kommer fra institutionernes studieadministrative systemer via webservices udstillet på STIL's integrationsplatform (Integrationsplatformen). Integrationsplatformen er knudepunktet for STIL's eksternt rettede webservices. Den er en ren infrastrukturkomponent som via autentificering, autorisering, logning og kryptering (https) understøtter en sikker, ensartet og effektiv udveksling af data mellem STIL's centrale systemer og eksterne systemer.
Integrationsplatformen anvendes af uddannelsesinstitutioner, myndigheder og organisationer/virksomheder på førskole- og grundskoleområderne samt på ungdomsuddannelsesområdet og voksen- og efteruddannelsesområdet.
Yderligere oplysninger om tilslutning og tekniske detaljer kan findes på STIL's supportsite for Integrationsplatformen via https://viden.stil.dk/x/BgBwBg.
Dette dokument beskriver strukturen for de oplysninger omkring kontaktpersoner på uddannelsesinstitutioner, som jobcentrene skal afhente via webservicen HentInstitutionKontakt når der er et aktivt abonnement i jobcenteret/DFDG på den unges uddannelsespålæg.
Hvem kan hente data?
Kontaktpersoner fra uddannelsesinstitutionerne kan afhentes af STAR/jobcentre. Der foretages forespørgsler på enten enkelte CPR-numre på unge eller på en dato, som angiver hvornår der sidst er afhentet data.
Hvilke data kan hentes?
Der kan afhentes kontaktoplysninger på kontaktpersoner fra uddannelsesinstitutionerne. Denne kontaktinformation indeholder følgende:
- Kontaktnavn: navn på person eller gruppe, som er kontaktperson/gruppe for en given ung.
- Kontakttelefon: telefonnummer på kontaktpersonen/gruppen.
- Kontaktmail: e-mail tilhørende kontaktpersonen/gruppen.
- En eventuel slutdato: angiver, hvornår en given kontaktperson ikke er aktuel mere.
- Institutionsnummer: institutionsnummeret på den institution, der har sendt kontaktpersonen ind.
Webservice: HentInstitutionKontakt
Denne webservice skal bruges af STAR til at afhente kontaktpersonen som uddannelsesinstitutionen sender ind.Webservicen kan kaldes når som helst, hvorefter Ungedatabasen foretager validering.
Webservicen indeholder en operation, HentInstitutionKontakt. Denne operation bruges til at afhente kontaktpersonen fra uddannelsesinstitutionen fra Ungedatabasen hvorefter der returneres et synkront svar med enten en kontaktperson eller fejlbesked.
Der kan afhentes enten via CPR-numre (max 100 i ét kald) eller via SidenSidst. Ved SidenSidst returneres alle kontaktpersoner, der er blevet oprettet eller opdateret siden tidspunktet angivet i feltet. I svaret på webservicen kan der maksimalt returneres 100 kontaktpersoner. Feltet FindesFlereKontaktPersoner sættes til true, hvis der spørges på SidenSidst og der findes mere end 100 kontaktpersoner til afhentning. Derudover angives SenesteRegistering i svaret, som er det tidspunkt, der kan/skal anvendes i næste kald.
Hent
Operationen Hent i webservicen er bygget op som beskrevet i de følgende afsnit.
Struktur for Hent
Hent
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
---|---|---|---|---|
STARInstitutionNummer | Integer (10) | Ja | Institutionsnummer fra STAR | |
Elev | XML element | Nej | Max 100 | Enten Elev eller SidenSidst skal være udfyldt. |
SidenSidst | Datetime | Nej | Enten Elev eller SidenSidst skal være udfyldt. |
Elev
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
---|---|---|---|---|
CPRNr | String(10) | Ja | Skal kunne findes i CPR-registeret | CPR-nummeret på den unge, som indberetningen vedrører. |
HentSvar
Webservicen returnerer følgende i et synkront svar.
Struktur for HentSvar
HentSvar
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
---|---|---|---|---|
FindesFlereKontaktPersoner | Boolean | Ja | Hvis SidenSidst er angivet og der findes flere kontaktpersoner end 100, sættes denne til true. Ellers sættes den til false. | |
SenesteRegistering | DateTime | Nej | Sættes til opdateringstidspunktet på den seneste kontaktperson i response. Dette tidspunkt indsættes i næste kald af webservicen for at afhente de næste 100 eller resten af kontaktpersonerne. | |
ElevKontaktPerson | XML element | Nej | Indeholder enten kontaktperson for given ung eller fejlbesked. |
ElevKontaktPerson
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
---|---|---|---|---|
CPRNr | String (10) | Nej | Angiver den person kontaktpersonen er tilkoblet. | |
FejlKode | Integer(10) | Nej | Sat hvis validering finder fejl. | |
FejlTekst | String | Nej | Sat hvis validering finder fejl. | |
KontaktPerson | String(250) | Nej | Kun udfyldt hvis der findes kontaktperson. Kontaktpersonens navn eller gruppe | |
KontaktTelefon | String(20) | Nej | Kun udfyldt hvis der findes kontaktperson. | |
KontaktMail | String(64) | Nej | Kun udfyldt hvis der findes kontaktperson. | |
SlutDato | DateTime | Nej | Kun udfyldt hvis der findes kontaktperson. | |
InstitutionNummer | Integer(10) | Nej | Institutionsnummer på institutionen, der har sendt kontaktperson ind. |
Valideringer
Følgende valideringer finder sted i afhentningen af kontaktperson fra uddannelsesinstitutionen:
Fejlnummer | Relateret attribut | Fejltekst | Forklaring |
---|---|---|---|
14 | CPRNr | Den Unge findes ikke i Ungedatabasen | Der skal kun indberettes for unge med bopæl i Danmark. CPR nummeret kan ikke genfindes i Ungedatabasen i relation til en aktiv ung bosiddende i Danmark. |
18 | CPRNr | Ingen information at hente | Der er ikke registreret nogen kontaktperson fra institutionen. |
68 | CPRNr | Den unge findes ikke i aktivt abonnement | Den unge findes ikke i aktivt STAR abonnement i Ungedatabasen og der kan derfor ikke hentes kontaktinformation fra institutionen. |
Integrationsplatformen IPL står for skemavalidering af xlm, men der er for en sikkerhedsskyld ligeledes indsat validering i Ungedatabasen, som kan resultere i 'fejl 500'. Sådanne fejl vil blive returneret i elementet ServiceFaultDetailer, der ses i xsd'en.
Endpoints til testmiljø
Endpoints til testmiljø kan findes her: https://viden.stil.dk/display/OFFintegrationsplatformen/Services
Webservicens ligger under System Ungedatabasen og har navnet HentInstitutionKontakt version 1.0.