Page History
| Navitabs | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Table of Contents |
|---|
Formål
Nærværende dokument indgår i den samlede dokumentationspakke for stamdataregistret på NSP. Dokumentationspakken giver tilsammen det fulde overblik over dokumentationen.
”Guide til anvendere - Yderinformation” er målrettet udviklere og arkitekter hos leverandører, som ønsker at anvende funktionaliteten udstillet af servicen "Yderinformation" i stamdataservicen.
Yderinformation
Stamdataservicen udstiller en REST service der, i sin nuværende form, kan anvendes til
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
openapi: 3.0.0
info:
title: Yder Information REST Service
description: Intern NSP service, der kan anvendes til at slå informationer om en Yder op.
version: "1.0.0"
servers:
- url: '%endpoint%'
paths:
/stamdata-yderinformation/20241003/yder/{ydernummer}/cvr:
get:
summary: Hent CVR nummer for en Yder.
description: Returnerer CVR nummeret for en Yder givet et ydernummer og en dato.
parameters:
- in: path
name: ydernummer
schema:
type: string
pattern: '^\d{6}$' # Ydernummer er præcis 6 cifre.
required: true
description: Ydernummer, der skal søges efter.
example: "010101"
- in: query
name: dato
schema:
type: string
format: date
required: truefalse
description: Dato for CVR opslag.
example: "2021-01-30"
responses:
200:
description: OK - CVR nummer fundet.
content:
application/json:
schema:
$ref: '#/components/schemas/cvr'
400:
description: Ugyldig forespørgsel (fx ugyldigt datoformat).
404:
description: Ydernummeret blev ikke fundet.
500:
description: Intern serverfejl.
components:
schemas:
cvr:
type: object
required:
- cvr
properties:
cvr:
type: string
description: CVR nummeret for Yderen.
pattern: '^\d{8}$' # CVR er præcis 8 cifre.
example: "12345678" |
...
Endpoints
Servicen kan tilgås på nedenstående endpoint hvor stamdatahost er tilrettet den korrekte skal tilrettets til den aktuelle host.
- http://stamdatahost/stamdata-personinformationyderinformation/v120241003/personyder/{cpr}
- http://stamdatahost/stamdata-personinformation/v1/person/{cpr}/status
- http://stamdatahost/stamdata-personinformation/2024/08/01/{cpr}/status
- http://stamdatahost/stamdata-personinformation/v1/person/{cpr}/age
- http://stamdatahost/stamdata-personinformation/v1/person/{cpr}/birthday
- http://stamdatahost/stamdata-personinformation/v1/person/{cpr}/custody
- http://stamdatahost/stamdata-personinformation/v1/person/{cpr}/name
- http://stamdatahost/stamdata-personinformation/v1/person/deceased
- http://stamdatahost/stamdata-personinformation/v1/person/{cpr}/address
...
Bemærk, at der pt. kun findes én version af servicen, som er version "20241003". Fremtidige versioner vil ligeledes angives med en dato.
Eksempler
Eksempel 1: Find CVR for ydernummer
I dette eksempel kaldes servicen med et CPR nummer der eksisterer ydernummer og en dato. Se i øvrigt API-specifikationen længere oppe.
Request
Request i form af et curl-udtryk.
| Code Block | ||
|---|---|---|
| ||
curl --H "Accept: application/json" location 'http://stamdatahost/stamdata-personinformationyderinformation/20241003/v1yder/person/220963274044733/cvr?dato=2024-10-21' |
Response
Der svares med HTTP statuskode 200 og følgende JSON.
| Code Block | ||
|---|---|---|
| ||
{"cprcvr": "220963274033257872"}
|