Dokumentoplysninger

Gældende version og gyldighedsdato
DatoVersionGældende fraAnsvarlig
11.11.2021

2.0

Den 1. januar 2022Jørgen Bloch Vejbæk

Ændringshistorik

Gældende version
Dato

Version

Emne

Ændring

Ændret af
11.21.2021

2.0

Hele dokumentet

Tilpasset Integrationsplatformen IPL.

JBV

Arkiveret ændringshistorik

Tidligere versioner
Dato

Version

Emne

Beskrivelse

Ændret af
10.03.2021

1.0

Webservice-beskrivelse

Første version, hvor beskrivelsen af webservicen ValideringsSvarOgAdvis har fået en selvstændig beskrivelse. Der er ikke foretaget ændringer på selve webservicen.

JBV

Indhold

Indledning

Ifølge Vejledningsloven skal den Kommunale ungeindsats (KUI), opsøge og vejlede alle unge, der ikke er i gang med eller har gennemført en ungdomsuddannelse eller en videregående uddannelse inden de fylder 25 år.
Endvidere skal jobcentre ifølge kontanthjælpsreformen administrere, at unge under 30 år uden uddannelse skal have uddannelseshjælp i stedet for kontanthjælp.

Til dette formål har relevante uddannelsesinstitutioner pligt til at indberette oplysninger om unges uddannelsesforløb til Ungedatabasen (UDB), som drives af Styrelsen for It og Læring (STIL).
UDB videresender oplysningerne til KUI og jobcentre via Styrelsen for Arbejdsmarked og Rekruttering (STAR). Derudover anvender STIL oplysningerne til statistiske formål.

Indberetninger til UDB sker fra institutionernes studieadministrative systemer via webservices udstillet på STIL's integrationsplatform (IPL). 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.

Integrationsplatformen formidler også svar fra UDB vedrørende indberetningerne til de studieadministrative systemer. Det betyder, at de studieadministrative systemer skal have funktioner, som understøtter denne dataudveksling. Såfremt institutionen skifter administrativt system eller fusionerer, skal dette meddeles til STIL.

Dette dokument beskriver strukturen for de oplysninger, som kan komme i svaret (valideringsvar) på de indberetning uddannelsesinstitutionerne skal indberette til UDB. Valideringssvaret kan indeholde fejlbeskeder og/eller angivelse af de forløbsidentiteter, som er tildelt indberetning, der er gået godt. Yderligere kan der gives en advis fra KUI, hvis de vurderer at den unge er faldet fra uddannelsen eller er i risiko for at falde fra uddannelsen.

Hvem skal indberette og efterfølgende afhente valideringssvar?

Uddannelsesinstitutioner og kommuner (kommunal ungeindsats), som varetager undervisning eller på anden vis er ansvarlig for den unges aktivitet, skal afhente.

Valideringssvar afhentes ved angivelse af institutionsnummer på juridisk institution eller afdelingen, som forestod indberetningen. Institutions afdelingen skal være oprettet i Børne- og Undervisningsministeriets Institutionsregister. Hvis institutionen kun har et hovednummer (den juridiske institution), skal indberetningen foretages via dette hovednummer. Institutionsnummeret angives i brugernavnet til Integrationsplatformen.

Hvilke personer hentes der valideringssvar for?

Vejledningsloven omhandler alle unge fra 15 år til og med 29 år, og det er således uddannelsesinstitutionernes pligt at indberette om ændringer i disse unges uddannelsesforløb.

Indberetningerne skal vedrøre forløb, som kan have en varighed på mindst 6 uger. Det betyder, at uddannelsesinstitutionen ikke skal indberette for fx brobygningselever (9.-10. klasse-elever i et kortvarigt brobygningsforløb på fx et gymnasium) eller for eksamenstilmeldte, som ikke er tilmeldt undervisning. Derimod skal uddannelsesinstitutionen indberette for selvstuderende, som er tilmeldt undervisning.

Der skal afhentes valideringsvar for alle indberetninger.

Hvornår hentes valideringssvar?

Der er opfordret til at indberette dagligt, og derfor bør der også hentes valideringssvar dagligt. Bemærk at der kan gå lidt tid med behandling af indberettede data inden valideringssvaret kan hentes.

