Sidehistorik
...
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. |
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. | Markering af, om der findes flere svar end dem, der er returneret i det aktuelle svar. |
HoejesteHaendelseNummer | String | Nej | Indeholder det højeste hændelsesnummer, der er returneret i et svar. | |
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.
...