Versions Compared

Key

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

...

Code Block
languageyml
titleOpen API specifikation
collapsetrue
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"


Endpoints

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

...