VisiteringOgStatus.YdelsesVisiteringService (Version 1, 2025-1)

JobCenter

Kommune

STAR

x-civilregistrationIdentifier [Header]

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

x-requestId [Header]

string

1

Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

requestBody

SaveYdelseRequestDto

1

Requesttype

-    kyYdelsesIdentifier

uuid

1

Unik nøgle på ydelsessagen i KY

-    startdato

date

1

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

-    slutdato

date

0 - 1

Slutdato på på ydelsesperioden.

-    kontaktgruppe

KontaktgruppeTypeCodeList

0 - 1

-    kyNoegle

string

Length: 1-100

0 - 1

KY’s 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.

-    ydelsesAfgoerelsesType

YdelsesAfgoerelsesTypeCodeList

0 - 1

4669

Slutdatoen må ikke ligge før startdatoen

Slutdatoen må ikke ligge før startdatoen

9393

Slutdato for ydelsen er obligatorisk når ydelsen afsluttes

Slutdato for ydelsen er obligatorisk når ydelsen afsluttes

100054

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

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

100050

KY nøgle skal være angivet ved afgørelser om KTH (kontaktgruppe 2) med startdato 1.7.2025 eller senere

KY nøgle skal være angivet ved afgørelser om KTH (kontaktgruppe 2) med startdato 1.7.2025 eller senere

100051

Den angivne identifier tilhører ikke den specifikke person

Den angivne identifier tilhører ikke den specifikke person

100052

Denne type af ydelse er ikke lovlig

Denne type af ydelse er ikke lovlig

JobCenter

Kommune

STAR

x-civilregistrationIdentifier [Header]

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

response

GetYdelserResponseDto

1

Returtype

-    ydelser

YdelseDtoCollection

1

Borgeres ydelsesperioder fra ydelsessystem.

-    -    YdelseDto

YdelseDto

0 - *

-    -    -    kyYdelsesIdentifier

uuid

1

Unik nøgle på ydelsessagen i KY

-    -    -    startdato

date

1

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

-    -    -    slutdato

date

0 - 1

Slutdato på på ydelsesperioden.

-    -    -    kontaktgruppe

KontaktgruppeTypeCodeList

0 - 1

-    -    -    kyNoegle

string

Length: 1-100

0 - 1

KY’s 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.

-    -    -    ydelsesAfgoerelsesType

YdelsesAfgoerelsesTypeCodeList

0 - 1

-    -    -    satsniveau

SatsniveauTypeCodeList

0 - 1

-    -    -    registrendeMyndighed

RegistrendeMyndighedDto

0 - 1

Registrerende myndighed

-    -    -    -    organisationType

OrganisationTypeCodeList

1

-    -    -    -    myndighedskode

string

Length: 1-20

1

Identifikation af organisation / myndighed.

-    -    -    dfdgRegistreringsTidspunkt

date-time

0 - 1

Registreringstidspunkt i DFDG

JobCenter

Kommune

STAR

x-civilregistrationIdentifier [Header]

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

ydelsesidentifier [Path]

uuid

1

response

GetYdelseResponseDto

1

Returtype

-    ydelse

YdelseDto

1

Kommunal ydelse

-    -    kyYdelsesIdentifier

uuid

1

Unik nøgle på ydelsessagen i KY

-    -    startdato

date

1

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

-    -    slutdato

date

0 - 1

Slutdato på på ydelsesperioden.

-    -    kontaktgruppe

KontaktgruppeTypeCodeList

0 - 1

-    -    kyNoegle

string

Length: 1-100

0 - 1

KY’s 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.

-    -    ydelsesAfgoerelsesType

YdelsesAfgoerelsesTypeCodeList

0 - 1

-    -    satsniveau

SatsniveauTypeCodeList

0 - 1

-    -    registrendeMyndighed

RegistrendeMyndighedDto

0 - 1

Registrerende myndighed

-    -    -    organisationType

OrganisationTypeCodeList

1

-    -    -    myndighedskode

string

Length: 1-20

1

Identifikation af organisation / myndighed.

-    -    dfdgRegistreringsTidspunkt

date-time

0 - 1

Registreringstidspunkt i DFDG

JobCenter

Kommune

STAR

x-civilregistrationIdentifier [Header]

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

response

GetYdelseshistorikResponseDto

1

Returtype

-    ydelser

YdelseHistorikCollection

1

Borgeres ydelsesperioder fra ydelsessystem.

-    -    YdelseHistorik

YdelseHistorik

0 - *

-    -    -    kyYdelsesIdentifier

uuid

1

Unik nøgle på ydelsessagen i KY

-    -    -    startdato

date

1

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

-    -    -    slutdato

date

0 - 1

Slutdato på på ydelsesperioden.

-    -    -    kontaktgruppe

KontaktgruppeTypeCodeList

0 - 1

-    -    -    kyNoegle

string

Length: 1-100

0 - 1

KY’s 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.

-    -    -    ydelsesAfgoerelsesType

YdelsesAfgoerelsesTypeCodeList

0 - 1

-    -    -    satsniveau

SatsniveauTypeCodeList

0 - 1

-    -    -    registrerendeSagsbehandler

RegistrerendeSagsbehandlerDto

1

RegistrationMetadata

-    -    -    -    registrendeMyndighed

RegistrendeMyndighedDto

0 - 1

Registrerende myndighed

-    -    -    -    -    organisationType

OrganisationTypeCodeList

1

-    -    -    -    -    myndighedskode

string

Length: 1-20

1

Identifikation af organisation / myndighed.

-    -    -    -    sagsbehandler

SagsbehandlerDto

0 - 1

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

-    -    -    -    -    kalder

KalderDto

1

Information om den kaldende bruger.

-    -    -    -    -    -    navn

string

Length: 1-140

1

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

-    -    -    -    -    -    brugertype

RequestUserTypeCodeList

1

-    -    -    -    -    -    brugeridentifier

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

string

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

0 - 1

Brugers e-mail.

-    -    -    -    -    registrendeMyndighed

RegistrendeMyndighedDto

1

Registrerende myndighed

-    -    -    -    -    -    organisationType

OrganisationTypeCodeList

1

-    -    -    -    -    -    myndighedskode

string

Length: 1-20

1

Identifikation af organisation / myndighed.

-    -    -    -    -    registreringstidspunkt

date-time

1

Kaldende systems registreringstidspunkt.

-    -    -    -    berigtigelseskommentar

string

0 - 1

Kommentar til ændring.