VisiteringOgStatus.YdelsesVisiteringService (Version 1 [UDV], 2025-1)

Siden opdateres automatisk til at afspejle koden. CodeFirst.

Servicen udstiller informationer om en borgers sociale ydelser.

Metoder

GetYdelse (GET /v1/ydelse/{ydelsesidentifier})

(gl. DFDG GetSocialAid)

Metoden henter informationer om en borgers sociale ydelser.

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

X

X

 

X

Kommune

 

X

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

VisiteringOgStatus.Ydelse.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

getYdelsesRequest

(GetSocialAidRequest)

GetYdelsesRequestDto

 

1

 

-    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

Borgerens personnummer.

ydelsesIdenfier [Path]

uuid

 

0 - 1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

getYdelsesResponse

(GetSocialAidResponse)

GetYdelsesResponseDto

 

1

 

-    ydelser

(GetSocialAidCollection)

YdelserDto

 

1

Borgeres ydelsesperioder fra ydelsessystem.

-    -    ydelse

(GetSocialAidType)

YdelseDto

 

0 - *

Konkrete ydelsesperiode

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

Borgerens cpr-nummer

-    -    -    kyYdelsesIdentifier

(KYSocialAidIdentifier)

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 nøgle på ydelsessagen i KY

-    -    -    startdato

(StartDate)

date

 

1

Startdato på ydelsesperioden. Hvis hændelsen er "Ydelsessag startet" så den forventet startdato.

-    -    -   slutdato 

(EndDate)

date

 

0 - 1

Slutdato på på ydelsesperioden.

-    -    -    kontaktgruppeType

(ContactGroupTypeIdentifier)

VisiteringOgStatus.KontaktgruppeTypeCodeList

(Gl. DFDG ContactGroupTypeIdentifierType)

 

0 - 1

Resultatet af afgørelsen om ydelse hvis positivt dvs. ydelse gives. Resultat angives i form af DFDG kontaktgruppe

- - - kyNoegle

String

Length: 1-100

0 -1

KY’s egen Brugervendt nøgle på begreb. Denne mappes til satsniveauType i DFDG

- - -    satsniveauType

SatsniveauTypeCodelist

 

 

0 - 1

Udfyldes vedr. ansøgninger om kontanthjælp.

Ikke udfyldt ved “Ydelsessag startet”. Angives ved alle andre statusser.

- - -    lovhenvisning

String

Length: 1-50

0 - 1

§-henvisning til Lov om aktiv socialpolitik. Udfyldes vedr. ansøgninger om kontanthjælpsydelser. Ikke udfyldt ved “Ydelsessag startet” og “Ydelsessag afsluttet”. Angives ved alle andre statusser.

-    -    -    registrendeMyndighed

(RegisteringAuthority)

RegistrendeMyndighedDto

 

0 - 1

Registrerende (myndighed) Kommune

-    -    -    -    organisationType

(OrganisationCode)

OrganisationTypeIdentifierType

MinInclusive: 1
MaxInclusive: 100

1

Kodeliste med organisationstype / myndighedstype

-    -    -    -    myndighedskode

(OrganisationTypeIdentifier)

string

Length: 1-20

1

Identifikation af organisation / myndighed

-    -    -    dfdgRegistreringsTidspunkt

(DFDGRegistrationDateTime)

dateTime

 

0 - 1

Registreringstidspunkt i DFDG

-    -    -    ydelsesAfgoerelsesType

(AppropriationOutcomeTypeIdentifier)

VisiteringOgStatus.YdelsesAfgoerelsesTypeKodeliste

(gl DFDG AppropriationOutcomeTypeIdentifierType)

 

0 - 1

Hændelse fra ydelse, enten at - Ydelsessag startet - Ydelse er givet - Ydelse er afvist - Ydelse stoppet - Ydelsessag afsluttet

-    -    -    ydelsesidentifier

(SocialAidIdentifier)

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 nøgle på ydelsessagen i DFDG

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1010

Unknown cpr

The submitted cpr is unknown to the system

1014

Failed to validate message

The submitted message could not be validated

4575

You are not authorized

You are not authorized to execute the operation

 

CreateYdelse (POST /v1/ydelse)

(Gl. SaveSocialAid)

Metoden opretter eller opdaterer en social ydelse for en borger så korrekt kontaktgruppe og personkategori sættes i DFDG.

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

Kommune

X

 

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

visiteringogstatus.ydelse.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

SaveSocialAidRequest

SaveSocialAidRequestType

 

1

 

-    ydelsesAfgoerelse

(SaveSocialAid)

YdelsesAfgoerelseDto

 

1

Validering af bevilling.

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

Borgerens cpr-nummer

-    -    kyYdelsesIdentifier (KYSocialAidIdentifier)

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 nøgle på ydelsessagen i KY

-    -    startdato

(StartDate)

date

 

1

Startdato på ydelsesperioden. Hvis hændelsen er "Ydelsessag startet" så den forventet startdato.

-    -    slutdato 

