Borgerindsats.UngedataService (Version1 [UDV], 2025-2)

Siden er opdateret af FA i forbindelse med udvikling.

Service benyttes til at administrere en borgers abonnement hos UngeDatabasen (UDB), samt hente hændelser for borgeren fra UDB.

Metoder

 

CreateUDBabonnement (POST /v1/UDBabonnement)

(Gl. DFDG CreateEducationEventSubscription)

Opretter et abonnement for borger, hvorefter DFDG efterfølgende modtager uddannelseshændelser.

Tilladte organisationer

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

Anden Aktør - alle borgere

System - alle borgere

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

Anden Aktør - alle borgere

System - alle borgere

JobCenter

 

X

 

 

X

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.udb.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateUDBabonnementRequest

(CreateEducationEventSubscriptionRequest)

CreateUDBabonnementRequestDto

 

1

En forespørgsel vedr. oprettelsen af en borgeres abonnement.

-    x-civilregistrationIdentifier [Header]

(PersonCivilRegistrationIdentifier)

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

CPR-nummer.

-    abonnementsstarttidspunkt

(SubscriptionStartDate)

dateTime

 

0 - 1

Tilmelding startdato. Default borgers 15 års fødselsdag

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

Tomt

 

 

 

 

CreateEducationEventSubscriptionResponse

CreatedResponseType

 

1

Kvittering som indeholder den unikke identifikation for den oprettede entitet

-    CreatedItemIdentifier

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

0 - 1

Unik identifikation for den oprettede entitet.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1001

Invalid cpr

The submitted cpr is either to long or short or contains data not interpretable as a date

4013

Unknown Client Destination

Unknown Client Destination

8002

Den angivne borgere har ikke en aktiv plan

(The specified citizen has no active plan)

Den angivne borgere har ikke en aktiv plan

(The specified citizen has no active plan)

8060

Operation ikke lovlig da borger ikke har en aktiv kontaktgruppe

(Operation is not allowed when citizen has no active contact group)

Operation ikke lovlig da borger ikke har en aktiv kontaktgruppe

(Operation is not allowed when citizen has no active contact group)

8066

Abonnement er ikke mulig da borger ikke har en uddannelsesplan

(Subscription not possible. Citizen does not have an education plan)

Abonnement er ikke mulig da borger ikke har en uddannelsesplan

(Subscription not possible. Citizen does not have an education plan)

8067

Abonnement er ikke mulig da borger ikke under 30 år

(Subscription not possible. Citizen has to be under 30 years old)

Abonnement er ikke mulig da borger ikke under 30 år

(Subscription not possible. Citizen has to be under 30 years old)

8068

Abonnement er ikke mulig da borger ikke har en aktiv kontaktgruppe

(Subscription not possible. Citizen does not have an active contact group)

Abonnement er ikke mulig da borger ikke har en aktiv kontaktgruppe

(Subscription not possible. Citizen does not have an active contact group)

UpdateUDBabonnement (PUT /v1/UDBabonnement/Luk)

(Gl. DFDG CancelEducationEventSubscription)

Lukker en borgers abonnement hos UngeDatabasen.

Tilladte organisationer

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

Anden Aktør - alle borgere

System - alle borgere

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

Anden Aktør - alle borgere

System - alle borgere

JobCenter

 

X

 

 

X

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.udb.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

updateUDBabonnementRequest

(CancelEducationEventSubscriptionRequest)

updateUDBabonnementRequestDto

 

1

En forespørgsel vedr. en afbrydelse af en borgeres abonnement.

-    x-civilregistrationIdentifier [Header]

(PersonCivilRegistrationIdentifier)

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

CPR-nummer.

-     abonnementOphoersAarsagType

(EducationSubscriptionCancellationCause)

Borgerindsats.AbonnementOphoersAarsagTypeCodeList

(gl DFDG EducationSubscriptionCancellationCauseType)

 

1

Ophørsårsag.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

Tomt

 

 

 

 

CancelEducationEventSubscriptionResponse

EmptyResponseType

 

1

Tom kvittering

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1001

Invalid cpr

The submitted cpr is either to long or short or contains data not interpretable as a date

4013

Unknown Client Destination

Unknown Client Destination

8002

Den angivne borgere har ikke en aktiv plan

(The specified citizen has no active plan)

Den angivne borgere har ikke en aktiv plan

(The specified citizen has no active plan)

8043

Borger har ikke den korrekte plantype

(Wrong plantype)

Borger har ikke den korrekte plantype

(Wrong plantype)

8060

Operation ikke lovlig da borger ikke har en aktiv kontaktgruppe

(Operation is not allowed when citizen has no active contact group)

Operation ikke lovlig da borger ikke har en aktiv kontaktgruppe

(Operation is not allowed when citizen has no active contact group)

8069

Lukning af abonnement ikke mulig, da borger ikke har et eksisterende abonnement

(Cancel subscription is not possible. Citizen does not have an education event subscription)

Lukning af abonnement ikke mulig, da borger ikke har et eksisterende abonnement

(Cancel subscription is not possible. Citizen does not have an education event subscription)

