API-register: Overzicht

Een REST-API voor het beheren van de behandeldienst configuraties. Hierin kan een organisatie/activiteit combinatie gekoppeld worden aan een behandeldienst.

De Stelselcatalogus voor de Omgevingswet verbindt definities, toelichtingen en uitleg van concepten, regels, informatiemodellen, producten en services met elkaar.

Met deze API kunnen concepten worden opgevraagd. Van ieder concept geeft de API (voor zover relevant) de formele definitie, uitleg in klare taal, bron en gerelateerde concepten (semantische relatie, generalisatie, specialisatie, onderdeel van, bestaat uit).

Om te kunnen tijdreizen wordt metadata meegegeven:

• de datum waarop het concepte (juridisch) geldig is geworden
• de datum waarop de (juridische) geldigheid vervalt.

Concepten zijn geordend per domein. Dit domein wordt beschreven als een conceptschema. Binnen een conceptschema kunnen concepten worden geordend in collecties. De conceptschema worden federatief beheerd door de verschillende bronhouders. Bij ieder conceptschema wordt aangegeven wie de bronhouder is en daarmee verantwoordelijk is voor de inhoud.

Beschrijving van de informatie over concepten, geldigheid/provenance, collecties en datasets (op basis van Best Practices for meaningful connected computing).

Om API's te gebruiken dient bij elke request een API key meegegeven te worden (via een x-api-key header). Bij verkeerd gebruik of misbruik van de API kunnen we in contact treden en in het uiterste geval de API key intrekken.

Een REST-API voor het raadplegen en beheren van activiteiten en werkzaamheden.

De geometrieën opvragen API ontsluit alle in het DSO bekende geometrieën op basis van hun identificatie. De geometrie die hoort bij een bepaalde identificatie verandert nooit. Alle op te vragen resources zijn dan ook statisch.

Ozon biedt een service om GML, meer in het algemeen Geometrische records, te valideren. Deze geovalidatieservice ontvangt een notificatie en verwerkt deze. De service wordt ook wel het geovalidatie aanlever koppelvlak genoemd. De Geovalidatieservice API volgt de standaarden zoals beschreven in de DSO API-strategie versie 2.0.

Met deze REST API kan een regelingversie van een Omgevingsdocument in een zip-bestand worden gedownload met daarin de juridische tekst, de GIO's en de OW-objecten. Ook is het mogelijk voor een lijst locaties de geometrieën in GeoPackage-formaat (GPKG) op te vragen. De Omgevingsdocumenten Download API volgt de standaarden zoals beschreven in de DSO API-strategie versie 2.0. De Omgevingsdocumenten Download API levert informatie conform de STOP/TPOD-standaard, in het bijzonder het Conceptueel Informatiemodel Omgevingswet. Meer informatie is hier te vinden: https://www.geonovum.nl/omgevingswet/STOPTPOD

De Omgevingsdocumenten Presenteren API ontsluit beschikbaar gestelde omgevingsdocumenten op zo'n manier dat deze eenvoudig visueel te verbeelden zijn. Op de Ontwikkel, Test, Acceptatie en Pre-productieomgeving worden ook omgevingsdocumenten toegevoegd en verwijderd door beheerders voor testdoeleinden binnen en buiten de voorziening.

De Omgevingsdocumenten Presenteren API volgt de standaarden zoals beschreven in de DSO API-strategie versie 2.0. Zo is het standaard mediatype HAL (application/hal+json). Dit is een mediatype voor het weergeven van resources en hun relaties via hyperlinks.

De Omgevingsdocumenten Presenteren API levert informatie conform de STOP/TPOD-standaard, in het bijzonder het Conceptueel Informatiemodel Omgevingswet. Meer informatie is hier te vinden: https://www.geonovum.nl/omgevingswet/STOPTPOD

De Omgevingsdocumenten Verbeelden API ontsluit informatie tbv het verbeelden van beschikbaar gestelde omgevingsdocumenten. Op de Ontwikkel, Test, Acceptatie en Pre-productieomgeving worden ook omgevingsdocumenten toegevoegd en verwijderd door beheerders voor testdoeleinden binnen en buiten de voorziening. De Omgevingsdocumenten Verbeelden API volgt de standaarden zoals beschreven in de DSO API-strategie versie 1.1. Zo is het standaard mediatype HAL (application/hal+json). Dit is een mediatype voor het weergeven van resources en hun relaties via hyperlinks. Layers zijn gebaseerd op de OGC API Tiles. De Omgevingsdocumenten Verbeelden API levert informatie conform de STOP/TPOD-standaard, in het bijzonder het Conceptueel Informatiemodel Omgevingswet. Meer informatie is hier te vinden: https://www.geonovum.nl/omgevingswet/STOPTPOD

De Omgevingsinformatie ontsluiten API ontsluit omgevingsinformatie uit meerdere bronnen in samenhang. Bijvoorbeeld om te kunnen zoeken naar zowel omgevingsdocumenten in het kader van de Omgevingswet (OW), als IMRO-documenten (bestemmingsplannen en dergelijke) in het kader van de Wet op de Ruimtelijke Ordening (Wro).

Deze API volgt de standaarden zoals beschreven in de DSO API-strategie. Deze API wijkt daar op sommige punten vanaf, vooruitlopend op een nieuwe versie van de API-strategie die wordt gebaseerd op de NLGov REST API Design Rules.

Een REST-API voor het opvragen van werkzaamheden. Een werkzaamheid is een verzameling van werkzaamheid versies en wordt geïdentificeerd d.m.v. de urn. Een specifieke versie van een werkzaamheid wordt geïdentificeerd met de urn van de werkzaamheid, en een datum waarop de versie geldig is.