Omgevingsdocument verbeelden

De API 'Omgevingsdocument verbeelden' is toegespitst op het verbeelden van gegevens uit Omgevingsdocumenten in een kaartbeeld. Deze API moet altijd in samenhang met de Tiles API van PDOK worden gebruikt. Deze zorgt namelijk voor de geometrie ('waar' de visualisatie op de kaart moet staan).

Label: Omgevingsdocumenten

Endpoint Pre-productieomgeving

_{https://service.pre.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/verbeelden/v3}

Endpoint Productieomgeving

_{https://service.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/verbeelden/v3}

Omschrijving

De Omgevingsdocumenten Verbeelden API is een REST API.

Deze API ontsluit gegevens uit Omgevingsdocumenten die zijn opgesteld volgens het 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 is 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).

Deze API ondersteunt geen ruimtelijke bevragingen, in tegenstelling tot bijvoorbeeld de Omgevingsdocument Presenteren API. De Verbeelden API werkt met bevragingen met locatieIdentificaties, die via de Presenteren API opgehaald worden.

Documentatie

• OpenAPI specification (JSON (json, 62 kB))
• Functionele documentatie Ozon API Omgevingsdocumenten Verbeelden v3 - versie 21 november 2022 (pdf, 684 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