Versions Compared

Key

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

...

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/v1/person/{cpr}
  2. http://stamdatahost/stamdata-personinformation/v1/person/{cpr}/status
  3. http://stamdatahost/stamdata-personinformation/2024/08/01/{cpr}/status
  4. http://stamdatahost/stamdata-personinformation/v1/person/{cpr}/age
  5. http://stamdatahost/stamdata-personinformation/v1/person/{cpr}/birthday
  6. http://stamdatahost/stamdata-personinformation/v1/person/{cpr}/custody
  7. http://stamdatahost/stamdata-personinformation/v1/person/{cpr}/name
  8. http://stamdatahost/stamdata-personinformation/v1/person/deceased
  9. http://stamdatahost/stamdata-personinformation/v1/person/{cpr}/address

5.

...

6.2 Eksempel 1: Person findes

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

...

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.

...

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

...

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.

...

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.6 Eksempel 5: Status hentes på person der findes men ikke har en status

I dette eksempel kaldes servicen med et CPR nummer der eksisterer, men ikke har en status.

...

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

Code Block
languagejs
{ }

5.

...

6.7 Eksempel 6: Alder hentes

I dette eksempel kaldes servicen med et CPR nummer der eksisterer, og har alder 6 år

...

Code Block
languagejs
{"age":6}

5.

...

6.8 Eksempel 7: Alder hentes på person der ikke findes

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

...

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.9 Eksempel 8: Alder hentes på person der fines men hvor alder ikke kan beregnes.

I dette eksempel kaldes servicen med et CPR nummer der eksisterer, men hvoer der ikke er angivet en fødselsdato i den tabel alder udregnes fra. (Samme resultat fåes, hvis fødselsdatoen fejlagtig er registret i fremtiden)

...

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

Code Block
languagejs
{ }

5.

...

6.10 Eksempel 9: Fødselsdag hentes

I dette eksempel kaldes servicen med et CPR nummer der eksisterer, og fødselsdagen 24 december 2012

...

Code Block
languagejs
{"birthday":"2012-12-24"}

5.

...

6.11 Eksempel 10: Fødselsdag hentes på person der ikke findes

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

...

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 11: Værge og forældremål hentes

I dette eksempel kaldes servicen med et CPR nummer der er forældre til 2 børn på 9 og 16 år samt har værgemål over person med cpr 2209632743.

...

Code Block
languagejs
{"parentalCustody":[{"relationCpr":"2209632741","age":9},{"relationCpr":"2209632742","age":16}],"wardCustody":[{"relationCpr":"2209632743"}]}

5.

...

6.13 Eksempel 12: 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

...

Der svares med HTTP statuskode 404. 

Code Block
languagejs
{ }


5.

...

6.14 Eksempel 13: Navn hentes

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

...

Code Block
languagejs
{"givenName":"Helle","middleName":"Louise","familyName":"Eskesen","nameForAddressing":"Helle Eskesen"}

5.

...

6.15 Eksempel 14: Navn hentes på person der ikke findes

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

...

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 15: 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.

...

Code Block
languagejs
[{"cpr":"0304784567"},{"cpr":"1508902650"}]

5.

...

6.17 Eksempel 16: 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).

...

Code Block
languagejs
{"address":"Bogenhøjvej 230","zipCode":"6666","cityName":"BirkeBy"}

5.

...

6.18 Eksempel 17: 

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.

...