Omgevingsdocument presenteren

Omgevingsdocumenten van overheden (Rijk, provincies, gemeenten en waterschappen) worden door de Landelijke Voorziening Bekendmaken en Beschikbaar stellen (LVBB) bekendgemaakt en als document beschikbaar gesteld. Met de generieke API 'Omgevingsdocument opvragen' worden gegevens uit deze documenten objectgericht ontsloten op basis van het Conceptueel Informatiemodel Omgevingswet (CIM-OW – versie 2.0.0).

De specifieke API 'Omgevingsdocument presenteren' is eveneens gebaseerd op CIM-OW (versie 2.0.0), maar toegespitst op het presenteren van gegevens uit Omgevingsdocumenten in een geo-viewer. Voor dat doel zijn sommige CIM-OW objecten aangevuld met informatie (kleur, lijndikte, etc.) voor de visualisatie op kaart van die objecten.

Dat betekent ook dat niet alle objecten uit CIM-OW in de API als afzonderlijke resources opvraagbaar zijn. Het object 'locatie' is bijvoorbeeld niet als afzonderlijke resource opvraagbaar. Andere API-resources combineren gegevens van verschillende CIM-OW-objecten tot 1 resource. Dat geldt bijvoorbeeld voor de resource \documenten\_zoek, waarmee documenten op basis van een geografische locatie opvraagbaar zijn.

Label: Omgevingsdocumenten

Endpoint Pre-productieomgeving

https://service.pre.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/presenteren/v6

Endpoint Productieomgeving

https://service.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/presenteren/v6

Omschrijving

De API ontsluit gegevens uit Omgevingsdocumenten die zijn opgesteld volgens versie 2.0.0 van CIM-OW en TPOD. De resources van de API zijn primair bedoeld voor visualisatie van gegevens op de kaart. De API volgt daarbij de DSO API-strategie en zijn te bevragen door middel van HTTP-requests. De antwoorden zijn HTTP-responses met JSON als inhoud. De antwoorden bevatten hyperlinks om te navigeren door de API volgens de HAL-specificatie (Hypertext Application Language).

Bijna alle operaties zijn op basis van HTTP GET.

Ruimtelijke bevragingen (punt, lijn, vlak) verloopt via HTTP POST. De API ondersteunt alleen ruimtelijke bevragingen in RD (EPSG:28992).

Documentatie

Standaarden


Status

Versie 6 is niet meer beschikbaar vanaf 1 januari 2023.

Versie standaard:  STOP / TPOD

API specificaties

Meer informatie

Deze service is van belang in het proces omgevingsdocumenten opvragen.

API-key

Om API's te gebruiken dient bij elke request een API-key meegegeven te worden. Alle API's werken met dezelfde key.

Feedback

Geef feedback op deze service. Ga naar het forum om je met ons bevindingen te delen.