(EndDate)

date

 

0 - 1

Slutdato på ydelsesperioden.

-    -    kontaktgruppeType (ContactGroupTypeIdentifier)

VisiteringOgStatus.KontaktgruppeTypeCodeList

Gl- DFDG ContactGroupTypeIdentifierType

 

0 - 1

Resultatet af afgørelsen om ydelse hvis positivt dvs. ydelse gives. Resultat angives i form af DFDG kontaktgruppe

-    -    ydelsesAfgoerelsesType (AppropriationOutcomeTypeIdentifier)

VisiteringOgStatus.YdelsesAfgoerelsesTypeKodeliste

(gl DFDG AppropriationOutcomeTypeIdentifierType)

 

0 - 1

Hændelse fra ydelse, enten at - Ydelsessag startet - Ydelse er givet - Ydelse er afvist - Ydelse stoppet - Ydelsessag afsluttet

- - kyNoegle

String

Length: 1-100

0 -1

KY egen Brugervendt nøgle på begreb, Denne mappes til satsniveauType i DFDG

- -    lovhenvisning

String

Length: 1-50

0 - 1

§-henvisning til Lov om aktiv socialpolitik. Udfyldes vedr. ansøgninger om kontanthjælpsydelser. Ikke udfyldt ved “Ydelsessag startet” og “Ydelsessag afsluttet”. Angives ved alle andre statusser.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

SaveSocialAidResponse

SaveSocialAidResponseType

 

1

 

-    ServiceReceipt

ServiceReceiptType

 

1

kvittering for transaktionen.

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

-    ydelsesidentifier

(SocialAidIdentifier)

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 nøgle på ydelsessagen i DFDG

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1010

Unknown cpr

The submitted cpr is unknown to the system

1014

Failed to validate message

The submitted message could not be validated

4575

You are not authorized

You are not authorized to execute the operation

4669

The enddate must not be earlier than the start date

The enddate must not be earlier than the start date

9229

Den angivne identifier tilhører ikke den specifikke person

The submitted identifier does not belong to the specified person

Den angivet identifier tilhøre ikke den specifikke person

The submitted identifier does not belong to the specified person

9392

Denne type af ydelse er ikke lovlig

The type of social aid is not allowed

Denne type af ydelse er ikke lovlig

The type of social aid is not allowed

9393

Slutdato for ydelsen er obligatorisk når ydelsen afsluttes

The end date of social aid is mandatory, when a social aid is terminated

Slutdato for ydelsen er obligatorisk når ydelsen afsluttes

The end date of social aid is mandatory, when a social aid is terminated

1000xx

Lovhenvisning skal være angivet ved afgørelser om KTH med startdato 1.7.2025 eller senere

Paragrafhenvisning skal være angivet ved afgørelser om KTH med startdato 1.7.2025 eller senere

1000xx

kyNoegle skal være angivet ved afgørelser om KTH med startdato 1.7.2025 eller senere

kyNoegle skal være angivet ved afgørelser om KTH med startdato 1.7.2025 eller senere

GetYdelse (GET /v1/ydelse/historik)

(Gl. DFDG GetSocialAidHistory)

Metoden henter historiske sociale ydelse 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

X

X

 

X

Kommune

 

X

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

VisiteringOgStatus.Ydelse.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

getYdelsesHistorikRequest

(GetSocialAidHistoryRequest)

GetYdelsesHistorikRequestDto

 

1

 

-    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

Borgerens personnummer.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

getYdelsesHistorikResponse

GetSocialAidHistoryResponse

GetYdelsesHistorikResponseDto

 

1

 

-    ydelser

(GetSocialAidHistoryCollection)

YdelserDto

 

1

Borgeres historiske ydelsesperioder fra ydelsessystem.

-    -    ydelse

(GetSocialAidHistoryType)

YdelseDto

 

0 - *

Konkrete ydelsesperiode

-    -    -    BaseType

GetSocialAidHistoryMetaDataType

 

1

 

-    -    -    -    RegistrerendeSagsbehandler

(RegistrationMetadata)

RegistrationMetadataType

 

1

Registrerende bruger og dennes organisation (som ved fx Anden Aktør kan være forskellig fra ovenfor)

-    -    -    -    -    registrendeMyndighed

(RegisteringAuthority)

ActiveOrganisationHeaderType

 

0 - 1

Den myndighed som der er registreret på vegne af (v/ AA: som brugeren har impersonated)

-    -    -    -    -    -    organisationType

(OrganisationCode)

OrganisationTypeIdentifierType

MinInclusive: 1
MaxInclusive: 100

1

Kodeliste med organisationstype / myndighedstype

-    -    -    -    -    -    myndighedskode

(OrganisationTypeIdentifier)

string

Length: 1-20

1

Identifikation af organisation / myndighed

-    -    -    -    -    sagsbehandler

(RegisteringUser)

SagsbehandlerDto

 

0 - 1

Registrerende bruger og dennes organisation (som ved fx Anden Aktør vil være forskellig fra RegisteringAuthority)