GetUDBabonnement (GET /v1/UDBabonnement/{})

Obs GetEducationEventSubscription Fra PSS

Metode der henter borgers UDB abonnement

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

getUDBAbonnementRequest

GetUDBAbonnementRequestDto

 

1

En forespørgsel vedr. borger aktuelle abonnement.

- x-civilregistrationIdentifier [Header] (PersonCivilRegistrationIdentifier)

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

CPR-nummer.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

getUDBAbonnementResponce

GetUDBAbonnementResponceDto

 

1

Abonnementer på uddannelseshændelser fra uddannelsesinstitutioner. Kun aktuel status.

-    harAbonnement

(IsSubscriber)

boolean

 

1

Angiver om borgeren er tilmeldt Ungedatabasen (UDB)

-    abonnementsstarttidspunkt

(SubscriptionStartDate)

dateTime

 

0 - 1

Angiver startdatoen for hvornår DFDG ønsker at modtage hændelser fra UDB

-    dfdgRegistreringstidspunkt

(SubscribeRegistrationDate)

dateTime

 

0 - 1

Angiver tidspunktet, hvor DFDG har registreret tilmelding til UDB

-    udbRegistreringstidspunkt

(UdbSubscribeDate)

dateTime

 

0 - 1

Angiver det tidspunkt, hvor borgeren rent faktisk er blevet tilmeldt UDB. Dette sker i et asynkront kald, hvorfor der typisk vil være forskel på dfdgregistreringstidspunkt og udbregistreringstidspunkt

-    dfdgAfregistreringstidspunkt

(UnsubscribeRegistrationDate)

dateTime

 

0 - 1

Angiver tidspunktet, hvor DFDG har registreret en afmelding fra UDB

-    Afregistreringstidspunkt

(UdbUnsubscribeDate)

dateTime

 

0 - 1

Angiver det faktiske tidspunkt, hvor afmeldingen fra UDB har fundet sted

- abonnementOphoersAarsagType

(SubscriptionCancellationCauseIdentifier)

Borgerindsats.AbonnementOphoersAarsagTypeCodeList

(gl DFDG EducationSubscriptionCancellationCauseType)

 

0 - 1

Angiver årsagen til ophør.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1001

Invalid cpr

The submitted cpr is either to long or short or contains data not interpretable as a date

4013

Unknown Client Destination

Unknown Client Destination

GetUddannelseshaendelser (GET /v1/UDBabonnement/{})

(Gl. DFDG GetEducationIncomingEvents)

Henter en liste af uddannelseshændelser for en borger.

Tilladte organisationer

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

Anden Aktør - alle borgere

System - alle borgere

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

Anden Aktør - alle borgere

System - alle borgere

JobCenter

 

X

 

 

X

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.udb.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

getUddannelseshaendelserRequest

GetUddannelseshaendelserRequestDto

 

1

En forespørgsel vedr. afhentning af hændelser på en borger.

-    x-civilregistrationIdentifier [Header] (PersonCivilRegistrationIdentifier)

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

CPR-nummer.

-    uddannelseskode

(EducationSourceCode)

string

 

0 - 1

Filtrering på en uddannelseskode

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

getUddannelseshaendelseResponse

GetUddannelseshaendelseResponseDto

 

1

Et svar som indeholder uddannelseshændelser på en borger.

-    uddannelseshaendelser

(EducationEventTypeCollection)

UddannelseshaendelserDto

 

0 - 1

Liste af uddannelseshændelser.

-    -    uddannelseshaendelse

(EducationEventType)

UddannelseshaendelseDto

 

0 - *

En uddannelseshændelse.

-    -    -    udannelseshaendelsenIdentifier

(EventIdentifier)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Unikt id på udannelseshændelsen.

-    -    -    uddannelsesafbrydelsesaarsag

(CancellationCauseCodeIdentifier)

Borgerindsats.UddannelsesafbrydelsesaarsagTypeCodeList

(Gl. DFDG EducationEventCancellationCauseCodeTypeIdentifierType)

 

0 - 1

Kode for årsagen til afbruddet af forløbet eller aktiviteten. Feltet skal udfyldes, hvis den indberettede status er afbrudt.

-    -    -    x-civilregistrationIdentifier

(PersonCivilRegistrationIdentifier)

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Cpr-nummer på den unge, som indberetningen vedrører.

-    -    -    cvrEnhedsid

(CVRnumberIdentifier)

string

Length: 8

1

Hovedafdelingens CVR-nummer.

-    -    -    frafaldstruetdato

(EducationDropOutWarningDate)

date

 

0 - 1

Hændelsedato hvis FrafaldstruetMarkering = true ellers NULL.

-    -    -    haendelsesdato

(EventDate)

date

 

1

Dato, hvor hændelsen indtræffer. Fx startdato på en uddannelse ved optagelse, datoen for afbrud af uddannelse, gennemførelse eller dato for risiko for frafald.

-    -    -    institutionensadresse

(EducationLocationAddress)

string

MaxLength: 128

1

Vejnavn og nummer på institutionens adresse.

