Versions Compared

Key

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

5.6 CPR registret: personinformation

Stamdataservicen udstiller en REST service der, i sin nuværende form, kan anvendes til

  1. at verificere om et CPR nummer eksisterer. Servicen tager ikke hensyn til om personen f.eks. er afgået ved døden.
  2. at hente status for en given person med udgangpunkt i et CPR nummer. Denne kode kan blandt andet bruges til at afgøre om personen er afgået ved døden eller på anden måde inaktiv
    1. Servicen findes i 2 udgaver, hvor den oprindelige service returnerer status, som et positivt heltal uden foranstillede nuller, og den nye udgave af service bibeholder evt. foranstillede nuller i værdien af status.
  3. at hente alder (age) for en given person med udgangspunkt i et CPR nummer.
  4. at hente fødselsdag for en given person
  5. at hente værgemål en given person har (som forældre eller værge)
  6. at hente de navne en given person har
  7. at returnere en liste af personer der er afdøde udfra en liste af cpr numre og dato som input.

Bemærk: Denne service kan kun anvendes internt på NSP. Derfor har servicen heller ikke nogen sikkerhedsprotokol.

Servicens snitflade er beskrevet via OpenAPI og kan findes i SVN i her.


5.6.1 Endpoints

Servicen kan tilgås på nedenstående endpoint hvor stamdatahost er tilrettet den korrekte host.

  1. http://stamdatahost/stamdata-personinformation/2024/08/01/person/{cpr}
  2. http://stamdatahost/stamdata-personinformation/2024/08/01/person/{cpr}/status
  3. http://stamdatahost/stamdata-personinformation/2024/08/01/{cpr}/status
  4. http://stamdatahost/stamdata-personinformation/2024/08/01/person/{cpr}/age
  5. http://stamdatahost/stamdata-personinformation/2024/08/01/person/{cpr}/birthday
  6. http://stamdatahost/stamdata-personinformation/2024/08/01/person/{cpr}/custody
  7. http://stamdatahost/stamdata-personinformation/2024/08/01/person/{cpr}/name
  8. http://stamdatahost/stamdata-personinformation/2024/08/01/person/deceased
  9. http://stamdatahost/stamdata-personinformation/2024/08/01/person/{cpr}/address
  10. http://stamdatahost/stamdata-personinformation/2024/08/01/person/filterByStatusCode

5.6.2 Eksempel 1: Person findes

I dette eksempel kaldes servicen med et CPR nummer der eksisterer.

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/v1/person/2203954940

Response

Der svares med HTTP statuskode 200.

Code Block
languagejs
{"cpr": "2209632740"}


5.6.3 Eksempel 2: Person findes ikke

I dette eksempel kaldes servicen med et CPR nummer der IKKE eksisterer.

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/v1/person/2209632741

Response

Der svares med HTTP statuskode 404. Bemærk at Content-Type headeren også er application/json når HTTP koden 404 skyldes at CPR nummeret ikke findes.

Code Block
languagejs
{ }

5.6.4 Eksempel 3: Status hentes

I dette eksempel kaldes servicen med et CPR nummer der eksisterer, og har status 1

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/v1/person/2203954940/status

Response

Der svares med HTTP statuskode 200.

Code Block
languagejs
{"status":"1"}

5.6.5 Eksempel 4: Status hentes på person der ikke findes

I dette eksempel kaldes servicen med et CPR nummer der IKKE eksisterer.

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/v1/person/2209632741/status

Response

Der svares med HTTP statuskode 404. Bemærk at Content-Type headeren også er application/json når HTTP koden 404 skyldes at CPR nummeret ikke findes.

Code Block
languagejs
{ }

5.6.7 Eksempel 5: Alder hentes

I dette eksempel kaldes servicen med et CPR nummer der eksisterer, og har alder 29 år i 2024.

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/v1/person/2203954940/age

Response

Der svares med HTTP statuskode 200.

Code Block
languagejs
{"age":29}

5.6.8 Eksempel 6: Alder hentes på person der ikke findes

I dette eksempel kaldes servicen med et CPR nummer der IKKE eksisterer. Samme fejl fåes, hvis alder ikke kan udregnes pga manglende fødselsdato, eller hvis fødselsdatoen fejlagtigt er registreret i fremtiden.

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/v1/person/2209632741/age

Response

Der svares med HTTP statuskode 404. Bemærk at Content-Type headeren også er application/json når HTTP koden 404 skyldes at CPR nummeret ikke findes.

Code Block
languagejs
{ }

5.6.10 Eksempel 7: Fødselsdag hentes

I dette eksempel kaldes servicen med et CPR nummer der eksisterer, og fødselsdagen 22 marts 1995

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/v1/person/2203954940/birthday

Response

Der svares med HTTP statuskode 200.

Code Block
languagejs
{"birthday":"1995-03-22"}

