Borgerindsats.UdbAbonnementService (Version 1 [UDV], 2024-2)

Siden opdateres automatisk til at afspejle koden. CodeFirst.

UdbAbonnementService benyttes til at administrere en borgers abonnement hos UngeDatabasen, samt hente hændelser for borgeren.

Metoder

CreateUdbAbonnement

(Gl. 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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

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

Beskrivelse af cpr

CreateUdbAbonnementRequest

(CreateEducationEventSubscriptionRequest)

CreateUdbAbonnementRequestType

 

1

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

-    AbonnementStartDato

(SubscriptionStartDate)

dateTime

 

0 - 1

Tilmelding startdato. Default borgers 15 års fødselsdag

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateUdbAbonnementResponse

(CreateEducationEventSubscriptionResponse)

CreatedResponseType

 

1

Kvittering som indeholder den unikke identifikation for den oprettede entitet

-    CreatedItemIdentifier

(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

The specified citizen has no active plan

The specified citizen has no active plan

8060

Operation is not allowed when citizen has no active contact group

Operation is not allowed when citizen has no active contact group

8066

Subscription not possible. Citizen does not have an education plan

Subscription not possible. Citizen does not have an education plan

8067

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

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

8068

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

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

CancelUdbAbonnement

(Gl. CancelEducationEventSubscription)

Afbryder 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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

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

Beskrivelse af cpr

CancelUdbAbonnementRequest

(CancelEducationEventSubscriptionRequest)

CancelUdbAbonnementRequestType

 

1

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

-    Afbrudsaarsag

(EducationSubscriptionCancellationCause)

EducationSubscriptionCancellationCauseType

 

1

Afbrudsårsag.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

Tom response

(CancelEducationEventSubscriptionResponse)

 

 

 

 

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

The specified citizen has no active plan

The specified citizen has no active plan

8043

Wrong plantype

Cannot use service, wrong plantype

8060

Operation is not allowed when citizen has no active contact group

Operation is not allowed when citizen has no active contact group

8069

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

Subscription not possible. Citizen does not have an education event subscription

GetUddannelseshaendelser

(Gl. 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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

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

Beskrivelse af cpr

GetUddannelseshaendelserRequest

(GetEducationIncomingEventsRequest)

GetUddannelseshaendelserRequestType

 

1

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

-    Uddannelseskode

(EducationSourceCode)

string

 

0 - 1

Filtrering på en uddannelseskode

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

GetUddannelseshaendelserResponse

(GetEducationIncomingEventsResponse)

GetEducationIncomingEventsResponseType

 

1

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

-    UddannelseshaendelseTypeCollection

(EducationEventTypeCollection)

EducationEventTypeCollection

 

0 - 1

Liste af uddannelseshændelser.

-    -    UddannelseshaendelseType

(EducationEventType)

EducationEventType

 

0 - *

En uddannelseshændelse.

-    -    -    UddannelseshaendelseIdentifier

(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.

-    -    -    AfbrudsaarsagIdentifier

(CancellationCauseCodeIdentifier)

EducationEventCancellationCauseCodeTypeIdentifierType

 

0 - 1

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

-    -    -    CivilRegistrationIdentifier

(PersonCivilRegistrationIdentifier)

PersonCivilRegistrationIdentifierType
Base: 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)

CVRnumberIdentifierType
Base: string

Length: 8

1

Hovedafdelingens CVR-nummer.

-    -    -    UddannelsesStopAdvarselsDato

(EducationDropOutWarningDate)

date

 

0 - 1

Haendelsedato 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.

-    -    -    UddannelsesstedAdresse

(EducationLocationAddress)

string

MaxLength: 128

1

Vejnavn og nummer på institutionens adresse.

 

-    -    -    UddannelsesstedBetegnelse

(EducationLocationDesignation)

string

MaxLength: 128

1

Uddannelsesstedets betegnelse.

-    -    -    UddannelsesstedAfdeling

(InstitutionalCode)

int

 

1

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

-    -    -    UddannelsesstedPostnummer

(EducationLocationPostal)

string

MaxLength: 4

1

Postnummer på institutionens adresse.

-    -    -    UddannelsesstedNavn

(EducationLocationName)

string

MaxLength: 34

0 - 1

Stednavn på institutionens adresse.

-    -    -    Kontaktinformation

(ContactInformation)

string

 

0 - 1

Kontaktinformation.

-    -    -    Produktionsenhedsnummer

(ProductionUnitIdentifier)

ProduktionsenhedsnummerType
Base: string

Length: 10

0 - 1

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

-    -    -    RegistrationDateTime

(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).

-    -    -    UddannelseshaendelseStatusCodeTypeIdentifier

(EducationEventStatusCodeTypeIdentifier)

EducationEventStatusCodeTypeIdentifierType

 

1

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

-    -    -    ResponsIdentifier

(ResponseIdentifier)

string

MaxLength: 100

1

Unik id for selve hændelsen (indberetningen).

-    -    -    UddannelsesIdentifier

(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

(COSAFormaalVersion)

int

 

0 - 1

Kode for ungdomsuddannelse versioneret fra CØSA

-    -    -    COSAFormaalSpeciale

(COSAFormaalSpeciale)

string

 

0 - 1

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

-    -    -    UddannelsesNiveauIdentifier

(EducationLevelIdentifier)

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.

-    -    -    UddannelseshaendelseKursusIdentifier

(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.

-    -    -    UddannelseshaendelseTypeIdentifier

(EducationEventTypeIdentifier)

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)

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 is not allowed when citizen has no active contact group

Operation is not allowed when citizen has no active contact group