Versionshistorik - Version 2.0

Digitalt Samtykke API - Digitaliseringsstyrelsen

Ændringer i API v2

Ændring

Fjernet understøttelse af flere subjekter

Der er ikke længere understøttelse af flere subjekter på en Samtykkeerklæring.
Svar fra alle v2 endpoints og XML-udvekslingsformatet er opdateret til at afspejle dette.
Skemaversionen er opdateret til "2026-03" for alle skemær relateret til samtykkeerklæringer. De nye XML-namespaces har følgende format: "xxx:2026-03", eks. "urn:digst:samtykke:samtykkeerklaering:2026-03".

Ændring

Parameter omdøbt

På endpointet /v2/api/myndighed/{cvrNummer}/samtykker er query-parameteren SamtykkeGruppeSkabelonUuid omdøbt til SamtykkeSkabelonId.

Aspekt V1 V2
Parameter navn SamtykkeGruppeSkabelonUuid SamtykkeSkabelonId
Beskrivelse Hvis angivet, så ID'er på en eller flere samtykkegruppeskabeloner Hvis angivet, så ID'er på en eller flere samtykkeskabeloner. Et samtykkeSkabelonId angiver den samtykkeskabelon som samtykkegruppen og dens samtykker er dannet på baggrund af. Kan bruges til at hente ensartede samtykker ud.
Ændring

Skabelonreference på samtykkeerklæringer

Samtykkeerklæringer skal nu indeholde reference til en specifik skabelonversion ved hjælp af SkabelonUUID og SkabelonVersion. Begge felter er påkrævede i XML-udvekslingsformatet og API'et.

SkabelonUUID: UUID der identificerer skabelonen (påkrævet felt)
SkabelonVersion: Heltal der angiver versionsnummer (f.eks. 1, 2, 3) (påkrævet felt)

Vigtige egenskaber

  • En skabelonversion identificeres af UUID + Version og kan refereres af mange samtykkeerklæringer (1:N relation)
  • API'et validerer ikke at UUID + Version eksisterer i systemet - erklæringer kan referere til skabeloner der ikke findes
  • Felterne fungerer som metadata på erklæringen for sporbarhed mellem eksterne skabelonsystemer og Digitalt Samtykke
Ændring

Versionering af samtykkeerklæringsskabeloner

Samtykkeerklæringsskabeloner understøtter nu versionering. API'et returnerer alle versioner af hver skabelon, så integrationer kan se historik og få adgang til alle tilgængelige versioner.

Sådan fungerer versionering

  • Hver samtykkeerklæringsskabelon har et ErklaeringSkabelonUuid som identificerer skabelonen på tværs af versioner
  • Hver version af skabelonen har et SkabelonVersion felt (heltal: 1, 2, 3, osv.)
  • Listen af skabeloner returnerer alle versioner i Versioner-arrayet
  • Flere versioner af samme skabelon kan eksistere samtidig i systemet
  • Ved hentning af en specifik skabelon uden versionsnummer returneres den seneste version
  • Ved hentning af en specifik version af en specifik skabelon returneres den pågældende version

ErklæringSkabelon Skemaversion 2026-03

Ny version af ErklæringSkabelon-skemaet med understøttelse af kontrol over borgers tilbagekaldelsesmulighed.

Ny funktionalitet

Deaktivering af borgers tilbagekaldelsesknap

Nyt valgfrit attribut tilladBorgerTilbagekaldelse på SamtykkeSkabelonTrin-elementet i ErklæringSkabelon-skemaet.

Type: boolean
Default: true (bagudkompatibel)
Namespace: urn:digst:samtykke:samtykkeerklaeringskabelon:2026-03

Adfærd når tilladBorgerTilbagekaldelse="false":

  • Borgeren kan ikke selv tilbagekalde samtykket via selvbetjening
  • I stedet vises kontaktoplysninger for den ansvarlige myndighed
  • Myndigheden kan stadig tilbagekalde samtykket via API eller administration
Breaking change

Omdøbt RegistrerAfvisteOgIkkeValgte til RegistrerIkkeValgteValgmuligheder

Elementet RegistrerAfvisteOgIkkeValgte på SamtykkeSkabelon er blevet ændret til RegistrerIkkeValgteValgmuligheder. Dette skyldes, at navnet ikke var retvisende for funktionaliteten, hvilket angiver, om ikke-valgte valgmuligheder skal registreres som afviste i den endelige samtykkeerklæring.

Ny funktionalitet

Understøttelse af lang-attributten på html elementer

Alle accepteret HTML-elementer understøtter nu lang-attributten.

SamtykkeErklaering Skemaversion 2026-03

Ny version af SamtykkeErklaering-skemaet med påkrævet skabelonreference og længdebegrænsning på Navn-feltet.

Breaking change

Påkrævet skabelonreference i samtykkeerklæring

Samtykkeerklæringer skal nu indeholde et påkrævet element SamtykkeErklaeringSkabelonReference med reference til den samtykkeerklæringsskabelon (UUID + version) som erklæringen er baseret på.

Element: SamtykkeErklaeringSkabelonReference (påkrævet)
Child elementer:
  • SkabelonUUID - UUID for skabelonen (påkrævet)
  • SkabelonVersion - Heltal der angiver versionsnummer (påkrævet)
Namespace: urn:digst:samtykke:samtykkeerklaeringdatatyper:2026-03

Hvorfor denne ændring:

  • Gør det muligt at spore hvilken version af skabelonen en erklæring er baseret på
  • Understøtter audit og historik over tid når skabeloner opdateres
  • Felterne valideres ikke mod eksisterende skabeloner - de fungerer som metadata
Breaking change

Maksimal længde på Navn-feltet

Elementet Navn på SamtykkeErklaering har nu en maksimal længde på 200 tegn.

Element: SamtykkeErklaering/Navn
Type: Max200TekstType
Max længde: 200 tegn

Samtykke Skemaversion 2026-03

Ny version af Samtykke-udvekslingsformatet (Samtykke.xsd) med attribut for tilbagekaldelseskontrol for borger.

Ny funktionalitet

Tilbagekaldelsesindikator på samtykket

Nyt valgfrit attribut tilladerBorgerTilbagekaldelse på Samtykke-elementet i Samtykke-skemaet.

Type: boolean
Default: true (bagudkompatibel)
Namespace: urn:digst:samtykke:samtykke:2026-03

Anvendelse:

  • Angiver om borgeren selv har mulighed for at tilbagekalde samtykket eller skal kontakte myndigheden
  • Arves fra tilladBorgerTilbagekaldelse på SamtykkeSkabelonTrin i skabelonen