Siden beskriver de webservices på Datafordeleren, der udstiller CPR data for private anvendere.
Få en introduktion til Webservice på Datafordeleren (REST), hvis du har brug for en introduktion til og vejledning i, hvordan man kan anvende webservices, som udstilles på Datafordeleren.
Få en guide til helt konkrete anvisninger til at bruge en webservice fra Datafordeleren i Guide til webservice på Selvbetjeningen (REST).
Introduktion
Generelt
CPR private webservices udstiller udelukkende aktuelle data, og der kan ikke hentes data på personer, der har status = ’nedlagt’.I tilfælde hvor der er navne- og adressebeskyttelse på personer, vil adresser, udrejse/indrejse og navn ikke medtages i output.
Antal forekomster
Webservicemetoderne til private vil altid kun returnere 0 eller 1 forekomst. Såfremt de angivne søgeparametre giver match på flere forekomster, vil der komme et tomt resultat.Hvis du bruger count som parameter i et servicekald returneres -1 i svar, hvor der er mere end 1 resultat.
Adresser på døde personer
Døde personer har aldrig en aktuel adresse, udrejseindrejse eller forsvinding. Derfor vil personens seneste historiske adresse eller udrejse/indrejse blive vist i output. Oplysninger om forsvindinger vil altid komme med i output.Hvis personer som er døde, udrejst eller forsvundet har en kontaktadresse, vil den komme med i output.
Søgning på navne
Der kan søges på både aktuelle og historiske navnedele i tjenesten, men det er kun muligt at søge på en enkelt navnedel ud over efternavn. Særligt for parameteren navn.fornavne.eq skal man være opmærksom på, at tjenesten kun understøtter, at der søges på én fornavnedel ud over efternavnet. Hedder en person fx. Peter Frank Petersen anvendes følgende søgning: navn.fornavne.eq=Peter&navn.efternavn.eq=Petersen eller navn.fornavne.eq=Frank&navn.efternavn.eq=PetersenHvis man søger med navn.fornavne.eq=Peter%20Frank&navn.efternavn.eq=Petersen (dvs. to navnedele i fornavnet) vil det ikke virke.
Url opbygning for REST
Url for de enkelte services er opbygget af et endpoint efterfulgt af registernavn, servicenavn, versionen af servicen, servicetype (REST eller WFS etc.) samt metodenavn for REST services. Efter ? tilføjes parametre i kaldet, der kan indeholde generelle kaldeparametre for REST services og metode specifikke parametre.
Endpointet indeholder værtsnavnet, med et præfiks for miljøet hvis det ikke er produktionsmiljøet der tilgås. Hvis der er tale om fortrolige eller følsomme data, følger S5 og at servicen skal kaldes med certifikat derfor certservices - se miljøbeskrivelser.
| Url-struktur for REST services | <endpoint>/register/service/version/servicetype/metode? |
|---|---|
| Eksempel | <endpoint>= https://test04-s5-certservices.datafordeler.dk/ /register/service/version/servicetype/metode? = CPR/CprPrivateAdressName/1/rest/PrivatePersonCurrentAdressName? |
Services er specificeret til at give JSON som output, og dette er default såfremt output parameter ikke anvendes. Såfremt der angives XML som output parameter, leveres XML baseret på det specificerede JSON skema:
- Der udføres samme sæt SQL'er (data fremsøgning) uafhængigt af ønsket format, og der hentes kun data der indgår i JSON skemaet.
- Herefter formateres de fremsøgte data til det ønskede format ud fra JSON skemaet.
Om output er i XML eller JSON er et spørgsmål om syntaks og påvirker IKKE data indholdet.
Generelt om outputparametre
Hvor muligt leveres altid VirkningFra og VirkningTil samt tilhørende usikkerhedsmarkeringer.
Generelt om fejlkoder
Beskrivelsen af fejlkoder fremgår af siden Fejlkoder, som indeholder en liste over systemets fejlkoder med tilhørende beskeder og beskrivelser af fejlen.
Det Centrale Personregister (CPR)
I nedenstående afsnit beskrives de webservices på Datafordeleren, der udstiller CPR data til de private kunders anvendelse (aktuelle såvel som historiske).
| Format | JSON/XML |
|---|---|
| Sikkerhedszone | 5 - Indeholder fortrolige eller følsomme data. |
| Adgangsniveau | Indgået aftale med CPR om anvendelse af data påkrævet. |
| Anvendt udstillingsmodel | Person Udstillingsmodel forefindes: http://data.gov.dk/model/diagrammer/ |
Oversigt over services/metoder
REST service | Metode | SLA kategori | Bemærkning |
|---|---|---|---|
| CprPrivateAdressName | PrivatePersonCurrentAdressName | Almindelig | |
CprPrivateDateOfBirthName | PrivatePersonCurrentDateOfBirthName | Almindelig | Svartiderne på tjenesten kan opleves som utilstrækkelig. Der vil pågå yderligere svartidsoptimering |
| CprPrivatePNR | PrivatePersonCurrentPNR | Simpel |
SLA kategorier i produktion- maksimal svartid i sekunder:
- Simpel: 0.09
- Almindelig: 1.0
- Kompleks: 2.5
REST CprPrivateAdressName
Private kunders anvendelse af aktuelle CPR data med søgning på adresse og navn.
Metode - PrivatePersonCurrentAdressName
Url
| <endpoint>/CPR/CprPrivateAdressName/1/REST/PrivatePersonCurrentAdressName? |
Inputparametre
Obligatoriske parametre: fornavne (navn.fornavne.eq).
Enten cadr.husnummer.eq eller cadr.bygningsnummer.eq skal være angivet i servicekaldet.
| Navn | Type | Beskrivelse | Default værdi |
|---|---|---|---|
cadr.bygningsnummer.eq | String | Person.CprAdresse.bygningsnummerLigMed - Bygningsnummer er et persondatafelt, og anvendes på Grønland |
|
cadr.etage.eq | String | Person.CprAdresse.etageLigMed - Angivelse af etage i adressen |
|
cadr.husnummer.eq | String | Person.CprAdresse.husnummerLigMed - Angiver husnummer for en given bolig |
|
cadr.postnummer.eq | Integer | Person.CprAdresse.postnummerLigMed - Postnummer, |
|
cadr.sidedoer.eq | String | Person.CprAdresse.sidedoerLigMed - Sidedør nummer for en bolig |
|
cadr.vejadresseringsnavn.eq | String | Person.CprAdresse.vejadresseringsnavnLigMed - Forkortelse af adresse som bruges ved forsendelser |
|
navn.efternavn.eq | String | Person.Navn.efternavnLigMed - En persons efternavne |
|
navn.fornavne.eq | String | Person.Navn.fornavneLigMed - En persons fornavne og mellemnavne | Sammenkædning af fornavne og mellemnavn |
Outputparametre
| Metode | Skema |
|---|---|
| PrivatePersonCurrentAdressName | PersonPrivate.json Skema - filudtræk og webservices (CPR) |
REST CprPrivateDaradressName - kommer senere
Metode - PrivatePersonCurrentDaradressName
Url
| <endpoint>/CPR/CprPrivateDaradressName/1/REST/PrivatePersonCurrentDaradressName? |
Inputparametre
| Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
|---|---|---|---|---|
| navn.efternavn.eq | String | Person.Navn.efternavnLigMed - En persons efternavne | EAID_D3E09BDA_7174_4555_92F0_A7093671DCCF | |
| navn.fornavne.eq | String | Person.Navn.fornavneLigMed - En persons fornavne og mellemnavne | Konkat af fornavne og mellemnavn | |
| cadr.daradresse.eq | String | Person.CprAdresse.daradresseLigMed - Angivelse af adresseUUID | EAID_0B2FDA44_B0BA_46c7_B1E5_12720402B077 |
Outputparametre
| Metode | Skema |
|---|---|
| PrivatePersonCurrentDaradressName | PersonPrivate.json Skema - filudtræk og webservices (CPR) |
REST CprPrivateDateOfBirthName
Private kunders anvendelse af aktuelle CPR data med søgning på fødselsdato og navn.
Metode - PrivatePersonCurrentDateOfBirthName
Url
| <endpoint>/CPR/CprPrivateDateOfBirthName/1/REST/PrivatePersonCurrentDateOfBirthName? |
Inputparametre
Obligatoriske parametre: Efternavn (navn.efternavn.eq), fornavne (navn.fornavne.eq) og fødselsdato (person.foedselsdato.eq)
| Navn | Type | Beskrivelse | Default værdi |
|---|---|---|---|
navn.efternavn.eq | String | Person.Navn.efternavnLigMed - En persons efternavne |
|
navn.fornavne.eq | String | Person.Navn.fornavneLigMed - En persons fornavne og mellemnavne | Sammenkædning af fornavne og mellemnavn |
person.foedselsdato.eq | Date | Person.Person.foedselsdatoLigMed - Angiver hvilken dato fødslen har fundet sted. Datoformat følger ISO 8601 Date and time format. Alle datoer skrives med andre ord i formatet yyyy-mm-ddTHH:MM:SS - eksempelvis 2018-06-26T17:23:00 |
|
Outputparametre
| Metode | Skema |
|---|---|
| PrivatePersonCurrentDataOfBirthName | PersonPrivate.json Skema - filudtræk og webservices (CPR) |
REST CprPrivatePNR
Private kunders anvendelse af aktuelle CPR data med søgning på et personnummer.
Metode - PrivatePersonCurrentPNR
Url
| <endpoint>/CPR/CprPrivatePNR/1/REST/PrivatePersonCurrentPNR? |
Inputparametre
Obligatoriske parametre: Efternavn (navn.efternavn.eq), fornavne (navn.fornavne.eq) og fødselsdato (person.foedselsdato.eq)
| Navn | Type | Beskrivelse | Default værdi |
|---|---|---|---|
pnr.personnummer.eq | String | Person.Personnummer.personnummerLigMed - Entydig identifikation af en person i CPR |
|
Outputparametre
| Metode | Skema |
|---|---|
| PrivatePersonCurrentPNR | PersonPrivate.json Skema - filudtræk og webservices (CPR) |