{ "openapi": "3.0.4", "info": { "title": "Digitalt Samtykke API v1.4", "description": "

API understøttelse for ekstern integration til Digitalt Samtykke under Digitaliseringsstyrelsen.

\n\n

Versionsændringer for V1.4

\n\n

Detaljeret oversigt over ændringer og breaking changes i API version 1.4 findes i følgende dokument:

\n\n\n\n

API Dokumentation

\n\n

Detaljeret dokumentation om adgang til API'et via Fælleskommunal Adgangsstyring og NemLog-In, XML-skemaer til validering, samt generel versionshistorik findes i følgende dokument:

\n\n\n\n

Dokumentationen af de udstillede endpoints fremgår listen af nedenfor

\n", "termsOfService": "https://www.digitaliser.dk/digitalt-samtykke/vejledninger-digitalt-samtykke/", "contact": { "name": "Digitaliseringsstyrelsen - Digitalt Samtykke", "url": "https://digst.dk/it-loesninger/digitalt-samtykke/support-til-digitalt-samtykke//", "email": "digitaltsamtykke@digst.dk" }, "version": "1.4.0" }, "servers": [ { "url": "https://api-pp-digitaltsamtykke.ssl.digst.dk", "description": "Preproduktion" } ], "paths": { "/v1/api/authorize/jwt": { "get": { "tags": [ "Authorization" ], "summary": "Veksler en autentificeret Jwt-token fra FKA STS til en Jwt-token for videre brug mod API'et\n", "description": "Forventer at anvendersystem kalder med Client Certificate, der identificerer det kaldende system.", "operationId": "Authorization_GetTokenFromJwt", "responses": { "200": { "description": "Returnerer en JSON-struktur indeholdende access-token, token_type (\"Bearer\") og expires_in jf. OIOIdws.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TokenResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TokenResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TokenResult" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } } }, "x-data-classification": "fortrolig" } }, "/v1/api/authorize/saml": { "post": { "tags": [ "Authorization" ], "summary": "Veksler en autentificeret SAML token fra NemLog-In STS til en Jwt-token for videre brug mod API'et\n", "description": "Forventer at anvendersystem kalder med Client Certificate, der identificerer det kaldende system.", "operationId": "Authorization_GetTokenFromSaml", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "saml-token": { "type": "string", "description": "En Base64-encoded SAML-token udstedt af NemLog-In STS" } } }, "encoding": { "saml-token": { "style": "form" } } } }, "required": true }, "responses": { "200": { "description": "Returnerer en JSON-struktur indeholdende access-token, token_type (\"Bearer\") og expires_in jf. OIOIdws.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TokenResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TokenResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TokenResult" } } } }, "400": { "description": "tokenBase64 er ikke et valid Base64-encoded SAML2 token.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } } }, "x-data-classification": "fortrolig" } }, "/v1/api/health": { "get": { "tags": [ "Health" ], "summary": "Generelt oppe tjek for API'et", "description": "Kræver at du er logget ind. Bemærk: der er rate limit på 1 kald per 5. minut", "operationId": "Health_Get", "responses": { "200": { "description": "API'et er sundt.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "429": { "description": "Rate limit overskredet", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } } }, "x-data-classification": "offentlig" } }, "/v1/api/myndighed/{cvrNummer}/samtykker": { "get": { "tags": [ "Samtykke" ], "summary": "Returnerer en liste af samtykker, der matcher cvrNummer.", "description": "Det er obligatorisk at filtrere på en af følgende:\n\nFor subjekt: hvis både `subjektCprNr` og `subjektCprUuid` angives, tager `subjektCprUuid` præcedens.\n\nFor giver: `giverCprNr` og `giverCprUuid` må ikke kombineres - returnerer 400 hvis begge er angivet.", "operationId": "ConsentResponse_GetAll", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR-nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } }, { "name": "SubjektCprNr", "in": "query", "description": "Hvis angivet, så CPR-nummer for 1 eller flere Subjekter som hhv Subjekt 1 eller Subjekt 2.\nHvis både `SubjektCprNr` og `SubjektCprUuid` angives, tager `SubjektCprUuid` præcedens.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "SubjektCprUuid", "in": "query", "description": "Hvis angivet, så UUID for 1 eller flere Subjekter som hhv Subjekt 1 eller Subjekt 2.\nTager præcedens over `SubjektCprNr`, hvis begge er angivet.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "SagsNummer", "in": "query", "description": "Sagsnummer", "schema": { "type": "string" } }, { "name": "SagsnummerKontekst", "in": "query", "description": "Sagskontekst", "schema": { "type": "string" } }, { "name": "LokalFagsystemId", "in": "query", "description": "ID på lokalt fagsystem", "schema": { "type": "string" } }, { "name": "SamtykkeGruppeSkabelonUuid", "in": "query", "description": "Hvis angivet, så ID'er på en eller flere samtykkegruppeskabeloner", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "AfsenderId", "in": "query", "description": "Hvis angivet, så Offentlig ID på en eller flere afsendere", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "Klassifikationer", "in": "query", "description": "Hvis angivet, en eller flere klassifikationer, der skal filteres på. Angives i formatet {navn}={værdi}", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "GiverCprNr", "in": "query", "description": "Hvis angivet, så CPR-nummer for 1 eller flere Givere som hhv Giver 1 eller Giver 2.\nMå ikke kombineres med `GiverCprUuid`.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "GiverCprUuid", "in": "query", "description": "Hvis angivet, så UUID for 1 eller flere Givere som hhv Giver 1 eller Giver 2.\nMå ikke kombineres med `GiverCprNr`.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "SamtykkeStatus", "in": "query", "description": "Hvis angivet, en eller flere samtykkestatus'er der skal filteres på. Hvis ingen værdier angives, returneres for alle.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.SamtykkeStatus" } } }, { "name": "inkluderMaskinlaesbartSamtykke", "in": "query", "description": "Angiver, hvorvidt det maskinlæsbare samtykke skal inkluderes i svaret.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Returnerer en liste af samtykker.\n \nBemærk: Yderligere informationer om samtykket kan hentes ved at angive Id i en GET request til /{samtykkeId}", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ConsentResponse.SamtykkeSimpel" } } } } }, "400": { "description": "Manglende parameter.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } } }, "x-data-classification": "følsom" } }, "/v1/api/myndighed/{cvrNummer}/samtykker/{samtykkeUuid}": { "get": { "tags": [ "Samtykke" ], "summary": "Returnerer samtykket, der matcher cvrNummer samt samtykkeUuid.", "description": "Bemærk: cvrNummer er obligatorisk", "operationId": "ConsentResponse_GetById", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR-nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } }, { "name": "samtykkeUuid", "in": "path", "description": "Offentlig nøgle (UUID) til det ønskede samtykke", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Returnerer samtykke.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ConsentResponse.Samtykke" } } } }, "404": { "description": "Det ønskede samtykke blev ikke fundet.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "403": { "description": "Manglende rettigheder til at læse samtykket.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-data-classification": "følsom" } }, "/v1/api/myndighed/{cvrNummer}/samtykker/{samtykkeUuid}/luk": { "post": { "tags": [ "Samtykke" ], "summary": "Lukker et samtykke, der matcher cvrNummer samt samtykkeUuid.", "description": "Samtykket sættes til status \"Lukket\". Kræver medarbejderinformation i request body.", "operationId": "ConsentResponse_Close", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } }, { "name": "samtykkeUuid", "in": "path", "description": "Offentlig nøgle (UUID) på samtykket, der skal lukkes", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Informationer på den medarbejder, der lukker samtykket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.LukMedarbejderInformation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.LukMedarbejderInformation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.LukMedarbejderInformation" } } }, "required": true }, "responses": { "200": { "description": "Samtykket er lukket", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "400": { "description": "Manglende eller invalide parametre.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "403": { "description": "Manglende rettigheder til at lukke samtykket", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-data-classification": "følsom" } }, "/v1/api/myndighed/{cvrNummer}/samtykker/{samtykkeUuid}/tilbagekald": { "post": { "tags": [ "Samtykke" ], "summary": "Tilbagekalder et samtykke, der matcher cvrNummer samt samtykkeUuid.", "description": "Samtykket sættes til status \"Tilbagekaldt\". Kræver medarbejderinformation og evt. borgerens godkendelse af medbetjening i request body.", "operationId": "ConsentResponse_Revoke", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } }, { "name": "samtykkeUuid", "in": "path", "description": "Offentlig nøgle (UUID) på samtykket, der skal tilbagekaldes", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Informationer om den medarbejder, der tilbagekalder samtykket, og hvordan borgeren har godkendt medbetjeningen. \n Bemærk: Det er ikke tilladt både at angive ```\"ErMundtligGodkendelse\" : true``` og samtidigt angive en underskrift.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TilbagekaldMedarbejderInformation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TilbagekaldMedarbejderInformation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TilbagekaldMedarbejderInformation" } } }, "required": true }, "responses": { "200": { "description": "Samtykket er tilbagekaldt", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "400": { "description": "Manglende eller invalide parametre.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "403": { "description": "Manglende rettigheder til at tilbagekalde samtykket", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-data-classification": "følsom" } }, "/v1/api/myndighed/{cvrNummer}/samtykkeerklaeringer": { "get": { "tags": [ "Samtykkeerklæring" ], "summary": "Returnerer en liste af samtykkeerklæringer, der matcher cvrNummer.", "description": "Bemærk: cvrNummer er obligatorisk, men de seks query parametre er valgfrie - dog skal mindst en parameter angives.\n\n For subjekt: hvis både `subjektCprNr` og `subjektCprUuid` angives, tager `subjektCprUuid` præcedens.\n\n For giver: `giverCprNr` og `giverCprUuid` må ikke kombineres - returnerer 400 hvis begge er angivet.", "operationId": "ConsentDeclaration_GetAll", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR-nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } }, { "name": "subjektCprNr", "in": "query", "description": "Subjekt, angivet med CPR-nummer. Hvis både CPR og UUID angives, tager UUID præcedens.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "subjektCprUuid", "in": "query", "description": "Subjekt, angivet med UUID. Tager præcedens over `subjektCprNr`, hvis begge er angivet.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "giverCprNr", "in": "query", "description": "Giver som enten Giver 1 eller Giver 2, angivet med CPR-nummer. Må ikke kombineres med `giverCprUuid`.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "giverCprUuid", "in": "query", "description": "Giver som enten Giver 1 eller Giver 2, angivet med UUID. Må ikke kombineres med `giverCprNr`.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "sagsNummer", "in": "query", "description": "Sagsnummer", "schema": { "type": "string" } }, { "name": "lokalFagsystemId", "in": "query", "description": "ID på lokalt fagsystem", "schema": { "type": "string" } }, { "name": "samtykkeErklaeringSkabelonUuid", "in": "query", "description": "Offentligt ID på en eller flere samtykkeerklæringersskabeloner, som en Samtykkeerklæring refererer, angivet med UUID", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "sagsnummerkontekst", "in": "query", "description": "Sagskontekst", "schema": { "type": "string" } }, { "name": "afsenderUuid", "in": "query", "description": "Offentlig ID på en eller flere afsendere", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "klassifikationer", "in": "query", "description": "Navn på en eller flere klassificeringer", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "\nBemærk: Yderligere informationer om samtykkeerklæringen kan hentes ved at angive Id i en GET request til /{samtykkeErklaeringId}", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ConsentDeclaration.SamtykkeErklaeringSimpel" } } } } }, "400": { "description": "Manglende parametre eller invalide sammenstykninger af querystring.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } } }, "x-data-classification": "følsom" }, "post": { "tags": [ "Samtykkeerklæring" ], "summary": "Opretter en Samtykkeerklæring i systemet baseret på XMLen i request body.", "description": "\n`navn`-attributten på hvert ``-element i XML'en valideres mod listen\n af gældende klassificeringstyper. Ukendte typer afvises med `400 Bad Request`.\n\nDen fulde liste af gældende klassificeringstyper kan hentes via `GET /v3/api/klassificeringstyper`.\n\nRequest body skal overholde det offentliggjorte XSD-skema: [Udvekslingsformater 2025-10](/schemas/Udvekslingsformater/2025-10).", "operationId": "ConsentDeclaration_PostDeclaration", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } } ], "requestBody": { "content": { "application/xml": { "schema": { "type": "string", "xml": { "name": "SamtykkeErklaering", "namespace": "urn:digst:samtykke:samtykkeerklaering:2025-10" } }, "x-schema-version": "2025-10" } }, "required": true }, "responses": { "400": { "description": "Valideringen af samtykkeerklæringen fejlede. En liste med fejldetaljer bliver returneret.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "201": { "description": "URL i location header, hvor den oprettede samtykkeerklæring kan hentes fra", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "403": { "description": "Manglende rettigheder til at oprette samtykkeerklæringer på det angivne CVR-nummer eller med de angivne klassifikationer", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-data-classification": "følsom" } }, "/v1/api/myndighed/{cvrNummer}/samtykkeerklaeringer/{samtykkeErklaeringUuid}": { "get": { "tags": [ "Samtykkeerklæring" ], "summary": "Returnerer udvekslingsformatet i XML, der repræsenterer samtykkeerklæringen ved oprettelsen.\nBemærk: cvrNumber er obligatorisk, og skal matche myndigheden, som samtykkeerklæringen er oprettet for.", "description": "Returnerer det originale XML-dokument, som samtykkeerklæringen blev oprettet med. Svaret er i application/xml format.", "operationId": "ConsentDeclaration_GetById", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR-nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } }, { "name": "samtykkeErklaeringUuid", "in": "path", "description": "Offentlig ID til den aktuelle samtykkeerklæring, angivet med UUID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "404": { "description": "Den ønskede samtykkeerklæring blev ikke fundet.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "200": { "description": "Returnerer udvekslingsformatet i XML, der repræsenterer samtykkeerklæringen ved oprettelsen", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "403": { "description": "Ingen adgang til at hente samtykkeerklæringen for det angivne CVR-nummer.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } } }, "x-data-classification": "følsom" } }, "/v1/api/myndighed/{cvrNummer}/samtykkeerklaeringer/{samtykkeErklaeringUuid}/sagsnummer": { "put": { "tags": [ "Samtykkeerklæring" ], "summary": "Opdaterer sagsnummer på en samtykkeerklæring, der matcher cvrNummer samt samtykkeErklaeringUuid.", "description": "Opdaterer eller fjerner sagsnummeret på den angivne samtykkeerklæring. Angiv `null` som værdi for at fjerne sagsnummeret.", "operationId": "ConsentDeclaration_UpdateSagsnummer", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } }, { "name": "samtykkeErklaeringUuid", "in": "path", "description": "Offentlig nøgle (UUID) på samtykkeerklæringen, hvorpå sagsnummeret skal opdateres", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Sagsnummeret, som samtykeerklæringen skal have tilknyttet. Angiv ```{ \"vaerdi\" : null }``` for at fjerne sagsnummer fra samtykkeerklæringen", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.Sagsnummer" } } }, "required": true }, "responses": { "400": { "description": "Valideringen af sagsnummer fejlede.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } }, "404": { "description": "Den angivne samtykkeerklæring blev ikke fundet.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "204": { "description": "Samtykkeerklæringen er blevet opdateret med sagsnummeret", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "403": { "description": "Manglende rettigheder til at ændre sagsnummer den angivne samtykkeerklæring", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-data-classification": "følsom" } }, "/v1/api/myndighed/{cvrNummer}/samtykkeerklaeringer/{samtykkeErklaeringUuid}/luk": { "post": { "tags": [ "Samtykkeerklæring" ], "summary": "Lukker alle aktive samtykker på en samtykkeerklæring der matcher cvrNummer samt samtykkeErklaeringUuid.", "description": "Alle aktive samtykker under den angivne samtykkeerklæring sættes til status \"Lukket\". Kræver medarbejderinformation i request body.", "operationId": "ConsentDeclaration_CloseConsents", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } }, { "name": "samtykkeErklaeringUuid", "in": "path", "description": "Offentlig nøgle (UUID) på samtykkeerklæringen, hvorpå samtykkerne skal lukkes", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Informationer om den medarbejder, der lukker samtykkerne", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.LukMedarbejderInformation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.LukMedarbejderInformation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.LukMedarbejderInformation" } } }, "required": true }, "responses": { "400": { "description": "Manglende eller invalide parametre.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Samtykkeerklæringen kunne ikke findes.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "200": { "description": "Samtykkerne er lukket", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "403": { "description": "Manglende rettigheder til at lukke samtykker på den angivne samtykkeerklæring", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-data-classification": "følsom" } }, "/v1/api/myndighed/{cvrNummer}/samtykkeerklaeringer/{samtykkeErklaeringUuid}/tilbagekald": { "post": { "tags": [ "Samtykkeerklæring" ], "summary": "Tilbagekalder alle aktive samtykker på en samtykkeerklæring der matcher cvrNummer samt samtykkeErklaeringUuid.", "description": "Alle aktive samtykker under den angivne samtykkeerklæring sættes til status \"Tilbagekaldt\". Kræver medarbejderinformation og evt. borgerens godkendelse af medbetjening.", "operationId": "ConsentDeclaration_Revoke", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } }, { "name": "samtykkeErklaeringUuid", "in": "path", "description": "ID på samtykkeerklæringen, hvorpå samtykkerne skal tilbagekaldes", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Informationer om den medarbejder, der tilbagekalder samtykkerne og hvordan borgeren har godkendt medbetjeningen. \n Bemærk: Det er ikke tilladt både at angive ```\"ErMundtligGodkendelse\" : true``` og samtidig angive en underskrift.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TilbagekaldMedarbejderInformation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TilbagekaldMedarbejderInformation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TilbagekaldMedarbejderInformation" } } }, "required": true }, "responses": { "400": { "description": "Manglende eller invalide parametre.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Samtykkeerklæringen kunne ikke findes.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "200": { "description": "Samtykket er tilbagekaldt", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "403": { "description": "Manglende rettigheder til at tilbagekalde samtykker på den angivne samtykkeerklæring", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-data-classification": "følsom" } }, "/v1/api/myndighed/{cvrNummer}/samtykkeerklaeringer/{sagskontekst}/{sagsnummer}/luk": { "post": { "tags": [ "Samtykkeerklæring" ], "summary": "Lukker alle aktive samtykker der matcher cvrNummer, sagskontekst samt sagsnummer og evt. dataafgrænsning.", "description": "Finder alle samtykkeerklæringer der matcher sagskontekst og sagsnummer, og lukker samtlige aktive samtykker under disse. Kræver medarbejderinformation i request body.", "operationId": "ConsentDeclaration_CloseConsentsByCaseNumber", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } }, { "name": "sagskontekst", "in": "path", "description": "Sagskonteksten for det sagsnummer, hvori samtykkerne skal lukkes", "required": true, "schema": { "type": "string" } }, { "name": "sagsnummer", "in": "path", "description": "Sagsnummeret hvori samtykkerne skal lukkes", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Informationer om den medarbejder, der lukker samtykkerne", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.LukMedarbejderInformation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.LukMedarbejderInformation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.LukMedarbejderInformation" } } }, "required": true }, "responses": { "400": { "description": "Manglende eller invalide parametre.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Samtykkeerklæringen kunne ikke findes.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "200": { "description": "Samtykkerne er lukket", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "403": { "description": "Manglende rettigheder til at lukke samtykker på en eller flere af samtykkeerklæringerne", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-data-classification": "følsom" } }, "/v1/api/myndighed/{cvrNummer}/samtykkeerklaeringer/{sagskontekst}/{sagsnummer}/tilbagekald": { "post": { "tags": [ "Samtykkeerklæring" ], "summary": "Tilbagekalder alle aktive samtykker der matcher cvrNummer, sagskontekst samt sagsnummer og evt. dataafgrænsning.", "description": "Finder alle samtykkeerklæringer der matcher sagskontekst og sagsnummer, og tilbagekalder samtlige aktive samtykker under disse. Kræver medarbejderinformation og evt. borgerens godkendelse af medbetjening.", "operationId": "ConsentDeclaration_RevokeConsentsByCaseNumber", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } }, { "name": "sagskontekst", "in": "path", "description": "Sagskonteksten for det sagsnummer, hvori samtykkerne skal tilbagekaldes.", "required": true, "schema": { "type": "string" } }, { "name": "sagsnummer", "in": "path", "description": "Sagsnummeret hvori samtykkerne skal tilbagekaldes.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Informationer om den medarbejder, der tilbagekalder samtykkerne og hvordan borgeren har godkendt medbetjeningen. \n Bemærk: Det er ikke tilladt både at angive ```\"ErMundtligGodkendelse\" : true``` og samtidig angive en underskrift.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TilbagekaldMedarbejderInformation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TilbagekaldMedarbejderInformation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.TilbagekaldMedarbejderInformation" } } }, "required": true }, "responses": { "400": { "description": "Manglende eller invalide parametre.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Samtykkeerklæringen kunne ikke findes.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "200": { "description": "Samtykket er tilbagekaldt", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "403": { "description": "Manglende rettigheder til at tilbagekalde samtykker på en eller flere af samtykkeerklæringerne", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } }, "x-data-classification": "følsom" } }, "/v1/api/myndighed/{cvrNummer}/samtykkeerklaeringsskabeloner": { "get": { "tags": [ "Samtykkeerklæringsskabelon" ], "summary": "Returnerer en liste af samtykkeerklæringsskabeloner, der matcher cvrNummer.", "description": "Returnerer grundlæggende metadata for alle tilgængelige samtykkeerklæringsskabeloner under den angivne myndighed. Brug det returnerede UUID til at hente den fulde skabelon via GET /{uuid}.", "operationId": "ConsentDeclarationTemplate_GetAll", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR-nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } } ], "responses": { "200": { "description": "Returnerer en liste af samtykkeerklæringsskabeloner.\n \nBemærk: Yderligere informationer om samtykkeerklæringsskabelon kan hentes ved at angive Id i en GET request til /{samtykkeErklaeringsSkabelonId}", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ErklaeringSkabelon" } } } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } } }, "x-data-classification": "fortrolig" } }, "/v1/api/myndighed/{cvrNummer}/samtykkeerklaeringsskabeloner/{samtykkeErklaeringsSkabelonUuid}": { "get": { "tags": [ "Samtykkeerklæringsskabelon" ], "summary": "Returnerer samtykkeerklæringsskabelon for den angivne offentlige nøgle.", "description": "Returnerer den fulde samtykkeerklæringsskabelon.\n\nReturneres som XML mht. det offentliggjorte XSD-skema: [ErklaeringSkabelon 2025-10](/schemas/ErklaeringSkabelon/2025-10).", "operationId": "ConsentDeclarationTemplate_GetById", "parameters": [ { "name": "cvrNummer", "in": "path", "description": "CVR-nummer på myndigheden.", "required": true, "schema": { "pattern": "^\\d{8}$", "type": "string" } }, { "name": "samtykkeErklaeringsSkabelonUuid", "in": "path", "description": "Offentlig nøgle til den ønskede samtykkeerklæringsskabelon", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "404": { "description": "Den ønskede samtykkeerklæringsskabelon blev ikke fundet.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "200": { "description": "Returnerer den ønskede samtykkeerklæringsskabelon i XML.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/xml": { "schema": { "type": "string", "xml": { "name": "SamtykkeErklaeringsSkabelon", "namespace": "urn:digst:samtykke:samtykkeerklaeringskabelon:2025-10" } }, "x-schema-version": "2025-10" } } }, "401": { "description": "Fejl i authorization.", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } }, "403": { "description": "Forbidden", "headers": { "X-API-Version": { "description": "SemVer version af API'et (f.eks. 2.0.0)", "schema": { "type": "string" } }, "X-Transaction-ID": { "description": "Transaktions-ID. Ekko af klientens X-Transaction-ID header, eller et nyt GUID hvis ikke angivet.", "schema": { "type": "string", "format": "uuid" } }, "X-Request-ID": { "description": "Unikt request-ID genereret af serveren for dette kald.", "schema": { "type": "string", "format": "uuid" } } } } }, "x-data-classification": "fortrolig" } } }, "components": { "schemas": { "Digst.Samtykke.Api.Contracts.V1.Adresse": { "required": [ "husnummer", "postdistrikt", "postnummer", "vejnavn" ], "type": "object", "properties": { "vejnavn": { "type": "string", "description": "Vejnavn", "nullable": true }, "husnummer": { "type": "string", "description": "Husnummer", "nullable": true }, "etagebetegnelse": { "type": "string", "description": "Etagebetegnelse (fx 1., 2., 3.)", "nullable": true }, "doerbetegnelse": { "type": "string", "description": "Dørbetegnelse (fx tv., th., mf.)", "nullable": true }, "supplerendeBynavn": { "type": "string", "description": "Supplerende bynavn (fx Højbjerg, Horsens, Østerbro)", "nullable": true }, "postnummer": { "type": "string", "description": "Postnummer", "nullable": true }, "postdistrikt": { "type": "string", "description": "Postdistrikt", "nullable": true } }, "additionalProperties": false, "description": "Beskriver en adresse" }, "Digst.Samtykke.Api.Contracts.V1.Afsender": { "required": [ "afsenderUuid", "navn" ], "type": "object", "properties": { "afsenderUuid": { "type": "string", "description": "Indeholder det offentlige ID for Anvenderen", "format": "uuid" }, "navn": { "type": "string", "description": "Indeholder navnet på Anvenderen", "nullable": true }, "adresse": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.Adresse" }, "telefonnummer": { "type": "string", "description": "Indeholder Anvenderens telefonnummer", "nullable": true }, "digitalPostKontaktPunktId": { "type": "string", "description": "Indeholder Anvenderens Digitale Post kontaktpunkt (Guid)", "format": "uuid", "nullable": true }, "webadresse": { "type": "string", "description": "Indeholder Anvenderens webadresse", "format": "uri", "nullable": true } }, "additionalProperties": false, "description": "Beskriver en Anvender" }, "Digst.Samtykke.Api.Contracts.V1.AfsenderBasic": { "required": [ "afsenderUuid", "navn" ], "type": "object", "properties": { "afsenderUuid": { "type": "string", "description": "Indeholder det offentlige ID for Anvenderen", "format": "uuid" }, "navn": { "type": "string", "description": "Indeholder navnet på Anvenderen", "nullable": true } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.Borger": { "required": [ "cpr", "navn" ], "type": "object", "properties": { "cpr": { "type": "string", "description": "Indeholder CPR-nummeret for individdet", "nullable": true }, "cprUUID": { "type": "string", "description": "Indeholder ID for individdet", "format": "uuid" }, "navn": { "type": "string", "description": "Indeholder ID for individdet", "nullable": true } }, "additionalProperties": false, "description": "Beskriver et individ som Subjekt eller Giver" }, "Digst.Samtykke.Api.Contracts.V1.ConsentDeclaration.Anmodning": { "type": "object", "properties": { "anmodningsTidspunkt": { "type": "string", "description": "Dato for anmodningen.", "format": "date-time" }, "anmodetAf": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.Medarbejder" } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.ConsentDeclaration.LokalKontekst": { "type": "object", "properties": { "lokalFagsystemID": { "type": "string", "description": "Indeholder ID genereret af et Fagsystem. Bliver ikke brugt af Digitalt Samtykke.", "nullable": true }, "sagskontekst": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ConsentDeclaration.Sagskontekst" } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.ConsentDeclaration.Sagskontekst": { "required": [ "sagsnummerkontekst" ], "type": "object", "properties": { "sagsnummer": { "type": "string", "description": "Indeholder Sagsnummer for den aktuelle samtykkeerklæring.", "nullable": true }, "sagsnummerkontekst": { "type": "string", "description": "Indeholder Sagskontekst for den aktuelle samtykkeerklæring.", "nullable": true } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.ConsentDeclaration.SamtykkeErklaering": { "required": [ "afsender", "besvarelsesTidspunkt", "givere", "links", "navn", "samtykkegivervendtBeskrivelse", "skabelonReference", "subjekter" ], "type": "object", "properties": { "samtykkeErklaeringUuid": { "type": "string", "description": "Indeholder den offentlige nøgle som reference til den aktuelle samtykkeerklæring.", "format": "uuid" }, "navn": { "type": "string", "description": "Indeholder navnet på den aktuelle samtykkeerklæring.", "nullable": true }, "klassificeringer": { "type": "array", "items": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.Klassifikation" }, "description": "Indeholder liste af klassificeringer for den aktuelle samtykkeerklæring.", "nullable": true }, "lokalKontekst": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ConsentDeclaration.LokalKontekst" }, "afsender": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.Afsender" }, "anmodning": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ConsentDeclaration.Anmodning" }, "givere": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.SamtykkeGivere" }, "subjekter": { "type": "array", "items": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.Borger" }, "description": "Indeholder de personer som samtykkeerklæringen vedrører.", "nullable": true }, "skabelonReference": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.SkabelonReference" }, "medbetjent": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.Medbetjent" }, "oplysningsErklaering": { "type": "string", "nullable": true }, "besvarelsesTidspunkt": { "type": "string", "description": "Indeholder tidspunkt for besvarelse af den aktuelle samtykkeerklæring.", "format": "date-time" }, "samtykkegivervendtBeskrivelse": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.SamtykkegivervendtBeskrivelse" }, "links": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ReferenceLinks" } }, "additionalProperties": false, "description": "Beskriver en samtykkeerklæring" }, "Digst.Samtykke.Api.Contracts.V1.ConsentDeclaration.SamtykkeErklaeringSimpel": { "required": [ "afsender", "besvarelsesTidspunkt", "givere", "links", "skabelonReference", "subjekter", "titel" ], "type": "object", "properties": { "samtykkeErklaeringUuid": { "type": "string", "description": "Indeholder den offentlige nøgle som reference til den aktuelle samtykkeerklæring.", "format": "uuid" }, "titel": { "type": "string", "description": "Indeholder navnet på den aktuelle samtykkeerklæring.", "nullable": true }, "klassificeringer": { "type": "array", "items": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.Klassifikation" }, "description": "Indeholder liste af klassificeringer for den aktuelle samtykkeerklæring.", "nullable": true }, "lokalKontekst": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ConsentDeclaration.LokalKontekst" }, "afsender": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.AfsenderBasic" }, "givere": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.SamtykkeGivere" }, "subjekter": { "type": "array", "items": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.Borger" }, "description": "Indeholder de personer som samtykkeerklæringen vedrører.", "nullable": true }, "besvarelsesTidspunkt": { "type": "string", "description": "Indeholder tidspunkt for besvarelse af den aktuelle samtykkeerklæring.", "format": "date-time" }, "skabelonReference": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.SkabelonReference" }, "links": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ReferenceLinks" } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.ConsentResponse.BrugervendtTekst": { "required": [ "overskrift" ], "type": "object", "properties": { "overskrift": { "type": "string", "nullable": true }, "indhold": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.ConsentResponse.Samtykke": { "required": [ "links", "samtykkegruppe", "status" ], "type": "object", "properties": { "samtykkeUuid": { "type": "string", "description": "Indeholder den offentlige nøgle som reference til det aktuelle samtykke.", "format": "uuid" }, "status": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.SamtykkeStatus" }, "gyldigtTil": { "type": "string", "description": "Tidspunktet, hvorefter samtykket ikke længere er gældende. Hvis samtykket bliver lukket eller tilbagekaldt vil GyldigtTil være det tidspunkt handlingen blev udført", "format": "date-time", "nullable": true }, "brugervendtTekst": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ConsentResponse.BrugervendtTekst" }, "maskinlaesbartSamtykke": { "type": "string", "description": "En maskinlæsbar version af samtykket. Digitalt Samtykke forholder sig ikke til indholdet af denne.\nDet er op til leverandøren at sikre sig, at samtykketypen kan identificeres uden tvetydighed.", "nullable": true }, "samtykkegruppe": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ConsentResponseGroup.Samtykkegruppe" }, "links": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ReferenceLinks" } }, "additionalProperties": false, "description": "Beskriver samtykket" }, "Digst.Samtykke.Api.Contracts.V1.ConsentResponse.SamtykkeSimpel": { "required": [ "links", "samtykkegruppe", "status" ], "type": "object", "properties": { "samtykkeUuid": { "type": "string", "description": "Indeholder den offentlige nøgle som reference til det aktuelle samtykke.", "format": "uuid" }, "status": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.SamtykkeStatus" }, "gyldigtTil": { "type": "string", "description": "Tidspunktet, hvorefter samtykket ikke længere er gældende. Hvis samtykket bliver lukket eller tilbagekaldt vil GyldigtTil være det tidspunkt handlingen blev udført", "format": "date-time", "nullable": true }, "maskinlaesbartSamtykke": { "type": "string", "description": "En maskinlæsbar version af samtykket. Digitalt Samtykke forholder sig ikke til indholdet af denne.\nDet er op til leverandøren at sikre sig, at samtykketypen kan identificeres uden tvetydighed.\nKun inkluderet, hvis efterspurgt.", "nullable": true }, "samtykkegruppe": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ConsentResponseGroup.SamtykkegruppeSimpel" }, "links": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ReferenceLinks" } }, "additionalProperties": false, "description": "Opsummering af samtykket. Kan indeholde MaskinlaesbartSamtykke, hvis efterspurgt i query. \nIndeholder nu samtykkegruppen, som igen indeholder samtykkeerklæringen." }, "Digst.Samtykke.Api.Contracts.V1.ConsentResponseGroup.Samtykkegruppe": { "required": [ "links", "navn", "samtykkeErklaering", "skabelonReference", "tekster", "udsagn" ], "type": "object", "properties": { "samtykkegruppeUuid": { "type": "string", "description": "Offentlig nøgle for samtykkegruppen", "format": "uuid" }, "navn": { "type": "string", "description": "Titel på samtykkegruppen", "nullable": true }, "notifikationDageIndenUdloeb": { "type": "integer", "description": "Antal dage anmeldende system skal notificeres før samtykkerne løber ud", "format": "int32", "nullable": true }, "skabelonReference": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.SkabelonReference" }, "udsagn": { "type": "string", "description": "Samtykkeudsagnet som blev præsenteret, ved besvarelse af samtykket. Dette udsagn er det samme for alle samtykkerne i samtykkegruppen.", "nullable": true }, "tekster": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ConsentResponseGroup.Tekster" }, "samtykkeErklaering": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ConsentDeclaration.SamtykkeErklaering" }, "links": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ReferenceLinks" } }, "additionalProperties": false, "description": "Beskriver samtykkegruppen\nEn samtykkegruppe er en grupering af samtykker, der alle har samme samtykkeskabelon og er afgivet i forbindelse med den samme anmodning. Samtykkegruppen indeholder informationer, der er fælles for alle samtykkerne." }, "Digst.Samtykke.Api.Contracts.V1.ConsentResponseGroup.SamtykkegruppeSimpel": { "required": [ "links", "navn", "samtykkeErklaering", "skabelonReference" ], "type": "object", "properties": { "samtykkegruppeUuid": { "type": "string", "description": "Offentlig nøgle for samtykkegruppen", "format": "uuid" }, "navn": { "type": "string", "description": "Titel på samtykkegruppen", "nullable": true }, "notifikationDageIndenUdloeb": { "type": "integer", "description": "Antal dage anmeldende system skal notificeres før samtykkerne løber ud", "format": "int32", "nullable": true }, "skabelonReference": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.SkabelonReference" }, "samtykkeErklaering": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ConsentDeclaration.SamtykkeErklaeringSimpel" }, "links": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ReferenceLinks" } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.ConsentResponseGroup.Tekster": { "required": [ "afvisningskonsekvens", "tilbagekaldelseskonsekvens", "valgfriTekster", "vilkaar" ], "type": "object", "properties": { "vilkaar": { "type": "string", "description": "Her beskrives vilkårene for samtykket.", "nullable": true }, "tilbagekaldelseskonsekvens": { "type": "string", "description": "Her beskrives konsekvenserne ved at tilbagekalde samtykket.", "nullable": true }, "afvisningskonsekvens": { "type": "string", "description": "Her beskrives konsekvenserne ved at afvise samtykket.", "nullable": true }, "valgfriTekster": { "type": "array", "items": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ValgfriTekst" }, "description": "Her listes andre tekster, der er relevante for afgivelsen af samtykket.", "nullable": true } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.ErklaeringSkabelon": { "required": [ "erklaeringSkabelonUuid", "links", "myndighed", "navn" ], "type": "object", "properties": { "navn": { "type": "string", "description": "Indeholder navnet på den aktuelle samtykkeerklæringsskabelon.", "nullable": true }, "myndighed": { "type": "string", "description": "Indeholder navnet på myndigheden.", "nullable": true }, "erklaeringSkabelonUuid": { "type": "string", "description": "Indeholder den offentlige nøgle som reference til den aktuelle samtykkeerklæringsskabelon.", "format": "uuid" }, "links": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.ReferenceLinks" } }, "additionalProperties": false, "description": "Beskriver udvalgte værdier for samtykkeerklæringsskabeloner." }, "Digst.Samtykke.Api.Contracts.V1.Klassifikation": { "required": [ "navn", "vaerdi" ], "type": "object", "properties": { "navn": { "type": "string", "description": "Indeholder Klassifikationens navn", "nullable": true }, "vaerdi": { "type": "string", "description": "Indeholder Klassifikationens værdi", "nullable": true } }, "additionalProperties": false, "description": "Beskriver klassifikationen på en samtykkeerklæring" }, "Digst.Samtykke.Api.Contracts.V1.LukMedarbejderInformation": { "required": [ "medarbejderLoginId", "medarbejderNavn" ], "type": "object", "properties": { "medarbejderNavn": { "type": "string", "nullable": true }, "medarbejderLoginId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.Medarbejder": { "required": [ "loginId", "navn" ], "type": "object", "properties": { "navn": { "type": "string", "description": "Medarbejderens navn", "nullable": true }, "loginId": { "type": "string", "description": "Medarbejderens login id. Bør identificere både authentication provider og login nøgle, ex: \"FKA:https://data.gov.dk/model/core/eid/professional/uuid/FDFFE8F1-D92C-4838-B46D-B3DD558E700E\"", "nullable": true } }, "additionalProperties": false, "description": "Beskriver en medarbejder" }, "Digst.Samtykke.Api.Contracts.V1.Medbetjent": { "required": [ "medarbejder" ], "type": "object", "properties": { "medarbejder": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.Medarbejder" }, "note": { "type": "string", "description": "Note fra medarbejderen om, hvordan den verbale godkendelse blev givet", "nullable": true }, "underskrift": { "type": "string", "description": "Borgeren var tilstede og har underskrevet handlingen udført af medarbejderen", "nullable": true } }, "additionalProperties": false, "description": "Information omkring registrering af medbetjent samtykkeerklæring." }, "Digst.Samtykke.Api.Contracts.V1.ReferenceLinks": { "type": "object", "properties": { "self": { "type": "string", "description": "Indeholder et link til den aktuelle ressource (self-link).", "nullable": true }, "borgerUi": { "type": "string", "description": "Indeholder et link til den tilsvarende visning i brugergrænsefladen for borger (UI-link).", "nullable": true }, "medarbejderUi": { "type": "string", "description": "Indeholder et link til den tilsvarende visning i brugergrænsefladen for medarbejder (UI-link).", "nullable": true } }, "additionalProperties": false, "description": "Indeholder links til relaterede ressourcer for den aktuelle entitet.\n\nKlassen følger HATEOAS-princippet og gør det muligt for klienter at navigere i API’et\nuden kendskab til faste URL-strukturer." }, "Digst.Samtykke.Api.Contracts.V1.Sagsnummer": { "required": [ "vaerdi" ], "type": "object", "properties": { "vaerdi": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.SamtykkeGiver": { "required": [ "borger", "tidspunktForHandling" ], "type": "object", "properties": { "tidspunktForHandling": { "type": "string", "description": "Tidspunktet for handlingen.", "format": "date-time" }, "borger": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.Borger" } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.SamtykkeGivere": { "required": [ "besvaretAf" ], "type": "object", "properties": { "besvaretAf": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.SamtykkeGiver" }, "bekraeftetAf": { "$ref": "#/components/schemas/Digst.Samtykke.Api.Contracts.V1.SamtykkeGiver" } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.SamtykkeStatus": { "enum": [ "Aktivt", "Afvist", "Lukket", "Udløbet", "Tilbagekaldt" ], "type": "string", "description": "Indeholder status på aktuelt samtykke." }, "Digst.Samtykke.Api.Contracts.V1.SamtykkegivervendtBeskrivelse": { "type": "object", "properties": { "htmlTekst": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.SkabelonReference": { "type": "object", "properties": { "skabelonUuid": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.TilbagekaldMedarbejderInformation": { "required": [ "erMundtligGodkendelse", "medarbejderLoginId", "medarbejderNavn" ], "type": "object", "properties": { "medarbejderNavn": { "type": "string", "nullable": true }, "medarbejderLoginId": { "type": "string", "nullable": true }, "erMundtligGodkendelse": { "type": "boolean" }, "note": { "type": "string", "nullable": true }, "underskrift": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Informationer om den medarbejder, der tilbagekalder samtykket, og hvordan borgeren har godkendt medbetjeningen. \n\nBem�rk: Det er ikke tilladt b�de at angive \"ErMundtligGodkendelse\" = true og samtidigt angive en underskrift." }, "Digst.Samtykke.Api.Contracts.V1.TokenResult": { "required": [ "access_token", "token_type" ], "type": "object", "properties": { "access_token": { "type": "string", "nullable": true }, "token_type": { "type": "string", "nullable": true }, "expires_in": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Digst.Samtykke.Api.Contracts.V1.ValgfriTekst": { "required": [ "html", "overskrift" ], "type": "object", "properties": { "overskrift": { "type": "string", "description": "Overskrift på teksten.", "nullable": true }, "html": { "type": "string", "description": "HTML-indhold af teksten.", "nullable": true } }, "additionalProperties": false, "description": "Beskriver en ekstra tekst, der kan tilføjes til samtykkeerklæringen." }, "Microsoft.AspNetCore.Mvc.ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "Microsoft.AspNetCore.Mvc.ValidationProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": { } } }, "securitySchemes": { "Bearer": { "type": "http", "description": "JWT Bearer token opnået via /authorize/jwt (FKA STS) eller /authorize/saml (NemLog-In). Se API-beskrivelsen for detaljer om token-veksling.", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "Authorization", "description": "Endpoints til autentificering og token-veksling via FKA STS eller NemLog-In." }, { "name": "Health", "description": "Sundhedstjek-endpoints til overvågning af API'ets tilgængelighed og status." }, { "name": "Samtykke", "description": "Operationer på samtykker for en given myndighed." }, { "name": "Samtykkeerklæring", "description": "Operationer på samtykkeerklæringer for en given myndighed." }, { "name": "Samtykkeerklæringsskabelon", "description": "Operationer på samtykkeerklæringsskabeloner for en given myndighed." } ], "externalDocs": { "description": "Digitalt Samtykke dokumentation hos Digitaliseringsstyrelsen", "url": "https://api-digitaltsamtykke.ssl.digst.dk/docs/getting-started.html/" }, "x-klassifikation": [ "urn:dk:kombit:KLE" ], "x-data-classification-definitions": { "offentlig": "Frit delbare data uden særlige beskyttelseskrav", "fortrolig": "Almindelige personoplysninger og forretningsdata", "følsom": "Særlige kategorier af personoplysninger (GDPR art. 9), CPR og samtykkeoplysninger" } }