Siden opdateres automatisk til at afspejle koden. CodeFirst.
Servicen udstiller informationer om en borgers sociale ydelser.
Metoder
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 | |
|---|---|---|---|---|---|---|---|---|
| JobCenter | X | X | X | X | ||||
| Kommune | X | |||||||
| STAR | X |
Scope
Ikke defineret
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| GetSocialAidRequest | GetSocialAidRequestType | 1 | ||
| - 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 | Borgerens personnummer. |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| GetSocialAidResponse | GetSocialAidResponseType | 1 | ||
| - GetSocialAidCollection | GetSocialAidTypeCollection | 1 | Borgeres ydelsesperioder fra ydelsessystem. | |
| - - GetSocialAidType | GetSocialAidType | 0 - * | Konkrete ydelsesperiode | |
| - - - 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 | Borgerens cpr-nummer |
| - - - 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 |
| - - - StartDate | date | 1 | Startdato på ydelsesperioden. Hvis hændelsen er "Ydelsessag startet" så den forventet startdato. | |
| - - - EndDate | date | 0 - 1 | Slutdato på på ydelsesperioden. | |
| - - - ContactGroupTypeIdentifier | ContactGroupTypeIdentifierType | 0 - 1 | Resultatet af afgørelsen om ydelse hvis positivt dvs. ydelse gives. Resultat angives i form af DFDG kontaktgruppe | |
| - - - RegisteringAuthority | ActiveOrganisationHeaderType | 0 - 1 | Registrerende (myndighed) Kommune | |
| - - - - OrganisationTypeIdentifier | OrganisationTypeIdentifierType Base: int | MinInclusive: 1 MaxInclusive: 100 | 1 | Kodeliste med organisationstype / myndighedstype |
| - - - - OrganisationCode | OrganisationCodeType Base: string | Length: 1-20 | 1 | Identifikation af organisation / myndighed |
| - - - DFDGRegistrationDateTime | dateTime | 0 - 1 | Registreringstidspunkt i DFDG | |
| - - - AppropriationOutcomeTypeIdentifier | AppropriationOutcomeTypeIdentifierType | 0 - 1 | Hændelse fra ydelse, enten at - Ydelsessag startet - Ydelse er givet - Ydelse er afvist - Ydelse stoppet - Ydelsessag afsluttet | |
| - - - 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 |
SaveSocialAid
Metoden opretter eller opdaterer en social 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 | |
|---|---|---|---|---|---|---|---|---|
| Kommune | X | |||||||
| STAR | X |
Scope
Ikke defineret
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| SaveSocialAidRequest | SaveSocialAidRequestType | 1 | ||
| - SaveSocialAid | SaveSocialAidType | 1 | Validering af bevilling. | |
| - - 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 | Borgerens cpr-nummer |
| - - 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 |
| - - StartDate | date | 1 | Startdato på ydelsesperioden. Hvis hændelsen er "Ydelsessag startet" så den forventet startdato. | |
| - - EndDate | date | 0 - 1 | Slutdato på på ydelsesperioden. | |
| - - ContactGroupTypeIdentifier | ContactGroupTypeIdentifierType | 0 - 1 | Resultatet af afgørelsen om ydelse hvis positivt dvs. ydelse gives. Resultat angives i form af DFDG kontaktgruppe | |
| - - AppropriationOutcomeTypeIdentifier | AppropriationOutcomeTypeIdentifierType | 0 - 1 | Hændelse fra ydelse, enten at - Ydelsessag startet - Ydelse er givet - Ydelse er afvist - Ydelse stoppet - Ydelsessag afsluttet |
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. |
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 |
| 4669 | The enddate must not be earlier than the start date | The enddate must not be earlier than the start date |
| 9229 | The submitted identifier does not belong to the specified person | The submitted identifier does not belong to the specified person |
| 9392 | The type of social aid is not allowed | The type of social aid is not allowed |
| 9393 | The end date of social aid is mandatory, when a social aid is terminated | The end date of social aid is mandatory, when a social aid is terminated |
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 | |
|---|---|---|---|---|---|---|---|---|
| JobCenter | X | X | X | X | ||||
| Kommune | X | |||||||
| STAR | X |
Scope
Ikke defineret
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| GetSocialAidHistoryRequest | GetSocialAidHistoryRequestType | 1 | ||
| - 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 | Borgerens personnummer. |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| GetSocialAidHistoryResponse | GetSocialAidHistoryResponseType | 1 | ||
| - GetSocialAidHistoryCollection | GetSocialAidHistoryTypeCollection | 1 | Borgeres historiske ydelsesperioder fra ydelsessystem. | |
| - - GetSocialAidHistoryType | GetSocialAidHistoryType Base: GetSocialAidHistoryMetaDataType | 0 - * | Konkrete ydelsesperiode | |
| - - - BaseType | GetSocialAidHistoryMetaDataType | 1 | ||
| - - - - RegistrationMetadata | RegistrationMetadataType | 1 | Registrerende bruger og dennes organisation (som ved fx Anden Aktør kan være forskellig fra ovenfor) | |
| - - - - - RegisteringAuthority | ActiveOrganisationHeaderType | 0 - 1 | Den myndighed som der er registreret på vegne af (v/ AA: som brugeren har impersonated) | |
| - - - - - - OrganisationTypeIdentifier | OrganisationTypeIdentifierType Base: int | MinInclusive: 1 MaxInclusive: 100 | 1 | Kodeliste med organisationstype / myndighedstype |
| - - - - - - OrganisationCode | OrganisationCodeType Base: string | Length: 1-20 | 1 | Identifikation af organisation / myndighed |
| - - - - - RegisteringUser | RequestUserMetadataType | 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 | UserFullNameType Base: string | Length: 1-140 | 1 | Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her. |
| - - - - - - - RequestUserTypeIdentifier | RequestUserTypeIdentifierType | 1 | Brugertype | |
| - - - - - - - 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 | EmailAddressIdentifierType Base: string | Pattern: ([^>\(\)\[\]\\,;:@\s]{0,191}@[^>\(\)\[\]\\,;:@\s]{1,64}) | 0 - 1 | Brugers e-mail. |
| - - - - - - RequestOrganisationStructure | RequestOrganisationStructureType | 1 | Den organisation som registrerende bruger tilhører. | |
| - - - - - - - OrganisationTypeIdentifier | OrganisationTypeIdentifierType | 1 | Kodeliste med organisationstype / myndighedstype for registrerende bruger. | |
| - - - - - - - OrganisationCode | OrganisationCodeType Base: string | Pattern: [-][1]|[0-9]{1,8} | 1 | Organisationskode for den registrerende bruger. |
| - - - - - - RegistrationDateTime | dateTime | 1 | Kaldende systems registreringstidspunkt. | |
| - - - - - CorrectionComment | string | 0 - 1 | Kommentar til ændring | |
| - - - - - RegistrationDateTime | dateTime | 0 - 1 | Registreringstidspunkt | |
| - - - 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 | Borgerens cpr-nummer |
| - - - 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 |
| - - - StartDate | date | 1 | Startdato på ydelsesperioden. Hvis hændelsen er "Ydelsessag startet" så den forventet startdato. | |
| - - - EndDate | date | 0 - 1 | Slutdato på på ydelsesperioden. | |
| - - - ContactGroupTypeIdentifier | ContactGroupTypeIdentifierType | 0 - 1 | Resultatet af afgørelsen om ydelse hvis positivt dvs. ydelse gives. Resultat angives i form af DFDG kontaktgruppe | |
| - - - ClientCategoryTypeIdentifier | ClientCategoryTypeIdentifierType | 0 - 1 | Resultatet af afgørelsen om ydelse hvis positivt dvs. ydelse gives. Resultat angives i form af DFDG klientkategori | |
| - - - DFDGRegistrationDateTime | dateTime | 0 - 1 | Registreringstidspunkt i DFDG | |
| - - - AppropriationOutcomeTypeIdentifier | AppropriationOutcomeTypeIdentifierType | 0 - 1 | Hændelse fra ydelse, enten at - Ydelsessag startet - Ydelse er givet - Ydelse er afvist - Ydelse stoppet - Ydelsessag afsluttet | |
| - - - 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 |