1. 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.

2. Yderinformation

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

  1. at hente det CVR-nummer der er tilknyttet et ydernummer.

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

Herunder gengives den aktuelle snitflade som den ser ud ved servicens oprettelse. Den mest aktuelle specifikation kan findes i sourcekoden (som pt. hostes her https://git.nspop.dk/projects/COM/repos/stamdatamodul/browse).

Open API specifikation 
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: true
          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"

2.1. Endpoints

Servicen kan tilgås på nedenstående endpoint hvor stamdatahost skal tilrettets til den aktuelle host.

  1. http://stamdatahost/stamdata-yderinformation/20241003/yder/

Bemærk, at der pt. kun findes én version af servicen, som er version "20241003". Fremtidige versioner vil ligeledes angives med en dato. 

2.2. Eksempler

2.2.1. Eksempel 1: Find CVR for ydernummer

I dette eksempel kaldes servicen med et ydernummer og en dato. Begge parametre er påkrævede. Se i øvrigt API-specifikationen længere oppe.

Request

Request i form af et curl-udtryk.

curl --location 'http://stamdatahost/stamdata-yderinformation/20241003/yder/44733/cvr?dato=2024-10-21'

Response

Der svares med HTTP statuskode 200 og følgende JSON.

{"cvr":"33257872"}


  • No labels