Omgevingsdocument presenteren

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

• Functionele documentatie Ozon API Omgevingsdocumenten Presenteren v6 - Versie 2 december 2021 (pdf, 334 kB)

Standaarden

• Standaard Officiële Publicaties (STOP/TPOD. CIM-op, CIM-OW)
• OpenAPI-standaard
• JSON-standaard
• JSON Schema
• API en URI Strategie Digitaal Stelsel Omgevingswet