Versions Compared

Key

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

...

GetSocialAidRequestType

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.

...

    RegisteringAuthorityActiveOrganisationHeaderType    OrganisationTypeIdentifierBase: int    OrganisationCodeOrganisationCodeTypeBase:     DFDGRegistrationDateTime    AppropriationOutcomeTypeIdentifier0 -     SocialAidIdentifier

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

AppropriationOutcomeTypeIdentifierType

(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

...

    SaveSocialAidSaveSocialAidType    ContactGroupTypeIdentifier    AppropriationOutcomeTypeIdentifierAppropriationOutcomeTypeIdentifierType

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

Output

Fejlkode

Fejltekst

Beskrivelse

1010

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.

Fejlkoder

-    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

9229

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

GetYdelse (GET /v1/ydelse/historik)

...

GetSocialAidHistoryRequestType

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

getYdelsesHistorikResponse

GetSocialAidHistoryResponse

GetSocialAidHistoryResponseType

GetYdelsesHistorikResponseDto

1

-    GetSocialAidHistoryCollection

GetSocialAidHistoryTypeCollection

-    ydelser

(GetSocialAidHistoryCollection)

YdelserDto

1

Borgeres historiske ydelsesperioder fra ydelsessystem.

-    -

    GetSocialAidHistoryType

    ydelse

(GetSocialAidHistoryType)

Base: GetSocialAidHistoryMetaDataType

YdelseDto

0 - *

Konkrete ydelsesperiode

-    -    -    BaseType

GetSocialAidHistoryMetaDataType

1

-    -    -    -

    RegistrationMetadata

    RegistrerendeSagsbehandler

(RegistrationMetadata)

RegistrationMetadataType

1

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

-    -    -    -    -

    RegisteringAuthority

    registrendeMyndighed

(RegisteringAuthority)

ActiveOrganisationHeaderType

0 - 1

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

-    -    -    -    -    -

    OrganisationTypeIdentifier

    organisationType

(OrganisationCode)

OrganisationTypeIdentifierType


Base: int

MinInclusive: 1
MaxInclusive: 100

1

Kodeliste med organisationstype / myndighedstype

-    -    -    -    -    -

    OrganisationCode

    myndighedskode

OrganisationCodeType

(OrganisationTypeIdentifier)

Base:

string

Length: 1-20

1

Identifikation af organisation / myndighed

-    -    -    -    -

    RegisteringUserRequestUserMetadataType

    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.

-    -    -    -    -    -    -

    UserFullName

    navn

UserFullNameType

UserFullName

Base:

string

Length: 1-140

1

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

-    -    -    -    -    -    -

    RequestUserTypeIdentifier

    brugertype

(RequestUserTypeIdentifier)

RequestUserTypeIdentifierType

1

Brugertype

-    -    -    -    -    -    -

    UserIdentifier

    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.

-    -    -    -    -    -    -

    UserEmail

    email

(UserEmail)

EmailAddressIdentifierType
Base: string

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

0 - 1

Brugers e-mail.

-    -    -    -    -    -

    RequestOrganisationStructure

    registrendeMyndighed

(RequestOrganisationStructure)

RequestOrganisationStructureType

1

Den organisation som registrerende bruger tilhører.

-    -    -    -    -    -    -

    OrganisationTypeIdentifier

    organisationType

(OrganisationCode)

OrganisationTypeIdentifierType

1

Kodeliste med organisationstype / myndighedstype for registrerende bruger.

-    -    -    -    -    -    -

    OrganisationCode

    myndighedskode

OrganisationCodeType

(OrganisationTypeIdentifier)

Base:

string

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

1

Organisationskode for den registrerende bruger.

-    -    -    -    -    -

    RegistrationDateTime

    registreringstidspunkt

(RegistrationDateTime)

dateTime

1

Kaldende systems registreringstidspunkt.

-    -    -    -    -

    CorrectionComment

    berigtigelseskommentar

(CorrectionComment)

string

0 - 1

Kommentar til ændring

-    -    -    -    

-    RegistrationDateTime

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

-    -    -

    ContactGroupTypeIdentifierContactGroupTypeIdentifierType

    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

-    -    -

    ClientCategoryTypeIdentifierClientCategoryTypeIdentifierType

    klientkategori

(ClientCategoryTypeIdentifier)

VisiteringOgStatus.ClientCategoryTypeCodeList

(Gl. DFDG ClientCategoryTypeIdentifierType)

0 - 1

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

-    -    -

    DFDGRegistrationDateTime

    dfdgRegistreringsTidspunkt

(DFDGRegistrationDateTime)

dateTime

0 - 1

Registreringstidspunkt i DFDG

-    -    -

    AppropriationOutcomeTypeIdentifierAppropriationOutcomeTypeIdentifierType

    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

-    -    -

    SocialAidIdentifier

    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