Fagsystemleverandør: Nye strukturerte API-endepunkter erstatter PDF-vedlegg
Fra og med i dag vil det være nye endepunkter tilgjengelig i testmiljøet vårt. De er klare til å tas i bruk, og vi ønsker å få testet dem.
Endepunktene har som formål å fase ut ustrukturerte restdata for v0916 som i dag blir sendt via PDF-vedlegg.
Krematorier og gravplassmyndigheter prioriteres Vi oppfordrer spesielt leverandører av fagsystemer for krematorier og gravplassmyndigheter til å prioritere testing av disse endepunktene, da de trenger å kunne ta i mot både PDF og denne strukturerte dataen i en overgangsperiode.
Nye endepunkter:
GET /dgm/api/v1/definitions/grave-types: Henter typer for graverGET /dgm/api/v1/definitions/rite-types: Henter typer for seremonierGET /dgm/api/v1/funeral-petitions/{partyId}: Henter strukturerte data om en begravelsePOST /dgm/api/v1/funeral-petitions: Sender inn strukturerte data om en begravelse
Merk at alle nye endepunkter følger vårt nye versjonerte API-mønster (/dgm/api/v1/...).
Strukturerte restdata (funeral-petitions)
En viktig forutsetning for å kunne bruke "funeral-petitions" endepunktene er at en gravferdsansvarlig allerede er fastsatt i DGM. Se integrasjonsguiden for instruksjoner om hvordan dette gjøres.
Restdataene som sendes via petition-endepunktene er inndelt i tre hoveddeler:
- Ansvarsdata: Informasjon om selve ansvaret for gravferden
- Gravdata: Informasjon om gravlegging eller kremasjon
- Seremonier: Informasjon om ulike ritualer knyttet til gravferden
Separate arbeidsflytsløp:
- Ansvarsdata krever signatur fra den gravferdsansvarlige før den blir aktiv
- Gravdata vil også starte en arbeidsflyt som krever brukerinvolvering før data blir gjeldende
- Seremonier behandles umiddelbart uten ytterligere godkjenning
Typedefinisjoner (definitions)
Endepunktene for funeral-petitions krever at man angir typer for graver og seremonier. Disse typene forvaltes sentralt i DGM, og kan endres over tid:
- Nye typer kan legges til
- Eksisterende typer kan utfases
Vi anbefaler å holde fagsystemet synkronisert med DGM's gjeldende typer ved å kalle type-definisjon-endepunktene regelmessig.
Livssyklus for typer:
- Nye typer trer i kraft umiddelbart når de introduseres i DGM
- Utfasede typer vil ha et
deprecatedFrom-felt som angir fra hvilken dato typen er utdatert - DGM vil avvise nye forespørsler som bruker utfasede typer
- DGM vil fortsatt kunne levere historiske data som benytter utfasede typer
For øvrig jobbes det med å avklare disse typene på en slik måte at de ikke trenger å endres hyppig.
Ny API-versjonering
Vi moderniserer vår API-struktur med versjonert adressering:
- Stabile API-er:
/dgm/api/v1/ressursnavn - API-er under utvikling:
/dgm/api/preview/ressursnavn
De nye endepunktene er en del av denne strukturen og vil eksistere parallelt med de eldre endepunktene i en overgangsperiode.
Vår fullstendige dokumentasjon om disse endringene finnes i integrasjonsguiden.
Vi ser frem til tilbakemeldinger og erfaringer fra testingen!