PersonCommunicationStatusService (Version 1, 2020-2)
Siden opdateres automatisk til at afspejle koden. CodeFirst.
Servicen giver adgang til de aktuelle stam-, kontakt-, kontaktpersons- og kommunikationsdata, der er registreret for en borger.
Metoder
GetPersonCommunicationStatus
Henter aktuelle stam-, kontakt-, kontaktpersons- og kommunikationsdata 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 |
---|---|---|---|---|---|---|---|---|
A-kasse |
| X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X |
|
|
|
|
JobCenter |
| X |
| X | X | X |
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetPersonCommunicationStatusRequest | GetPersonCommunicationStatusRequestType |
| 1 | En forespørgsel som indeholder data vedr. borgeren, der ønskes aktuelle stam-, kontakt- og kommunikationsdata for. |
- PersonCivilRegistrationIdentifier | PersonCivilRegistrationIdentifierType | 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 | Borgers personnummer |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetPersonCommunicationStatusResponse | GetPersonCommunicationStatusResponseType |
| 1 | Svaret på forespørgslen om en borgers aktuelle stam-, kontakt-, kontaktpersons- og kommunikationsdata. |
- PersonCoreInfo | PersonCoreInfoType |
| 0 - 1 | Information om borgerens aktuelle stamdata. |
- - PersonCivilRegistrationIdentifier | PersonCivilRegistrationIdentifierType | 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 | Borgers personnummer |
- - PersonCivilRegistrationStatusCode |
| 1 | Statuskode for borger fra CPR | |
- - PersonNameStructure | PersonNameStructureType |
| 0 - 1 |
|
- - - PersonGivenName | PersonGivenNameType | Length: 1-50 | 1 | Erklæring af personens fornavn(e). |
- - - PersonMiddleName | PersonMiddleNameType | Length: 1-40 | 0 - 1 | Erklæring af personens mellemnavne(e). |
- - - PersonSurnameName | PersonSurnameNameType | Length: 1-40 | 1 | Erklæring af en persons efternavne(e). |
- - CitizenshipCode |
| 1 |
| |
- - ImmigrationDate | date |
| 0 - 1 | Dato for immigrering til Danmark |
- PersonContactInfo | PersonContactInfoType |
| 0 - 1 | Information om borgerens aktuelle kontaktpersoner. |
- - PersonContactCollection | PersonContactTypeCollection |
| 1 | Liste af borgerens aktuelle kontaktpersoner. |
- - - PersonContactType | PersonContactType |
| 0 - * |
|
- - - - PersonContactIdentifier | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 0 - 1 | Identifikation af kontaktpersontilknytningen. Hvis kontaktpersonen er mentor eller udslusningskoordinator er værdien null. |
- - - - PersonContactName | string | Length: 1-250 | 1 | Navn (fornavn, mellemnavn, efternavn) på kontaktpersonen. |
- - - - PersonContactTypeIdentifier |
| 1 | Identifikation af kontaktpersontilknytningen. | |
- - - - TelephoneNumberIdentifier | TelephoneNumberIdentifierType | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Telefonnummer inkl. internationalt prefix. |
- - - - MobileNumberIdentifier | TelephoneNumberIdentifierType | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Mobilnummer inkl. internationalt prefix |
- - - - EmailAddressIdentifier | EmailAddressIdentifierType | Pattern: ([^>\(\)\[\]\\,;:@\s]{0,191}@[^>\(\)\[\]\\,;:@\s]{1,64}) | 0 - 1 | Emailadresse. |
- - - - StartDate | dateTime |
| 1 | Startdato for tilknytning af kontaktperson. |
- - - - EndDate | dateTime |
| 0 - 1 | Slutdato for tilknytning af kontaktperson. |
- - - - CommentToCitizen | string | Length: 1-250 | 0 - 1 | Kommentar/bemærkninger til visning for borger på Jobnet. |
- - - - CommentToCaseWorker | string | Length: 1-250 | 0 - 1 | Kommentar/bemærkninger til visning for jobkonsulent i a-kasse og jobcenter. |
- - - - ShowContactPersonInJobnet | boolean |
| 1 | Skal kontaktpersonen vises på Jobnet med denne rolle for borgerne. |
- - - - ResponsibleAuthority | AuthorityStructureType |
| 1 | Den myndighed som har oprettet kontaktpersonen. |
- - - - - AuthorityCode | string | Pattern: [-][1]|[0-9]{1,8} | 1 | Myndighedskode. |
- - - - - OrganisationTypeIdentifier |
| 1 | Myndighedstype | |
- - - - DFDGRegistrationDateTime | dateTime |
| 1 | Tidspunkt hvor hændelsen/data er registreret 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 |
GetPersonNemSMSSubscription
Henter information om hvorvidt en borger er tilmeldt NemSMS eller ej.
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 |
---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetPersonNemSMSSubscriptionRequest | GetPersonNemSMSSubscriptionRequestType |
| 1 | En forespørgsel som indeholder data vedr. den borger, der ønskes NemSMS tilmeldingsstatus for. |
- PersonCivilRegistrationIdentifier | PersonCivilRegistrationIdentifierType | 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 | Borgers personnummer |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetPersonNemSMSSubscriptionResponse | GetPersonNemSMSSubscriptionResponseType |
| 1 | Svaret på forespørgslen om en borgers NemSMS tilmeldingsstatus. |
- PersonNemSMSSubscriptionInfo | PersonNemSMSSubscriptionInfoType |
| 0 - 1 | Information om borgerens NemSMS tilmeldingsstatus |
- - PersonSubscribed | boolean |
| 1 | Indikerer hvorvidt borgeren er tilmeldt NemSMS eller ej. |
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 |
9399 | NemSMS service unhandled error | NemSMS service unhandled error |