Siden opdateres automatisk til at afspejle koden.
Metoder
| Table of Contents | ||
|---|---|---|
|
...
CreateKontaktinformation (POST /v1/kontaktinformation)
(Gl. DFDG PersonNotificationReminderService (Version 1, 2020-3) .SavePersonContactData ogJobnetPersonNotificationReminderService (Version 1, 2020-1).SavePersonContactData
Scope
Ikke defineret
Input
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
SavePersonContactDataRequest
...
SavePersonContactDataRequestType
...
1
...
- PersonCivilRegistrationIdentifier eller CvCustomerIdentifier
...
PersonCivilRegistrationIdentifierType
Base: string
...
Denne metode opdaterer borgeres kontaktinformation. Disse omfatter pt. mobiltelefon, fastnet telefon og mailadresse.
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 |
|
|
|
| ||
JobCenter |
| X | X |
| ||||
Kommune |
| X |
|
|
|
| ||
STAR | X |
|
|
|
|
|
|
|
Scope
Borgerkommunikation.BorgersKontaktinformationService.informationer.write
Input
VerifyPersonContactData
(Gl. DFDG JobnetPersonNotificationReminderService (Version 1, 2020-1).VerifyPersonContactData)
Metode til at verifisere kontaktinformation
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
VerifyPersonContactDataRequest | VerifyPersonContactDataRequestType |
| 1 |
|
| CvCustomerIdentifierType | Pattern: [0-9]{8} | 1 | Cv kundenummer |
| string |
| 1 | Angivelse af verifiseringskode til kontaktinformationen |
|
| 1 | Typen af kontaktdata. |
Output
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
VerifyPersonContactDataResponse
...
VerifyPersonContactDataResponseType
...
...
1
...
...
ServiceReceipt
...
ServiceReceiptType
...
...
1
...
Service kvittering
...
- EventDate
...
dateTime
...
...
1
Registreringstidspunkt.
...
- MessageIdentifier
...
guid
Base: string
...
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
...
1
Besked id.
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
1013 | Insufficient permissions | User has insufficient permissions to access this webservice |
1014 | Failed to validate message | The submitted message could not be validated |
4400 | CV Customer Number is unknown | The supplied CV Customer Number is unknown to the system |
9153 | The submitted PersonContactDataTypeIdentifier is not a valid codelist value | The submitted PersonContactDataTypeIdentifier is not a valid codelist value |
9159 | No person contact data was registered for the submitted person | No person contact data was registered for the submitted person |
9240 | The registered person contact data is not valid for verification | The registered person contact data is not valid for verification |
9241 | The submitted verification code is not valid | The submitted verification code is not valid |
9242 | No person contact data registered for verification | No person contact data registered for verification |
RequestNewVerificationCode
(Gl. DFDG JobnetPersonNotificationReminderService (Version 1, 2020-1).RequestNewVerificationCode)
Metode til at hente en ny verifiseringskode
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
RequestNewVerificationCodeRequest | RequestNewVerificationCodeRequestType |
| 1 |
|
| CvCustomerIdentifierType | Pattern: [0-9]{8} | 1 | Cv kundenummer |
|
| 1 | Typen af kontaktdata. |
Output
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
RequestNewVerificationCodeResponse
...
RequestNewVerificationCodeResponseType
...
...
1
...
...
ServiceReceipt
...
ServiceReceiptType
...
...
1
...
Service kvittering
...
- EventDate
...
dateTime
...
...
1
Registreringstidspunkt.
...
- MessageIdentifier
...
guid
Base: string
...
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
...
1
Besked id.
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
1013 | Insufficient permissions | User has insufficient permissions to access this webservice |
1014 | Failed to validate message | The submitted message could not be validated |
4400 | CV Customer Number is unknown | The supplied CV Customer Number is unknown to the system |
9153 | The submitted PersonContactDataTypeIdentifier is not a valid codelist value | The submitted PersonContactDataTypeIdentifier is not a valid codelist value |
9159 | No person contact data was registered for the submitted person | No person contact data was registered for the submitted person |
9240 | The registered person contact data is not valid for verification | The registered person contact data is not valid for verification |
9242 | No person contact data registered for verification | No person contact data registered for verification |
9247 | The person contact data has already been verified | The person contact data has already been verified |
GetPersonContactAndNotificationData
Scope
Ikke defineret
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
CreateKontaktinformationRequest | CreateKontaktinformationRequestType | 1 | ||
- x-civilregistrationIdentifier [Header] (PersonCivilRegistrationIdentifier eller CvCustomerIdentifier) | 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
Borgers personnummer
- PersonContactDataCollection
PersonContactDataCollectionType
1
Kollektion af borgers kontaktdata.
- - PersonContactData
PersonContactDataType
1 - *
Borgers kontaktdata.
- - - PersonContactData
string
0 - 1
Angivelse af mobiltelefon, fastnet telefon eller mailadresse. Hvis NULL angives eller elementet udelades slettes den angivne type af kontaktinformation.
- - - PersonContactDataTypeIdentifier
1
Borgers kontaktform
Output
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
SavePersonContactDataResponse
...
SavePersonContactDataResponseType
...
1
...
- ServiceReceipt
...
ServiceReceiptType
...
1
...
Service kvittering
...
- - EventDate
...
dateTime
...
1
...
- - MessageIdentifier
...
guid
Base: string
...
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
...
1
...
Fejlkoder
...
Fejlkode
...
Fejltekst
...
Beskrivelse
...
1001
...
Invalid cpr
...
The submitted cpr is either to long or short or contains data not interpretable as a date
...
1010
...
Unknown cpr
...
The submitted cpr is unknown to the system
...
1012
...
Logon failed
...
Logon failed for user
...
1013
...
Insufficient permissions
...
User has insufficient permissions to access this webservice
...
1014
...
Failed to validate message
...
The submitted message could not be validated
...
4405
...
The person with specified cpr is dead
...
The person with specified cpr is dead
...
4575
...
You are not authorized
...
You are not authorized to execute the operation
...
9153
...
The submitted PersonContactDataTypeIdentifier is not a valid codelist value
...
The submitted PersonContactDataTypeIdentifier is not a valid codelist value
...
9155
...
The mail address cannot be removed while a subscribtion for email notifications exists
...
The mail address cannot be removed while a subscribtion for email notifications exists
...
9156
...
The submitted mobile phone number is invalid
...
The submitted mobile phone number is invalid
...
9157
...
The submitted phone number is invalid
...
The submitted phone number is invalid
...
9158
...
The submitted mail address is invalid
...
The submitted mail address is invalid
1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Borgers personnummer | ||
- kontaktinformationer (PersonContactDataCollection) | KontaktinformationerDto | 1 | Kollektion af borgers kontaktdata. | |
- - kontaktinformation (PersonContactData) | KontaktinformationDto | 1 - * | Borgers kontaktdata. | |
- - - kontaktdata (PersonContactData) | string | 1 | Angivelse af mobiltelefon, fastnet telefon eller mailadresse. Ved tomt input slettes den angivne type af kontaktinformation. | |
- - - kontaktdataType (PersonContactDataTypeIdentifier) | Borgerkommunikation.KontaktdataCodeList (Gl. DFDG PersonContactDataTypeIdentifierType) | 1 | Borgers kontaktform |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
GetPersonContactAndNotificationDataRequest
GetPersonContactAndNotificationDataRequestType
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
Borgers personnummer
Output
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
GetPersonContactAndNotificationDataResponse
...
GetPersonContactAndNotificationDataResponseType
...
1
...
- NotificationReminder
...
NotificationReminderType
...
0 - 1
...
Borgers kontaktdata og huskeservice abonnementer.
...
- - MobileNumberIdentifier
...
MobileNumberIdentifierType
Base: TelephoneNumberIdentifierType
...
0 - 1
...
Angivelse af telefonnummer. Skal være et mobilnummer inkl. internationalt prefix
...
- - EmailAddressIdentifier
...
EmailAddressIdentifierType
Base: string
...
Pattern: ([^>\(\)\[\]\\,;:@\s]{0,191}@[^>\(\)\[\]\\,;:@\s]{1,64})
...
0 - 1
...
Angivelse af emailadresse.
...
- - AllowTextNotificationCollection
...
NotificationTypeIdentifierCollectionType
...
0 - 1
...
Kollektion af de notifikationstyper, som der ønskes abonnement på via SMS.
...
- - - NotificationTypeIdentifier
...
NotificationTypeIdentifierType
...
1 - *
...
Abonnementstype.
...
- - AllowEmailNotificationCollection
...
NotificationTypeIdentifierCollectionType
...
0 - 1
...
Kollektion af de notifikationstyper, som der ønskes abonnement på via e-mail.
...
- - - NotificationTypeIdentifier
...
NotificationTypeIdentifierType
...
1 - *
...
Abonnementstype.
...
- - AuthorityStructure
...
AuthorityStructureType
...
1
...
Registrerende myndighed.
...
- - - AuthorityCode
...
AuthorityCodeType
Base: string
...
Pattern: [-][1]|[0-9]{1,8}
...
1
...
Myndighedskode.
...
- - - AuthorityName
...
AuthorityNameType
Base: string
...
Length: 1-100
...
1
...
Myndighedsnavn.
...
- - - OrganisationTypeIdentifier
...
OrganisationTypeIdentifierType
...
1
...
Organisationstype.
...
- - CaseWorkerStructure
...
CaseWorkerStructureType
...
1
...
Registrerende sagsbehandler.
...
- - - CaseWorkerGivenName
...
PersonGivenNameType
Base: string
...
Length: 1-50
...
1
...
Sagsbehandlerens fornavn.
...
- - - CaseWorkerMiddleName
...
PersonMiddleNameType
Base: string
...
Length: 1-40
...
0 - 1
...
Sagsbehandlerens mellemnavn.
...
- - - CaseWorkerSurname
...
PersonSurnameNameType
Base: string
...
Length: 1-40
...
1
...
Sagsbehandlerens efternavn.
...
- - - CaseWorkerIdentifier
...
CaseWorkerIdentifierType
Base: string
...
Length: 1-255
...
1
...
Sagsbehandlerens RID fra medarbejder OCES certifikatet.
...
- - RegistrationDate
...
dateTime
...
1
...
Dato for registrering af huskeserviceabonnementer.
Fejlkoder
...
Fejlkode
...
Fejltekst
...
Beskrivelse
...
1001
...
Invalid cpr
...
The submitted cpr is either to long or short or contains data not interpretable as a date
...
1010
...
Unknown cpr
...
The submitted cpr is unknown to the system
...
1012
...
Logon failed
...
Logon failed for user
...
1013
...
Insufficient permissions
...
User has insufficient permissions to access this webservice
...
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
GetPersonContactAndNotificationDataHistory
Scope
Ikke defineret
Input
Intet retursvar | ||||
SavePersonContactDataResponse | SavePersonContactDataResponseType | 1 | ||
- ServiceReceipt | ServiceReceiptType | 1 | Service kvittering | |
- - EventDate | dateTime | 1 |
| |
- - MessageIdentifier | guid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
1010 | Unknown cpr | The submitted cpr is unknown to the system |
1012 | Logon failed | Logon failed for user |
1013 | Insufficient permissions | User has insufficient permissions to access this webservice |
1014 | Failed to validate message | The submitted message could not be validated |
4405 | The person with specified cpr is dead | The person with specified cpr is dead |
4575 | You are not authorized | You are not authorized to execute the operation |
9153 | The submitted PersonContactDataTypeIdentifier is not a valid codelist value | The submitted PersonContactDataTypeIdentifier is not a valid codelist value |
9155 | Email adresse kan ikke fjernes sålænge der er huskeserviceabonnement tilknyttet The mail address cannot be removed while a subscribtion for email notifications exists | Email adresse kan ikke fjernes sålænge der er huskeservice abonnemet tilknyttet The mail address cannot be removed while a subscribtion for email notifications exists |
9156 | Det angivne mobiltelefonnummer er ikke validt The submitted mobile phone number is invalid | Det angivet mobiltelefonnummer er ikke validt The submitted mobile phone number is invalid |
9157 | Det angivet telefonnummer er ikke validt The submitted phone number is invalid | Det angivet telefonnummer er ikke validt The submitted phone number is invalid |
9158 | Den angive emailadresse er ikke valid The submitted mail address is invalid | Den angive emailadresse er ikke valid The submitted mail address is invalid |
Gl. DFDG JobnetPersonNotificationReminderService (Version 1, 2020-1).VerifyPersonContactData) flyttes til Eksternkommunikation.KontaktinformationVerifikationsService
Gl. DFDG JobnetPersonNotificationReminderService (Version 1, 2020-1).RequestNewVerificationCode flyttes Eksternkommunikation.KontaktinformationVerifikationsService
GetKontaktinformationMobilNr (GET /v1/kontaktinformation/mobiltelefon/{mobiltelefon})
(Gl. DFDG PersonNotificationReminderService (Version 1, 2020-3).GetPersonByMobilePhoneNumber)
Denne metode udsøger borgere, der er tilmeldt huskeservice med et givet mobilnummer og den periode personen har været tilmeldt med det pågældende mobilnummer. Metoden er rettet mod Landssupportens behandling af supporthenvendelser fra en borger.
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 |
|
|
|
| ||
JobCenter |
| X | X |
| ||||
Kommune |
| X |
|
|
|
| ||
STAR | X |
|
|
|
|
|
|
|
Scope
Borgerkommunikation.BorgersKontaktinformationService.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
GetKontaktinformationRequest | GetKontaktinformationRequestType | 1 | ||
- mobiltelefon [Query] (MobileNumberIdentifier) | string | 1 | Angivelse af telefonnummer. Skal være et mobilnummer inkl. internationalt prefix |
Output
...
- - - - NotificationTypeIdentifier
...
NotificationTypeIdentifierType
...
1 - *
...
Abonnementstype.
...
- - - AllowEmailNotificationCollection
...
NotificationTypeIdentifierCollectionType
...
0 - 1
...
Kollektion af de notifikationstyper, som der ønskes abonnement på via e-mail.
...
- - - - NotificationTypeIdentifier
...
NotificationTypeIdentifierType
...
1 - *
...
Abonnementstype.
...
- - - AuthorityStructure
...
AuthorityStructureType
...
1
...
Registrerende myndighed.
...
- - - - AuthorityCode
...
AuthorityCodeType
Base: string
...
Pattern: [-][1]|[0-9]{1,8}
...
1
...
Myndighedskode.
...
- - - - AuthorityName
...
AuthorityNameType
Base: string
...
Length: 1-100
...
1
...
Myndighedsnavn.
...
- - - - OrganisationTypeIdentifier
...
OrganisationTypeIdentifierType
...
1
...
Organisationstype.
...
- - - CaseWorkerStructure
...
CaseWorkerStructureType
...
1
...
Registrerende sagsbehandler.
...
- - - - CaseWorkerGivenName
...
PersonGivenNameType
Base: string
...
Length: 1-50
...
1
...
Sagsbehandlerens fornavn.
...
- - - - CaseWorkerMiddleName
...
PersonMiddleNameType
Base: string
...
Length: 1-40
...
0 - 1
...
Sagsbehandlerens mellemnavn.
...
- - - - CaseWorkerSurname
...
PersonSurnameNameType
Base: string
...
Length: 1-40
...
1
...
Sagsbehandlerens efternavn.
...
- - - - CaseWorkerIdentifier
...
CaseWorkerIdentifierType
Base: string
...
Length: 1-255
...
1
...
Sagsbehandlerens RID fra medarbejder OCES certifikatet.
...
- - - RegistrationDate
...
dateTime
...
1
...
Dato for registrering af huskeserviceabonnementer.
...
- - HistoryDate
...
dateTime
...
1
...
Dato for ændring.
Fejlkoder
...
Fejlkode
...
Fejltekst
...
Beskrivelse
...
1001
...
Invalid cpr
...
The submitted cpr is either to long or short or contains data not interpretable as a date
...
1010
...
Unknown cpr
...
The submitted cpr is unknown to the system
...
1012
...
Logon failed
...
Logon failed for user
...
1013
...
Insufficient permissions
...
User has insufficient permissions to access this webservice
...
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
GetPersonByMobilePhoneNumber
Scope
Ikke defineret
Input
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
GetPersonByMobilePhoneNumberRequest
...
GetPersonByMobilePhoneNumberRequestType
...
1
...
- MobileNumberIdentifier
...
MobileNumberIdentifierType
Base: TelephoneNumberIdentifierType
...
1
...
Angivelse af telefonnummer. Skal være et mobilnummer inkl. internationalt prefix
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
GetKontaktinformationResponse |
GetKontaktinformationResponseType | 1 |
- PersonCivilRegistrationIdentifier
Base:
- borgere (CprCollection) | BorgereDto | 0 - * | Kollektion af personnumre. | |
- - 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}) |
1
Borgers personnummer
Output
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
GetPersonContactAndNotificationDataHistoryResponse
...
GetPersonContactAndNotificationDataHistoryResponseType
...
1
...
- NotificationReminderHistory
...
NotificationReminderHistoryType
...
0 - *
...
Kollektion af borgers historiske kontaktdata og huskeservice abonnementer.
...
- - NotificationReminder
...
NotificationReminderType
...
1
...
Borgers kontaktdata og huskeservice abonnementer.
...
- - - MobileNumberIdentifier
...
MobileNumberIdentifierType
Base: TelephoneNumberIdentifierType
...
0 - 1
...
Angivelse af telefonnummer. Skal være et mobilnummer inkl. internationalt prefix
...
- - - EmailAddressIdentifier
...
EmailAddressIdentifierType
Base: string
...
Pattern: ([^>\(\)\[\]\\,;:@\s]{0,191}@[^>\(\)\[\]\\,;:@\s]{1,64})
...
0 - 1
...
Angivelse af emailadresse.
...
- - - AllowTextNotificationCollection
...
NotificationTypeIdentifierCollectionType
...
0 - 1
...
Kollektion af de notifikationstyper, som der ønskes abonnement på via SMS.
|0000000000 | 1 | Borgers personnummer | ||
- - starttidspunkt (RegistrationStartDate) | dateTime | 1 | Startdato for udsøgningsperiode. | |
- - sluttidspunkt (RegistrationEndDate) | dateTime | 0 - 1 | Slutdato for udsøgningsperiode. |
Fejlkoder
Ingen fejlkoder
GetKontaktinformationEmail (GET /v1/kontaktinformation/emailadresse/{email})
(Gl. DFDG PersonNotificationReminderService (Version 1, 2020-3).GetPersonByEmailAddress)
Denne metode udsøger borgere, der er tilmeldt huskeservice med en given e-mailadresse og den periode personen har været tilmeldt med den pågældende e-mailadresse. Metoden er rettet mod Landssupportens behandling af supporthenvendelser fra en borger.
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 |
|
|
|
| ||
JobCenter |
| X | X |
| ||||
Kommune |
| X |
|
|
|
| ||
STAR | X |
|
|
|
|
|
|
|
Scope
Borgerkommunikation.BorgersKontaktinformationService.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
GetKontaktinformationRequest | GetKontaktinformationRequestType | 1 | ||
- email [Query] (EmailAddressIdentifier) | string | Pattern: ([^>\(\)\[\]\\,;:@\s]{0,191}@[^>\(\)\[\]\\,;:@\s]{1,64}) | 1 | Angivelse af emailadresse. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
GetKontaktinformationResponse | GetKontaktinformationResponseType | 1 | ||
- borgere (CprCollection) | BorgereDto | 0 - * | Kollektion af personnumre. | |
- - personnummer (PersonCivilRegistrationIdentifier) | 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 | Borgers personnummer |
- - starttidspunkt (RegistrationStartDate) | dateTime | 1 | Startdato for udsøgningsperiode. | |
- - sluttidspunkt (RegistrationEndDate) | dateTime | 0 - 1 | Slutdato for udsøgningsperiode. |
Fejlkoder
Ingen fejlkoder
UpdateKontaktinformation (POST /v1/kontaktinformation/status)
(Gl. DFDG PersonNotificationReminderService (Version 1, 2020-3).SavePersonContactStatus)
Denne metode giver mulighed for at ændre status (kontaktdatastatus) på en borgers mailadresse eller mobiltelefonnummer.
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 |
|
|
|
|
| |||
JobCenter |
|
| ||||||
Kommune |
|
|
|
|
| |||
STAR | X |
|
|
|
|
|
|
|
Scope
Borgerkommunikation.BorgersKontaktinformationService.informationer.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
UpdateKontaktinformationRequest |
UpdateKontaktinformationRequestType | 1 | ||
- |
CprCollectionType
0 - *
Kollektion af personnumre.
- - PersonCivilRegistrationIdentifier
Base:
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 | Borgers personnummer |
- |
dateTime
1
Startdato for udsøgningsperiode.
- - RegistrationEndDate
dateTime
0 - 1
Slutdato for udsøgningsperiode.
Fejlkoder
Ingen fejlkoder
GetPersonByEmailAddress
Scope
Ikke defineret
Input
Element
Type
Detaljer
Forekomst
Beskrivelse
GetPersonByEmailAddressRequest
GetPersonByEmailAddressRequestType
1
- EmailAddressIdentifier
EmailAddressIdentifierType
Base: string
Pattern: ([^>\(\)\[\]\\,;:@\s]{0,191}@[^>\(\)\[\]\\,;:@\s]{1,64})
1
kontaktdataType (PersonContactDataTypeIdentifier) | Borgerkommunikation.KontaktdataCodeList (Gl. DFDG PersonContactDataTypeIdentifierType) | 1 | Borgers kontaktform | |
- kontaktdatastatus (PersonContactDataStatusTypeIdentifier) | Borgerkommunikation.KontaktdataStatusCodeList (Gl. DFDG PersonContactDataStatusTypeIdentifierType) | 1 | Borgers status på kontaktform |
Output
...
- PersonContactDataTypeIdentifier
...
PersonContactDataTypeIdentifierType
...
1
...
Borgers kontaktform
...
- PersonContactDataStatusTypeIdentifier
...
PersonContactDataStatusTypeIdentifierType
...
1
...
Borgers status på kontaktform
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
GetPersonByEmailAddressResponse
GetPersonByEmailAddressResponseType
1
- CprCollection
CprCollectionType
0 - *
Kollektion af personnumre.
- - 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
Borgers personnummer
- - RegistrationStartDate
dateTime
1
Startdato for udsøgningsperiode.
- - RegistrationEndDate
dateTime
0 - 1
Slutdato for udsøgningsperiode.
Fejlkoder
Ingen fejlkoder
SavePersonContactStatus
Scope
Ikke defineret
Input
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
SavePersonContactStatusRequest
...
SavePersonContactStatusRequestType
...
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
...
Borgers personnummer
Intet retursvar | ||||
SavePersonContactStatusResponse | SavePersonContactStatusResponseType | 1 | ||
- ServiceReceipt | ServiceReceiptType | 1 | Service kvittering | |
- - EventDate | dateTime | 1 |
| |
- - MessageIdentifier | guid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
1010 | Unknown cpr | The submitted cpr is unknown to the system |
1012 | Logon failed | Logon failed for user |
1013 | Insufficient permissions | User has insufficient permissions to access this webservice |
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 |
4986 | Ukendt jobcenterkode Unknown jobcentercode | Ukendt jobcenterkode Unknown jobcentercode |
4985 | Ukendt a-kasse kode Unknown unemploymentfundcode | Ukendt a-kasse kode Unknown unemploymentfundcode |
9153 | The submitted PersonContactDataTypeIdentifier is not a valid codelist value | The submitted PersonContactDataTypeIdentifier is not a valid codelist value |
9193 | The submitted PersonContactPersonContactDataStatusTypeIdentifier is not a valid codelist value | The submitted PersonContactPersonContactDataStatusTypeIdentifier is not a valid codelist value |
GetKontaktinformation (GET /v1/kontaktinformation/{})
(Ny metode)
Denne metode hente borgeres kontaktinformation. Disse omfatter pt. mobiltelefon, fastnet telefon og mailadresse.
| 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 |
|
|
|
|
|
|
JobCenter |
| X |
|
| X |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
Borgerkommunikation.BorgersKontaktinformationService.read
Input
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
kontaktinformationRequest |
GetkontaktinformationRequestType |
| 1 |
|
- ServiceReceipt
ServiceReceiptType
1
Service kvittering
- - EventDate
dateTime
1
- - MessageIdentifier
guid
Base: string
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
1
Fejlkoder
Fejlkode
Fejltekst
Beskrivelse
1001
Invalid cpr
The submitted cpr is either to long or short or contains data not interpretable as a date
1010
Unknown cpr
The submitted cpr is unknown to the system
1012
Logon failed
Logon failed for user
1013
Insufficient permissions
User has insufficient permissions to access this webservice
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
4986
Unknown jobcentercode
Unknown jobcentercode
4985
Unknown unemploymentfundcode
Unknown unemploymentfundcode
9153
The submitted PersonContactDataTypeIdentifier is not a valid codelist value
The submitted PersonContactDataTypeIdentifier is not a valid codelist value
9193
The submitted PersonContactPersonContactDataStatusTypeIdentifier is not a valid codelist value
- 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 | Borgers personnummer |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
getKontaktinformationResponce | GetKontaktinformationResponceRequestType |
| 1 |
|
- kontaktinformationer | KontaktinformationerDto |
| 1 | Kollektion af borgers kontaktdata. |
- - kontaktinformation | KontaktinformationDto |
| 1 - * | Borgers kontaktdata. |
- - - kontaktdata | string |
| 1 | Angivelse af mobiltelefon, fastnet telefon eller mailadresse. Hvis NULL angives eller elementet udelades slettes den angivne type af kontaktinformation. |
- - - kontaktdataType |
| 1 | Borgers kontaktform | |
- - - kontaktdatastatus | 1 | Borgers status på kontaktform |
Output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
1010 | Unknown cpr | The submitted cpr is unknown to the system |