Sidehistorik
Dokumentoplysninger
| UI Expand | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
Ændringshistorik
| UI Expand | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Arkiveret ændringshistorik
| UI Expand | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
|
Indhold
| Indholdsfortegnelse | ||||
|---|---|---|---|---|
|
Indledning
Ungedatabasen indeholder en række oplysninger om de unge mellem 15-30 år.
...
Dette dokument beskriver strukturen for de oplysninger, som uddannelsesinstitutioner kan afhente via webservicen DataTilInstitution.
Hvem kan hente data?
Ungedatabasen udstiller flere typer data. Det vil for flere at disse datatyper være et krav, at den unge er optaget på uddannelsesinstitutionen.
En uddannelsesinstitution kan hente oplysninger for de eventuelle afdelinger, som måtte høre under skolen.
Hvilke data kan hentes?
Uddannelsesinstitutionerne kan hente tre typer af oplysninger, som beskrives nedenfor, men der kan kun hentes en type oplysninger per kald.
...
Der kan hentes data, når de endelige uddannelsesparathedsvurderinger ligger klar, hvilket typisk vil sige medio juli for nye uddannelsesparathedsvurderinger.
DataTilInstitution
Denne webservice anvendes af uddannelsesinstitutioner ved afhentning af oplysninger om de unge. Når servicen kaldes, skal det angives, hvilken institution der hentes for. Institutionen kan kalde servicen når som helst, hvorefter Ungedatabasen foretager en validering returneret i et synkront svar.
Overordnet struktur
Hent Kommune Kontaktperson
Struktur for HentKommuneKontaktRequest
Figur 1. XML-struktur for afhentning af information om kommunekontakt til uddannelsesinstitutioner.
HentKommuneKontaktRequest
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
|---|---|---|---|---|
InstitutionNummer | Integer (6) | Ja | Institutionsnummer fra den kaldende institution. | |
OpdateretSenereEnd | DateTime | Nej | Hvis anført returneres kun data oprettet efter denne dato. Kan ikke angives sammen med Elev (CPR-numre). | |
Elev | XML-element | Nej | Max 100 | Ingen, en eller flere forekomster. Repræsenterer elever der ønskes status på. Kan ikke angives sammen med OpdateretSenereEnd. |
Elev
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
|---|---|---|---|---|
CPRNr | String (10) | Ja | CPR-nummer på den unge, som der ønskes svar på. Der valideres på CPRnr og det returneres i ElevStatus sammen med efterspurgte data eller eventuel fejlkode og fejltekst. |
Struktur HentKommuneKontaktSvar
Figur 2. XML-struktur for svar.
HentKommuneKontaktSvar
HentKommuneKontaktSvar er blot den overordnede struktur på svaret.
Vil forekomme, hvis der er spurgt om kommunekontaktdata.
Felt | Type | Krævet | Beskrivelse |
ElevStatus (XML-struktur) | Ja | En forekomst for hvert CPRnr i ElevStatus angivet i input, hvis der er spurgt på kommunekontaktdata. |
ElevStatus
ElevStatus indeholder CPRnr fra input (Elev) og evt. Fejlkode, Fejltekst på den unge.
Der kan maksimalt spørges på 100 cpr-numre, hvis der forespørges på cpr-numre.
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
|---|---|---|---|---|
CPRNr | String (10) | Nej | CPR-nummer for den unge. | |
FejlKode | Integer(10) | Nej | Se note 1 | Hvis ingen fejl er feltet tomt. |
FejlTekst | String | Nej | Se note 1 | Hvis ingen fejl er feltet tomt. |
KommuneKontakt | Xml-element | Nej |
Note 1:
Fejlkode | Fejltekst | Fejltype |
14 | Den unge findes ikke i Ungedatabasen | Hård fejl |
15 | Aldersgrænse er overskredet | Hård fejl |
18 | Ingen information at hente | Hård fejl |
84 | Ikke aktiv på institutionen | Hård fejl |
KommuneKontakt
Oplysninger om den unges eventuelle kontaktperson i den kommunale ungeindsats.
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
|---|---|---|---|---|
KommuneInstitutionNummer | Integer(6) | Ja | Kommunens institutionsnummer. | |
KommuneInstitutionNavn | String | Ja | Kommunens institutionsnavn. | |
KontaktNavn | String(500) | Ja | Kontaktpersonens navn. | |
KontaktMail | String(100) | Ja | Kontaktpersonens email-adresse. | |
KontaktTelefon | Integer | Nej | 10 cifre | Kontaktpersonens telefonnummer. |
KontaktRegistreringstid | DateTime | Ja | Tidspunktet for hvornår informationen er registreret i kommunen. Hvis OpdateringNyereEnd er angivet i input, vil der kun være data, hvis KontaktRegistreringstid er nyere end den angivne dato. |
Hent UddannelsesParathedsVurdering (UPV)
Denne webservice anvendes af uddannelsesinstitutioner ved afhentning af oplysninger om de unges UPV.
Struktur for HentUPVRequest
Figur 3. XML for forespørgsel på unges UPV.
HentUPVRequest
Der kan spørges på unges CPR-numre for at få at vide, om den unge er uddannelsesparat til hhv. gymnasium og HF, såfremt den unges UPV måtte mangle på institutionen, når den unge søger om optagelse.
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
|---|---|---|---|---|
InstitutionNummer | Integer (6) | Ja | Institutionsnummer fra den kaldende institution. | |
Elev | XML-element | Ja | Max 100 | En eller flere forekomster. Repræsenterer elever der ønskes oplysninger på om UPV. |
Elev
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
|---|---|---|---|---|
CPRNr | String (10) | Ja | CPR-nummer på den unge der ønskes UPV på. Der valideres på CPRnr og det returneres i ElevStatus sammen med efterspurgte data eller eventuel fejlkode og fejltekst. |
Struktur HentUPVSvar
Returnerer svar på forespørgsel om unges UPV.
Figur 4. XML for svar (HentUPVSvar).
HentUPVSvar
Såfremt der er spurgt om unges UddannelsesParathedsVurdering (UPV), returneres per unges UPV, eller en fejlkode per ung.
...
Vil forekomme, hvis der er spurgt om UPV data.
Felt | Type | Krævet | Beskrivelse |
ElevStatus (XML-struktur) | Xml-element | Ja | En forekomst for hvert CPRnr i ElevStatus angivet i input, hvis der er spurgt på en den unges UPV. |
ElevStatus
ElevStatus indeholder CPRnr fra input (Elev) og evt. Fejlkode, Fejltekst på den unge.
Der kan maksimalt spørges på 100 cpr-numre, hvis der forespørges på cpr-numre.
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
CPRNr | String (10) | Nej | CPR-nr for den unge. | |
FejlKode | Integer(10) | Nej | Se note 1 | Hvis ingen fejl er feltet tomt. |
FejlTekst | String | Nej | Se note 1 | Hvis ingen fejl er feltet tomt. |
UPV | Xml-element | Nej | Elementet oprettes, hvis der ingen fejl er. |
Note 1:
Fejlkode | Fejltekst | Fejltype |
5 | Ukendt institutionsnummer | Hård fejl |
14 | Den unge findes ikke i Ungedatabasen | Hård fejl |
18 | Ingen information at hente | Hård fejl |
UPV
Overordnet element for den enkelte unges UPV. De unges UPV er oprettet per klassetrin. Der kan kun forekomme UPV for 9. og 10. klasse.
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
|---|---|---|---|---|
Klassetrin | Integer | Ja | Klassetrin. Kun 9. og 10 klassetrin. | |
Omraade | Xml-element | Ja |
Omraade
For hvert klassetrin (9. og 10. klasse), hvor der foreligger en UPV, vil der være en vurdering per område.
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
|---|---|---|---|---|
OmraadeKode | String | Ja | Områdekoden kan være:
| |
VurderingsDato | DateTime | Ja | Dato for manuel vurdering, og hvis denne ikke er angivet, så dato for den automatiske vurdering. | |
Resultat | String | Ja | Se note 2. |
Note 2:
Resultat af UddannelsesParathedsVurderingen. Følgende værdier i Resultat er mulige:
Resultat | Parat? |
|---|---|
NOT_INTERESTED | Nej |
NOT_EVALUATED | Nej |
AUTOMATIC_NOT_READY | Nej |
AUTOMATIC_READY | Ja |
MANUAL_NOT_READY | Nej |
MANUAL_READY | Ja |
HentUddPaalaegRequest
Denne webservice anvendes af uddannelsesinstitutioner ved afhentning af oplysninger om unges eventuelle uddannelsespålæg. Den unge kan blive pålagt at gennemføre en uddannelse af jobcenteret.
...
Modtages der en besked om, at den unge har et uddannelsespålæg, skal institutionen kvittere med en kontaktperson eller team på institutionen. Denne information skal sendes ind med webservicen IndberetInstitutionKontakt. Flere detaljer om denne kan findes på https://viden.stil.dk/.
Struktur for HentUddPaalaegRequest
Figur 5. XML for HentUddPaalaeg.
HentUddPaalaegRequest
Uddannelsesinstitutionen kan spørge på, om en ung, der er optaget på institutionen, har et uddannelsespålæg.
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
|---|---|---|---|---|
InstitutionNummer | Integer (6) | Ja | Institutionsnummer fra den kaldende institution. | |
Elev | XML-element | Nej | Max 100 | Ingen, en eller flere forekomster. Repræsenterer elever der ønskes status på. Udfyldes feltet ikke, så spørges der på alle institutions aktive og tidligere aktive elever, der har eller har haft et uddannelsespålæg. |
Elev
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
|---|---|---|---|---|
CPRNr | String (10) | Ja | CPR-nummer på den unge, der ønskes svar på. Der valideres på CPRnr og det returneres i ElevStatus sammen med efterspurgte data eller eventuel fejlkode og fejltekst. |
Struktur for HentUddPaalaegSvar
Figur 6. XML for HentUddPaalaegSvar.
HentUddPaalaegSvar
Såfremt der er spurgt om unge har et uddannelsespålæg, returneres per ung om jobcenteret har givet den unge et uddannelsespålæg, eller en fejlkode per ung.
...
Elementet UddPaalaegDetaljer/JobcenterSpoergeSkema kan forekomme i svaret, hvis jobcentret har udfyldt denne information på det tidspunkt der efterspøges. Hvis det forekommer vil der for hvert element returneres SpoergsmaalsTekst og SpoergsmaalsSvar. Teksten, der returneres i SpoergsmaalsTekst skal vises til brugerne, således at de kan koble et givent svar til et spørgsmål.
Felt | Type | Krævet | Beskrivelse |
ElevStatus (XML-struktur) | Xml-element | Ja | En forekomst for hvert CPRnr i ElevStatus angivet i input, hvis der er spurgt på, om en ung har et uddannelsespålæg. |
ElevStatus
ElevStatus indeholder CPRnr fra input eller evt. Fejlkode samt Fejltekst per unge.
Der kan maksimalt spørges på 100 CPR-numre, hvis der forespørges på CPR-numre.
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
|---|---|---|---|---|
CPRNr | String (10) | Nej | CPR-nummer for den unge. | |
AktivUddPaalaeg | Boolean | Nej | Ja/nej til om der er et uddannelsespålæg på den unge. | |
FejlKode | Integer(10) | Nej | Se note 1 | Hvis ingen fejl er feltet tomt. |
FejlTekst | String | Nej | Se note 1 | Hvis ingen fejl er feltet tomt. |
UddPaalaegDetaljer | Xml-element | Nej | Elementet oprettes, hvis der ingen fejl er. | |
JobcenterKontakt | Xml-element | Nej | Indeholder jobcentrets kontaktperson for den unge. |
Note 1:
Fejlkode | Fejltekst | Fejltype |
5 | Ukendt institutionsnummer | Hård fejl |
14 | Den unge findes ikke i Ungedatabasen | Hård fejl |
18 | Ingen information at hente | Hård fejl |
84 | Ikke aktiv på institutionen | Hård fejl |
UddPaalaegDetaljer
Oplysninger om det jobcenter, som har givet uddannelsespålægget, samt hvornår uddannelsespålægget er givet, og hvilket trin af uddannelsespålægget den unge kom ind på, da uddannelsespålægget blev givet.
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
DatoUddPaalaegStart | DateTime | Nej | Startdato for uddannelsespålæg. | |
UddPaalaegTrinStart | Integer | Nej | 1-4 | Uddannelsespålægstrin. |
JobcenterNummer | Integer | Nej | 10000-99999 | Officielt nummer jobcenteret. Kan være en underafdeling. |
JobcenterNavn | String | Nej | Navn på jobcenteret. | |
JobcenterTelefon | Integer | Nej | 10 cifre | Telefonnummer på jobcenteret. |
JobcenterSpoergeSkema | XML-element | Nej | Indeholder jobcentrets angivelse af den unges støttebehov |
JobcenterSpoergeSkema
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
Behov | XML-element | Ja | Indeholder elementer omkring faglige og sociale støttebehov, hvorvidt der er dokumentation for støttebehov samt hvorvidt der ikke er støttebehov for en given ung. | |
StoettePerson | XML-element | Ja | Indeholder svar på, om der er tilknyttet en støtteperson på den unge. | |
KontaktOensket | XML-element | Ja | Indeholder svar på, om jobcentret ønsker at blive kontaktet af uddannelsesinstitutionen. | |
JobcenterTest | XML-element | Ja | Indeholder svar på, om der er udført en læse/skrive/regnetest på den unge. |
Under hver element vil der forekomme en række SpoergsmaalsTekst og dertilhørende SpoergsmaalsSvar. Teksten, der returneres i SpoergsmaalsTekst skal vises til brugerne, således at de kan koble et givent svar til et spørgsmål.
Behov
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
FagligStoettebehov | XML-element | Ja | Angiver om den unge har faglige støttebehov | |
SocialtStoettebehov | Xml-element | Ja | Angiver om den unge har sociale støttebehov | |
DokumenteretStoettebehov | Xml-element | Ja | Angiver om der er dokumentation for støttebehovene | |
IngenStoettebehov | Xml-element | Ja | Angiver om den unge ikke har nogen støttebehov |
FagligStoettebehov
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
SpoergsmaalsTekst | String(500) | Ja | Spørgsmålsteksten, som svaret skal kobles op på. | |
SpoergsmaalsSvar | Integer(2) | Ja | 1,2,3 | Angiver jobcentret svar på den angivne spørgsmålstekst. Svaret kan være enten 1,2,3 som har følgende betydning: |
SocialtStoettebehov
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
SpoergsmaalsTekst | String(500) | Ja | Spørgsmålsteksten, som svaret skal kobles op på. | |
SpoergsmaalsSvar | Integer(2) | Ja | 1,2,3 | Angiver jobcentret svar på den angivne spørgsmålstekst. Svaret kan være enten 1,2,3 som har følgende betydning: |
DokumenteretStoettebehov
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
|---|---|---|---|---|
SpoergsmaalsTekst | String(500) | Ja | Spørgsmålsteksten, som svaret skal kobles op på. | |
SpoergsmaalsSvar | Integer(2) | Ja | 1,2,3 | Angiver jobcentret svar på den angivne spørgsmålstekst. Svaret kan være enten 1,2,3 som har følgende betydning: |
IngenStoettebehov
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
SpoergsmaalsTekst | String(500) | Ja | Spørgsmålsteksten, som svaret skal kobles op på. | |
SpoergsmaalsSvar | Integer(2) | Ja | 1,2,3 | Angiver jobcentret svar på den angivne spørgsmålstekst. Svaret kan være enten 1,2,3 som har følgende betydning: |
StoettePerson
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
SpoergsmaalsTekst | String(500) | Ja | Spørgsmålsteksten, som svaret skal kobles op på. | |
SpoergsmaalsSvar | Boolean | Ja | True/False | Svaret på spørgsmålet kan enten være Ja (true) eller Nej (false) |
StoettepersonSlutDato | DateTime | Nej | Der kan være sat en slutdato for støttepersonen. Denne slutdato angiver hvornår en given støtteperson ikke mere er gyldig. |
KontaktOensket
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
SpoergsmaalsTekst | String(500) | Ja | Spørgsmålsteksten, som svaret skal kobles op på. | |
SpoergsmaalsSvar | Boolean | Ja | True/False | Svaret på spørgsmålet kan enten være Ja (true) eller Nej (false) |
JobcenterTest
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
SpoergsmaalsTekst | String(500) | Ja | Spørgsmålsteksten, som svaret skal kobles op på. | |
SpoergsmaalsSvar | Boolean | Ja | True/False | Svaret på spørgsmålet kan enten være Ja (true) eller Nej (false) |
JobcenterTestDato | DateTime | Nej | Angiver hvornår en eventuel test er foretaget. |
JobcenterKontakt
Elementet er ikke krævet, men hvis elementet er der, så skal de krævede felter herunder være udfyldt.
Felt | Type | Krævet | Lovlige værdier | Beskrivelse |
KontaktPerson | String(250) | Ja | Kontaktpersonens navn eller gruppe | |
KontaktTelefon | String(20) | Ja | Telefonnummeret på kontaktpersonen/gruppen. | |
KontaktMail | String(64) | Ja | Mail på kontaktpersonen/gruppen. | |
SlutDato | Datetime | Nej | Eventuel slutdato på kontaktpersonen. Denne slutdato angiver hvornår en given kontaktpersonen ikke mere er gyldig. |
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.
...