REST-API

Ud over OData udstiller OS2sofd et REST-API til udvalgte skrive- og udtræks-operationer. Det er dokumenteret med OpenAPI/Swagger, og den fulde, altid-aktuelle beskrivelse (endpoints, parametre og dataformater) findes i Swagger-grænsefladen:

https://kommune.sofd.io/swagger-ui.html

Alle kald autentificeres med ApiKey-headeren (se API-nøgler og adgang).

API’et er opdelt i følgende grupper:

Klassifikationer#

/api/classifications – opret, læs, opdatér og slet klassifikationer og deres items.

Organisatoriske enheder#

/api/orgUnit/... – vedligehold af visningsnavn og lokale udvidelser (localextensions) på en organisatorisk enhed.

Personer#

/api/persons/... – vedligehold af kaldenavn (chosen name) på en person.

Excel-rapporter#

/api/excel/... – hent bestillingsregler og rapporter som Excel-filer samt en liste over tilgængelige rapporter.

Øvrige /api/*-endpoints i OS2sofd er til intern brug og indgår ikke i det udstillede API. Brug Swagger-grænsefladen som den autoritative reference for, hvad der er tilgængeligt.