Hvilke oplysninger kan hentes?

  1. Forløbsidentiteter, som er tildelt indberetning, der er gået godt.
  2. Fejlbeskeder, som kan gives dels hvis indberetningen afvises, men også fejlbeskeder til orientering når det vurderes at rækkefølgen af indberetninger virker forkert, men indberetning accepteres alligevel.
  3. Advis (besked) fra KUI, hvis de vurderer at den unge er faldet fra uddannelsen eller er i risiko for at falde fra uddannelsen. Institutionen får således mulighed for at sikre at status er opdateret på den unge.

WS ValideringsSvarOgAdvis

Denne webservice anvendes til at hente resultatet af valideringen af indberetninger. Servicen returnerer valideringssvar tilhørende den enkelte datakilde (uddannelsesinstitution).

Det forventes, at webservicen generelt kaldes uden brug af søgeparametre, da Ungedatabasen således vil returnere alle de valideringssvar, der ikke tidligere er sendt til datakilden.

I de tilfælde hvor man ønsker at styre, hvilke indberetninger der hentes valideringssvar for, er det muligt at angive et specifikt hændelsesnummer.

Man kan også spørge på alle valideringssvar for hændelsesnumre, der er lig med eller større end et angivet hændelsesnummer. Denne mulighed forventes kun at blive anvendt i situationer, hvor datakilden ønsker at hente en større mængde af historiske valideringssvar eksempelvis ved systemfejl eller datatab.

Webservicen er udstillet på integrationsplatformen.

Struktur HentRequest

Den overordnede XML-struktur fremgår af figur 1.

Figur 1. XML-struktur for afhentning.


Hent indeholder søgeparametre til at afgrænse, hvilke valideringssvar der hentes.

Hent

Felt

Type

Krævet

Lovlige værdier

Beskrivelse

InstitutionNummer

String

Ja


Institutionsnummeret for den institution, der foretager kaldet. Bruges til at sikre at valideringssvar sendes til institutionen der har indberettet hændelserne. InstitutionNummer svarer til Username i IP-UNG webservicen.

SidstHentet

DateTime

Nej

yyyy-mm-ddThh:mm.ss

Timestamp for afhentning af fejl og advis.
Når der er skrevet et tidspunkt i feltet returneres alle fejl og advis der enten ikke er afhentet tidligere eller er afhentet efter dette tidspunkt.

FraHaendelseNummer

String

Nej


Der returneres valideringssvar og adviseringer for indberetninger med det angivne hændelsesnummer og derover. Angiv derfor det mindste hændelsesnummer, der ønskes information om. Der returneres samtidig uafhentede adviseringer.

HaendelseNummer

String

Nej


Der returneres valideringssvar for indberetninger med dette hændelsesnummer. Der returneres samtidig uafhentede adviseringer.

ModtagerSystemID

String(100)

Ja


En streng, som udpeger det eksterne system – dvs. navnet på systemet. ModtagerSystemID svarer til samme element i IP-UNG webservicens element Modtager. Skal udfyldes af samme værdi som står i SystemName (og hvis der tidligere har været tilkobling til IP-UNG, den samme værdi som blev sat i feltet af samme navn). Brugs bl.a. til at sørge for at valideringssvar sendes til korrekte system.

Struktur HentResponse

Den overordnede XML-struktur fremgår af figur 2.

Figur 2. XML-struktur for afhentning af valideringssvar og adviseringer.


HentResponse returnerer valideringssvar til datakildens administrative system for alle de indberetninger, som datakilden endnu ikke har afhentet, såfremt der ikke angives særlige søgeparametre. Ungedatabasen konfigureres til at returnere svar for 99 indberetninger, men dette kan ændres. Hvis der således findes flere svar, returneres de tidligste med markering om, at der findes flere. Herefter kan datakilden kalde igen og få de resterende.

Valideringssvarene sorteres efter hændelsesnummer og leveres med det laveste nummer først (sorteret efter CPR-nummer).

HentSvarValiderings

Felt

Type

Krævet

Lovlige værdier

Beskrivelse

FindesFlereHaendelser

Boolean

Ja