-    -    -    institutionensbetegnelse

(EducationLocationDesignation)

string

MaxLength: 128

1

Uddannelsesstedets betegnelse.

-    -    -    institutionensnummer

(InstitutionalCode)

int

 

1

Afdeling hvor undervisningen eller aktiviteten administreres. UDB anvender værdien fra institutionsregisteret.

-    -    -    postnummer

(EducationLocationPostal)

string

MaxLength: 4

1

Postnummer på institutionens adresse.

-    -    -    stednavn

(EducationLocationName)

string

MaxLength: 34

0 - 1

Stednavn på institutionens adresse.

-    -    -    kontaktinformation

(ContactInformation)

string

 

0 - 1

Kontaktinformation.

-    -    -    pNummer

(ProductionUnitIdentifier)

string

Length: 10

0 - 1

Produktionsenhedsnummer for DS-afdelingen hvor den unge undervises ifølge Institutionsregisteret.

-    -    -    registreringstidspunkt

(RegistrationDateTime)

dateTime

 

1

Tidspunkt for registrering af tilstanden eller ændringen i kildesystemet.

-    -    -    startdato

(StartDate)

date

 

0 - 1

Startdato (hvis optaget).

-    -    -    slutdato

(EndDate)

date

 

0 - 1

Slutdato (hvis gennemført eller afbrudt).

-    -    -    udannelsesforloebsstatus

(EducationEventStatusCodeTypeIdentifier)

Borgerindsats.UddannelsesForloebstatusTypeCodeList

(Gl. DFDG EducationEventStatusCodeTypeIdentifierType)

 

1

En kode, som beskriver status for den unges uddannelsesforløb (optaget, afbrud og gennemført).

-    -    -  haendelsesidentifier  

(ResponseIdentifier)

string

MaxLength: 100

1

Unik id for selve hændelsen (indberetningen).

-    -    -    betengelses

(EducationDesignation)

string

MaxLength: 100

1

Tekstuel betegnelse for uddannelsen. Kan indeholde betegnelser fra forskellige kodesæt: CØSA-formål (Lectio, Ludus, EASY), STADS, Aktivitetsgruppe koder (SIS), Politiet, Forsvaret og Beredskabsstyrelsen.

-    -    -    uddannelseskode

(EducationSourceCode)

string

MaxLength: 10

1

Uddannelseskode.

-    -    -    COSAFormaalVersion

int

 

0 - 1

Kode for ungdomsuddannelse versioneret fra CØSA

-    -    -    COSAFormaalSpeciale

string

 

0 - 1

Kode for ungdomsuddannelse (EUD) fra CØSA. Koden angiver hvilket speciale, der følges indenfor uddannelsen.

-    -    -    uddannelsesniveau

(EducationLevelIdentifier)

Borgerindsats.UddannelsesniveauTypeCodeListe

(Gl. DFDG EducationLevelIdentifierType)

 

1

Niveauet angiver om uddannelsen er hoved- eller grundforløb på en erhvervsuddannelse. For alle andre uddannelser end erhvervsuddannelserne, sidestilles disse med erhvervsskolernes hovedforløb.

-    -    -    uddannelsesforloebsIdentifier

(EducationEventCourseId)

string

MaxLength: 100

0 - 1

En entydig identifikation af forløbet, som hændelsen er blevet tilknyttet i UDB. Udfyldt for alle nye hændelser.

-    -    -    note

(Note)

string

MaxLength: 2000

0 - 1

En tekst der uddyber nogle hændelser bla. annullering så det er muligt at se hvilken hændelse der annulleres.

-    -    -    uddannelseshaendelsesType

(EducationEventTypeIdentifier)

Borgerindsats.UddannelseshaendelsesTypeCodeListe

(Gl DFDG EducationEventTypeIdentifierType)

 

1

Kodeliste der angiver hvilken type hændelse der er modtaget fra STIL. Denne Hændelse er beregnet på baggrund af de øvrige felter i hændelsen.

-    -    -    afsluttetUddannelsesNiveau

(AfsluttetUddannelsesNiveau)

Borgerindsats.AfsluttetUddannelsesNiveauTypeCodeListe

(Gl. DFDG AfsluttetUddannelsesNiveauTypeIdentifierType)

 

0 - 1

Statusfelt, der oplyser, hvilket højeste uddannelsesniveau den unge har afsluttet.

-    -    -    eguUddannelsesbevis

(EguUddannelsesbevis)

boolean

 

0 - 1

Afsluttet FGU-uddannelsen. Sand, hvis den unge har afsluttet FGU-uddannelsen på sporet EGU, og har fået et uddannelsesbevis på det.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1001

Invalid cpr

The submitted cpr is either to long or short or contains data not interpretable as a date

4013

Unknown Client Destination

Unknown Client Destination

8060

Operation ikke lovlig da borger ikke har en aktiv kontaktgruppe

(Operation is not allowed when citizen has no active contact group)

Operation ikke lovlig da borger ikke har en aktiv kontaktgruppe

(Operation is not allowed when citizen has no active contact group