EducationEventService (Version 4, [UDV] 2023-1)

Siden opdateres automatisk til at afspejle koden. CodeFirst.

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

Metoder

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

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

JobCenter

 

X

 

 

X

 

STAR

X

 

 

 

 

 

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateEducationEventSubscriptionRequest

CreateEducationEventSubscriptionRequestType

 

1

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

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

-    SubscriptionStartDate

dateTime

 

0 - 1

Tilmelding startdato.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateEducationEventSubscriptionResponse

CreatedResponseType

 

1

 

- CreatedItemIdentifier

guid

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

1

Unik identifikation for den oprettede entitet.

CreateEducationEventSubscriptionResponse

CreateEducationEventSubscriptionResponseType

 

1

Et svar som indeholder en kvittering fra servicen.

-    ServiceReceipt

ServiceReceiptType

 

1

Kvittering som indeholder id og hændelsesdato.

-    -    MessageIdentifier

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

Unik identifikation af transaktion eller registrering.

-    -    EventDate

dateTime

 

1

Tidspunkt for transaktionen eller registrering.

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

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

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

JobCenter

 

X

 

 

X

 

STAR

X

 

 

 

 

 

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CancelEducationEventSubscriptionRequest

CancelEducationEventSubscriptionRequestType

 

1

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

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

-    EducationSubscriptionCancellationCause

EducationSubscriptionCancellationCauseType

 

1

Afbrudsårsag.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CancelEducationEventSubscriptionResponse

EmptyResponseType

 

1

 

CancelEducationEventSubscriptionResponse

CancelEducationEventSubscriptionResponseType

 

1

Et svar som indeholder en kvittering fra servicen.

-    ServiceReceipt

ServiceReceiptType

 

1

Kvittering som indeholder id og hændelsesdato.

-    -    MessageIdentifier

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

Unik identifikation af transaktion eller registrering.

-    -    EventDate

dateTime

 

1

Tidspunkt for transaktionen eller registrering.

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

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

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

JobCenter

 

X

 

 

X

 

STAR

X

 

 

 

 

 

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

GetEducationIncomingEventsRequest

GetEducationIncomingEventsRequestType

 

1

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

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

- EducationSourceCode

string

MaxLength: 10

0 - 1

Filtrering på en uddannelseskode

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

GetEducationIncomingEventsResponse

GetEducationIncomingEventsResponseType

 

1

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

-    EducationEventTypeCollection

EducationEventTypeCollection

 

0 - 1

Liste af uddannelseshændelser.

-    -    EducationEventType

EducationEventType

 

0 - *

En uddannelseshændelse.

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

(HaendelseNummer)

-    -    -    CancellationCauseCodeIdentifier

EducationEventCancellationCauseCodeTypeIdentifierType

 

0 - 1

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

(AfbrudsaarsagsKode)

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

(CPRNr)

-    -    -    CVRnumberIdentifier

CVRnumberIdentifierType
Base: string

Length: 8

1

Hovedafdelingens CVR-nummer.

(InstitutionCVRnummer)

-    -    -    EducationDropOutWarningDate

date

 

0 - 1

Haendelsedato hvis FrafaldstruetMarkering = true ellers NULL.

(FrafaldstruetMarkering)

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

(HaendelseDato)

-    -    -    EducationLocationAddress

string

MaxLength: 128

1

Vejnavn og nummer på institutionens adresse.

(InstitutionsAdresse)

-    -    -    EducationLocationDesignation

string

MaxLength: 128

1

Uddannelsesstedets betegnelse.

(InstitutionBetegnelse)

-    -    -    InstitutionalCode

int

 

1

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

(Institutionnummer)

-    -    -    EducationLocationPostal

string

MaxLength: 4

1

Postnummer på institutionens adresse.

(Institutionpostnummer)

-    -    -    EducationLocationName

string

MaxLength: 34

0 - 1

Stednavn på institutionens adresse.

(Institutionsstednavn)

-    -    -    ContactInformation

string

 

0 - 1

Kontaktinformation.

(Navn, Telefon, Email)

-    -    -    ProductionUnitIdentifier

ProductionUnitIdentifierType
Base: string

Length: 10

0 - 1

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

(InstitutionPnummer)

-    -    -    RegistrationDateTime

dateTime

 

1

Tidspunkt for registrering af tilstanden eller ændringen i kildesystemet.

(Registreringstid)

-    -    -    StartDate

date

 

0 - 1

Startdato (hvis optaget).

(HaendelseDato)

-    -    -    EndDate

date

 

0 - 1

Slutdato (hvis gennemført eller afbrudt).

(HaendelseDato)

-    -    -    EducationEventStatusCodeTypeIdentifier

EducationEventStatusCodeTypeIdentifierType

 

1

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

(Status)

-    -    -    ResponseIdentifier

string

MaxLength: 100

1

Unik id for selve hændelsen (indberetningen).

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

(UddannelseBetegnelse)

-    -    -    EducationSourceCode

string

MaxLength: 10

1

Uddannelseskode.

(UddannelseKode)

COSAFormaalVersion

integer

 

0 - 1

Kode for ungdomsuddannelse versioneret fra CØSA

COSAformaalSpeciale

string

MaxLength: 4

0 - 1

Kode for ungdomsuddannelse (EUD) fra CØSA.

Koden angiver hvilket speciale, der følges indenfor uddannelsen.

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

(Hovedforloeb)

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

(ForloebId)

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

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

(ForloebStatus)

-    -    -   afsluttetUddannelsesNiveau

string

MaxLength: 100

0 - 1

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

(AfsluttetUddannelsesNiveau)

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

(EguUddannelsesbevis)

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