5.6.11 Eksempel 8: Fødselsdag hentes på person der ikke findes

I dette eksempel kaldes servicen med et CPR nummer der IKKE eksisterer.

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/v1/person/2209632741/birthday

Response

Der svares med HTTP statuskode 404. Bemærk at Content-Type headeren også er application/json når HTTP koden 404 skyldes at CPR nummeret ikke findes.

Code Block
languagejs
{ }

5.6.12 Eksempel 9: Værge og forældremål hentes

I dette eksempel kaldes servicen med et CPR nummer der er forældre til 2 børn. Børnene er 20. december 2024 1 år (0612234612) henholdsvis 4 år (0711208372) gamle. CPR nummereret har også værgemål over person med cpr 2802064092.

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/v1/person/2203954940/custody

Response

Der svares med HTTP statuskode 200.

Code Block
languagejs
{"parentalCustody":[{"relationCpr":"0711208372","age":4},{"relationCpr":"0612234612","age":1}],"wardCustody":[{"relationCpr":"2802064092"}]}

5.6.13 Eksempel 10: Værge og forældremål hentes på person der ikke har sådanne

I dette eksempel kaldes servicen med et CPR der ikke har værge og fældremål

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/v1/person/2802064092/custody

Response

Der svares med HTTP statuskode 404. 

Code Block
languagejs
{ }


5.6.14 Eksempel 11: Navn hentes

I dette eksempel kaldes servicen med et CPR nummer der eksisterer, og personen har 3 navne (fornavn, mellem og efternavn).

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/v1/person/2203954940/name

Response

Der svares med HTTP statuskode 200.

Code Block
languagejs
{"givenName":"Helle","middleName":"Sejer","familyName":"Larsen","nameForAddressing":"Helle Sejer Larsen"}

5.6.15 Eksempel 12: Navn hentes på person der ikke findes

I dette eksempel kaldes servicen med et CPR nummer der IKKE eksisterer.

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/v1/person/2209632741/name

Response

Der svares med HTTP statuskode 404. Bemærk at Content-Type headeren også er application/json når HTTP koden 404 skyldes at CPR nummeret ikke findes.

Code Block
languagejs
{ }

5.6.16 Eksempel 13: Find afdøde personer

I dette eksempel kaldes servicen med en liste af CPR numre og en dato. Servicen returnere en liste af person id'er fra input listen, som tilhører afdøde personer, som døde før tidspunktet i inputtet.

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" "http://stamdatahost/stamdata-personinformation/v1/person/deceased?cpr=0810018631&cpr=2609144427&cpr=2203954940&dato=2024-05-30T17:32:28"

Response

Der svares med HTTP statuskode 200.

Code Block
languagejs
[{"cpr":"0810018631"},{"cpr":"2609144427"}]

5.6.17 Eksempel 14: Find personer adresse

I dette eksempel kaldes servicen med et CPR nummer der eksisterer og har en atkiv status-kode. Den returner personens adresse data (adresse, by og post nummer).

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/v1/person/2203954940/address

Response

Der svares med HTTP statuskode 200.

Code Block
languagejs
{"address":"Kastanievej,395,,","zipCode":"8550","cityName":"Ryomgård"}

5.6.18 Eksempel 15: Status hentes

I dette eksempel kaldes ny version af servicen med et CPR nummer der eksisterer, og har status 01. Servicen sikre i denne udgave, at foranstillede nuller bebeholdes i svaret.

Request

Request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" http://stamdatahost/stamdata-personinformation/2024/08/01/person/2203954940/status

Response

Der svares med HTTP statuskode 200.

Code Block
languagejs
{"status":"01"}

5.6.19 Eksempel 16: Find personer med status

I dette eksempel kaldes servicen med en liste af CPR numre, en statuskode og en dato. Servicen returnere en liste af person id'er fra input listen, som tilhører personer med status på tidspunktet i inputtet.

Request

Post request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" -H "Content-Type: application/json" "http://stamdatahost/stamdata-personinformation/2024/08/01/person/filterByStatusCode?statusCode=01&dato=2024-05-30T17:32:28" --data "[\"0810018631\",\"2609144427\",\"2203954940\"]"

Response

Der svares med HTTP statuskode 200.

Code Block
languagejs
[{"cpr":"2203954940"}]

5.6.20 Eksempel 17: Finder person der er født på angivede dato

I dette eksempel kaldes servicen med en dato. Servicen returnere en liste af person id'er fra input listen, som tilhører personer med status på tidspunktet i inputtet.

Request

Get request i form af curl udtryk.

Code Block
languagebash
curl -H "Accept: application/json" -H "Content-Type: application/json" "http://stamdatahost/stamdata-personinformation/v1/person/personsByBirthday?birthday=1995-03-22"

Response

Der svares med HTTP statuskode 200.

Code Block
languagejs
[{"cpr":"2203954940"}]