-    -    -    -    -    -    RequestUserStructure

RequestUserStructureType

 

1

Information om den kaldende bruger.

-    -    -    -    -    -    -    navn

UserFullName

string

Length: 1-140

1

Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.

-    -    -    -    -    -    -    brugertype

(RequestUserTypeIdentifier)

RequestUserTypeIdentifierType

 

1

Brugertype

-    -    -    -    -    -    -    brugeridentifier

(UserIdentifier)

UserIdentifierType
Base: string

Length: 1-255

1

Unik identifikation af brugeren, f.eks. en GUID, et medarbejder ID, system ID, bruger ID, certifikat ID, cpr-nummer, email (hvis den er unik) o.l.

-    -    -    -    -    -    -    email

(UserEmail)

EmailAddressIdentifierType
Base: string

Pattern: ([^>\(\)\[\]\\,;:@\s]{0,191}@[^>\(\)\[\]\\,;:@\s]{1,64})

0 - 1

Brugers e-mail.

-    -    -    -    -    -    registrendeMyndighed

(RequestOrganisationStructure)

RequestOrganisationStructureType

 

1

Den organisation som registrerende bruger tilhører.

-    -    -    -    -    -    -    organisationType

(OrganisationCode)

OrganisationTypeIdentifierType

 

1

Kodeliste med organisationstype / myndighedstype for registrerende bruger.

-    -    -    -    -    -    -    myndighedskode

(OrganisationTypeIdentifier)

string

Pattern: [-][1]|[0-9]{1,8}

1

Organisationskode for den registrerende bruger.

-    -    -    -    -    -    registreringstidspunkt

(RegistrationDateTime)

dateTime

 

1

Kaldende systems registreringstidspunkt.

-    -    -    -    -    berigtigelseskommentar

(CorrectionComment)

string

 

0 - 1

Kommentar til ændring

-    -    -    -    -    registreringstidspunkt

(RegistrationDateTime)

dateTime

 

0 - 1

Registreringstidspunkt

-    -    -    PersonCivilRegistrationIdentifier

(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

Borgerens cpr-nummer

-    -    -    kyYdelsesIdentifier (KYSocialAidIdentifier)

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 nøgle på ydelsessagen i KY

-    -    -    startdato

(StartDate)

date

 

1

Startdato på ydelsesperioden. Hvis hændelsen er "Ydelsessag startet" så den forventet startdato.

-    -    -    slutdato 

(EndDate)

date

 

0 - 1

Slutdato på på ydelsesperioden.

-    -    -    kontaktgruppeType (ContactGroupTypeIdentifier)

VisiteringOgStatus.KontaktgruppeTypeCodeList

(Gl. DFDG ContactGroupTypeIdentifierType)

 

0 - 1

Resultatet af afgørelsen om ydelse hvis positivt dvs. ydelse gives. Resultat angives i form af DFDG kontaktgruppe

- - - kyNoegle

String

Length: 1-100

0 -1

KY egen Brugervendt nøgle på begreb. Denne mappes til satsniveauType i DFDG

- - -    satsniveauType

SatsniveauTypeCodelist

 

 

0 - 1

Udfyldes vedr. ansøgninger om kontanthjælp.

Ikke udfyldt ved “Ydelsessag startet”. Angives ved alle andre statusser.

- - -    lovhenvisning

String

Length: 1-50

0 - 1

Udfyldes vedr. ansøgninger om kontanthjælp.

Ikke udfyldt ved “Ydelsessag startet”og “Ydelsessag afsluttet”. Angives ved alle andre statusser.

-    -    -    klientkategori

(ClientCategoryTypeIdentifier)

https://starwiki.atlassian.net/wiki/pages/createpage.action?spaceKey=FYS&title=VisiteringOgStatus.ClientCategoryTypeCodeList&linkCreation=true&fromPageId=4388421815

(Gl. DFDG ClientCategoryTypeIdentifierType)

 

0 - 1

Resultatet af afgørelsen om ydelse hvis positivt dvs. ydelse gives. Resultat angives i form af DFDG klientkategori

-    -    -    dfdgRegistreringsTidspunkt

(DFDGRegistrationDateTime)

dateTime

 

0 - 1

Registreringstidspunkt i DFDG

-    -    -    ydelsesAfgoerelsesType (AppropriationOutcomeTypeIdentifier)

VisiteringOgStatus.YdelsesAfgoerelsesTypeKodeliste

(gl DFDG AppropriationOutcomeTypeIdentifierType)

 

0 - 1

Hændelse fra ydelse, enten at - Ydelsessag startet - Ydelse er givet - Ydelse er afvist - Ydelse stoppet - Ydelsessag afsluttet

-    -    -    ydelsesidentifier

(SocialAidIdentifier)

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 nøgle på ydelsessagen i DFDG

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1010

Unknown cpr

The submitted cpr is unknown to the system

1014

Failed to validate message

The submitted message could not be validated