Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

JobCenter

X

X

X

X

Kommune

X

STAR

X

Scope

VisiteringOgStatus/Ydelses/read

Input

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.

Output

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}

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

(Gl. DFDG ContactGroupTypeIdentifierType)

0 - 1

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

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

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

UpdateYdelse (PUT /v1/ydelse)

...

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

Kommune

X

STAR

X

Scope

VisiteringOgStatus/Ydelses/read

Input

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

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

gl DFDG AppropriationOutcomeTypeIdentifierType)

0 - 1

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

Hvis KY-identifier ikke opdateres ved bevilling af kontanthjælp over tid ved skift af satsniveau:

Element

Type

Detaljer

Forekomst

Beskrivelse

- - satsniveau

SatsniveauDtoCollection

0 - 1

Samling af satsnvivauer for ydelsen over tid.

- - - SatsniveauDto

SatsniveauDto

0 - *

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

- - - -    startdato

date

1

Startdato for satsniveauet. Ikke udfyldt ved “Ydelsessag startet”. Angivet ved alle andre statusser.

- - - -    slutdato

date

0 - 1

Slutdato for satsniveauet. Ikke udfyldt ved “Ydelsessag startet”. Angivet ved alle andre statusser.

- - - -    satsniveauType

VisiterinOgStatus.SatsniveayTypeKodeliste

0 - 1

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

- - - -    paragraf

string eller kodeliste

0 - 1

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

Hvis afgørelse om skift i satsniveau medfører at KY-identifier skifter:

Element

Type

Detaljer

Forekomst

Beskrivelse

- - SatsniveauDto

SatsniveauDto

0 - 1

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

- - -    satsniveauType

VisiterinOgStatus.SatsniveayTypeKodeliste

0 - 1

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

- - -    paragraf

string eller kodeliste

0 - 1

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

Output

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

...

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 angivet identifier tilhøre 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

...