True = Ja der findes flere hændelser, og der bør spørges igen for at få de resterende.
False = Nej. Alle hændelser er returneret.

Markering af, om der findes flere svar end dem, der er returneret i det aktuelle svar.
Når datakilden modtager besked om, at der findes flere svar, er det hensigten, at der spørges igen på de resterende.

HoejesteHaendelseNummer

String

Nej


Indeholder det højeste hændelsesnummer, der er returneret i et svar.
Hvis der er angivet en markering af, at der findes flere hændelser, kan kaldet gentages med denne værdi i Hændelsesnummer, hvilket vil give de efterfølgende valideringssvar.

Valideringssvar

XML-element

Nej


Indeholder kvittering og eventuelle fejl efter endt behandling af indberetningen.

Adviser

XML-element

Nej


Indeholder et advis og en advistekst.

Valideringssvar

Valideringssvar indeholder enten en fejlstruktur eller en kvitteringsstruktur.

Felt

Type

Krævet

Kommentar

HaendelseNummer

String

Ja

Et hændelsesnummer dannet af UDB.

Fejl

XML-element

Nej

Indeholder eventuelle konkrete fejl som følge af behandlingen i UDB.

Kvittering

XML-element

Nej

Indeholder oplysning om hændelsen, hvis den er oprettet.

Fejl

Fejl indeholder de konkrete fejl, som er konstateret i løbet af behandlingen.

Felt

Type

Krævet

Kommentar

Fejlkode

Integer (10)

Ja

En entydig identifikation af fejltypen i UDB.

Fejltekst

String

Ja

Beskrivelse af fejlen.

Kvittering

Felt

Type

Krævet

Kommentar

ForloebId

String

Ja

Entydig identifikation af forløbet, som hændelsen, der er oprettet ud fra indberetningen, er blevet tilknyttet i UDB.

Adviser

Adviser indeholder et hændelsesnummer og forløbId til identifikation af en ung, der er registreret som frafaldstruet eller med afbrud ifølge et KUI. Adviseringen om risiko for frafald (frafaldstruet) sendes for, at institutionen kan tage handling på at fastholde den unge i uddannelse.

Felt

Type

Krævet

Kommentar

HaendelseNummer

String

Ja

HændelsesNummer fra UDB på den seneste 'Optaget'-hændelse modtaget fra uddannelsesinstitutionen.

ForloebId

String

Ja

Forløbsidenten for det forløb, der adviseres omkring.

Advis

XML-element

Ja


Advis

Et advis indeholder en daviskode og en advistekst, og er en orientering til institutionen.

Felt

Type

Krævet

Kommentar

AdvisKode

Integer (10)

Ja

En kode, der identificerer advistypen. Enten FrafaldstruetIfoelgeUUcenter eller AfbrudIfoelgeUUcenter.

AdvisTekst

String

Ja

En tekst, der beskriver hvorfor institutionen adviseres.

Fejlkoder

Der oprettes ikke hændelser ved hårde fejl. Disse indberetninger afvises. Der kan således være behov for at gensende indberetninger, hvis det ud fra fejlbeskeden viser sig at være relevant.

Der dannes hændelser for indberetninger med bløde fejl, men der returneres en fejlbesked, da det antages, at der er uregelmæssigheder ved indberetningen.

Der henvises til viden.stil.dk under Ungedatabasen, hvor der under "Uddannelsesmodel/-kodesæt" findes et excelark med et faneblad for Fejl-koder.

Listen af fejlkoder viser om det er hårde (H) eller bløde (B) fejl. Bløde fejl vil have en kode under 200. Hårde fejl har fra kode 200 og op.

Det bemærkes, at formattjek foretages i integrationsplatformen og kan resultere i fejl 400 eller 500 fra Integrationsplatformen. Dvs. ikke en fejlkode genereret af Ungedatasen.

Listen viser alle fejlkoder, som kan forekomme i Ungedatabasens webservices. Det er også angivet hvilke fejlkoder, der kan forekomme per webservices.

Endpoints til testmiljø


Endpoints til miljøer kan findes her: https://viden.stil.dk/display/OFFintegrationsplatformen/Services.

Webservicens ligger under System Ungedatabasen og har navnet ValideringsSvarOgAdvis version 1.