{ "openapi": "3.0.0", "info": { "title": "Omgevingsdocumenten Presenteren", "description": "De Omgevingsdocumenten Presenteren API ontsluit beschikbaar gestelde omgevingsdocumenten \nop zo'n manier dat deze eenvoudig visueel te verbeelden zijn.\nOp de Ontwikkel, Test, Acceptatie en Pre-productieomgeving worden ook omgevingsdocumenten toegevoegd en verwijderd \ndoor beheerders voor testdoeleinden binnen en buiten de voorziening.\n\nDe Omgevingsdocumenten Presenteren API volgt de standaarden zoals beschreven in de DSO API-strategie versie 2.0. \nZo is het standaard mediatype HAL (`application/hal+json`). Dit is een mediatype voor het weergeven van resources en hun relaties via hyperlinks.\n\nDe Omgevingsdocumenten Presenteren API levert informatie conform de STOP/TPOD-standaard, in het bijzonder het Conceptueel Informatiemodel Omgevingswet.\nMeer informatie is hier te vinden: https://www.geonovum.nl/omgevingswet/STOPTPOD\n", "termsOfService": "https://developer.omgevingswet.overheid.nl/services/fair-use-policy/", "contact": { "name": "Kadaster DSO - Team Ozon", "url": "https://developer.omgevingswet.overheid.nl/services/contact/" }, "version": "8.2.5" }, "externalDocs": { "url": "https://developer.omgevingswet.overheid.nl/api-register/api/omgevingsdocument-presenteren/" }, "servers": [ { "url": "/publiek/omgevingsdocumenten/api/presenteren/v8", "description": "de API op deze server" }, { "url": "https://service.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/presenteren/v8", "description": "de API op de productieomgeving van DSO-LV" }, { "url": "https://service.pre.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/presenteren/v8", "description": "de API op de pre-productieomgeving van DSO-LV" } ], "security": [ { "apiKey": [] } ], "tags": [ { "name": "Regelingen" }, { "name": "Besluitversies" }, { "name": "Ontwerpregelingen" }, { "name": "Omgevingsvergunningen" }, { "name": "Onderwerpen" }, { "name": "Ontwerponderwerpen" } ], "paths": { "/regelingen": { "get": { "tags": [ "Regelingen" ], "summary": "Alle regelingen opvragen", "operationId": "getRegelingen", "parameters": [ { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met regelingsgebieden en ponsen", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } }, { "name": "page", "in": "query", "description": "De page moet minimaal een waarde van 1 hebben.", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "format": "int32", "example": 1, "default": 1 } }, { "name": "size", "in": "query", "description": "De pagesize moet minimaal een waarde van 1 hebben en maximaal een waarde van 200.", "required": false, "style": "form", "explode": true, "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "example": 20, "default": 20 } }, { "name": "_sort", "in": "query", "description": "Sortering van de resultaten, waarden kunnen komma gescheiden opgegeven worden, sortering is ascending, descending kan door een - teken. Indien geen sortering parameters worden meegegeven, dan wordt de default parameter gebruikt (`registratietijdstip`).", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegelingenSort" } }, "example": [ "identificatie", "-registratietijdstip" ] } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Regelingen" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/regelingen/{uriIdentificatie}": { "get": { "tags": [ "Regelingen" ], "summary": "Een enkele regeling opvragen.", "operationId": "getRegeling", "parameters": [ { "name": "uriIdentificatie", "in": "path", "description": "Een identificatie van een omgevingsdocument, zoals gedefinieerd in de STOP-standaard, waarbij de schuine strepen en koppeltekens zijn vervangen door lage streepjes (onderstrepingstekens).", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_omgevingsplan" } }, { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met regelingsgebieden en ponsen", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Regeling" } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/regelingen/_zoek": { "post": { "tags": [ "Regelingen" ], "summary": "Regelingen opvragen die voldoen aan zoekobject-parameters", "operationId": "zoekRegelingen", "parameters": [ { "name": "Content-Crs", "in": "header", "description": "De CRS van de meegeleverde geometrie-content. Wanneer de Content-Crs header ontbreekt, dan wordt de 'default' Crs aangenomen. Dat is WSG84 (CRS84) en dat ondersteunen wij niet.", "required": false, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/Crs" } }, { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met regelingsgebieden en ponsen", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } }, { "name": "page", "in": "query", "description": "De page moet minimaal een waarde van 1 hebben.", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "format": "int32", "example": 1, "default": 1 } }, { "name": "size", "in": "query", "description": "De pagesize moet minimaal een waarde van 1 hebben en maximaal een waarde van 200.", "required": false, "style": "form", "explode": true, "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "example": 20, "default": 20 } }, { "name": "_sort", "in": "query", "description": "Sortering van de resultaten, waarden kunnen komma gescheiden opgegeven worden, sortering is ascending, descending kan door een - teken", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegelingenSort" } }, "example": [ "identificatie", "-registratietijdstip" ] } ], "requestBody": { "description": "Zoekobject", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegelingZoekobject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Regelingen" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "415": { "description": "Media type wordt niet ondersteund", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Ongeldig media type", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/media_type", "title": "Ongeldig media type", "status": 415, "detail": "Content-Type: 'application/xml' wordt niet ondersteund. Geldige waarden zijn: [application/json]", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "422": { "description": "De inhoud van het verzoek kan niet worden verwerkt.\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Niet ondersteunde CRS", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/unprocessable_entity", "title": "Niet-ondersteunde CRS", "status": 422, "detail": "Deze Content-CRS header wordt niet ondersteund: http://www.opengis.net/def/crs/EPSG/9.9.1/289", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/regelingen/{uriIdentificatie}/documentstructuur": { "get": { "tags": [ "Regelingen" ], "summary": "Alle documentcomponenten van een regeling in een boomstructuur opvragen", "operationId": "getRegelingDocumentstructuur", "parameters": [ { "name": "uriIdentificatie", "in": "path", "description": "Een identificatie van een omgevingsdocument, zoals gedefinieerd in de STOP-standaard, waarbij de schuine strepen en koppeltekens zijn vervangen door lage streepjes (onderstrepingstekens).", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_omgevingsplan" } }, { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_transformXml", "in": "query", "description": "Transformeer de XML van bepaalde attributen\n\nIn het geval van `_transformXml=inhoud` worden `ref` attributen van `IORef` en `ExtIORef` elementen naar volledige URLs getransformeerd. De transformatie wordt toegepast op 'AKN', 'document', 'JCI' en 'JOIN'. Het soort is na transformatie altijd een URL.\n\nDe standaardwaarde null: er worden geen transformaties uitgevoerd.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/TransformXml" } }, { "name": "_conditieArtikel", "in": "query", "description": "Bepaal hoe het conditie-artikel wordt uitgeleverd. \n\nDe huidige standaardaanpak levert de informatie uit onder het veld 'conditieArtikel' als onderdeel van een documentcomponent. \nDeze aanpak is deprecated: de aanbevolen uitlevermethode is als eigen documentcomponent. \n\nGebruik deze query parameter om gebruik te maken van de nieuwe aanpak, deze zal op den duur de standaardmanier van uitleveren worden.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/ConditieArtikelUitlevering" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Documentstructuur" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/regelingen/{uriIdentificatie}/documentstructuur/{documentComponentWorkId}": { "get": { "tags": [ "Regelingen" ], "summary": "Alle documentcomponenten van een ontwerpregeling, die binnen het opgegeven documentcomponent vallen, in een boomstructuur opvragen\n", "operationId": "getRegelingDocumentstructuurInWorkId", "parameters": [ { "name": "uriIdentificatie", "in": "path", "description": "Een identificatie van een omgevingsdocument, zoals gedefinieerd in de STOP-standaard, waarbij de schuine strepen en koppeltekens zijn vervangen door lage streepjes (onderstrepingstekens).", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_omgevingsplan" } }, { "name": "documentComponentWorkId", "in": "path", "description": "Een identificatie vanuit het OP-deel in de vorm van een wId, welke documentcomponenten uniek identificeert over alle omgevingsdocumenten heen.\n\nZie ook: https://koop.gitlab.io/stop/standaard/1.4.0-ic/data_xsd_Element_data_wId.html\n", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "gm9999_v1__cmp_I__content_o_1__list_o_1__item_o_5" } }, { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_transformXml", "in": "query", "description": "Transformeer de XML van bepaalde attributen\n\nIn het geval van `_transformXml=inhoud` worden `ref` attributen van `IORef` en `ExtIORef` elementen naar volledige URLs getransformeerd. De transformatie wordt toegepast op 'AKN', 'document', 'JCI' en 'JOIN'. Het soort is na transformatie altijd een URL.\n\nDe standaardwaarde null: er worden geen transformaties uitgevoerd.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/TransformXml" } }, { "name": "_conditieArtikel", "in": "query", "description": "Bepaal hoe het conditie-artikel wordt uitgeleverd. \n\nDe huidige standaardaanpak levert de informatie uit onder het veld 'conditieArtikel' als onderdeel van een documentcomponent. \nDeze aanpak is deprecated: de aanbevolen uitlevermethode is als eigen documentcomponent. \n\nGebruik deze query parameter om gebruik te maken van de nieuwe aanpak, deze zal op den duur de standaardmanier van uitleveren worden.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/ConditieArtikelUitlevering" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Documentstructuur" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/regelingen/{uriIdentificatie}/voorkomens": { "get": { "tags": [ "Regelingen" ], "summary": "Alle voorkomens door de tijd van deze regeling opvragen.", "description": "Deze resource levert alle voorkomens van één regeling corresponderend met de tijdreisvraag langs de beschikbaarheids-as. \nVan ieder voorkomen wordt teruggegeven van wanneer tot wanneer het geldig is, was, of wordt, met de kennis van nu, of met de kennis van een beschikbaarOp-tijdreisparameter in het verleden zoals bekend is op het opgegeven beschikbaarheidsmoment.\nDeze resource geeft voorkomens die niet meer geldig zijn, voorkomens die nu geldig zijn, en voorkomens die geldig worden in de toekomst.\nDe voorkomens hebben hal-links naar bijbehorende objecten met hun eigen levensloop, zoals tijdelijke regelingdelen en ontwerpregelingen: - een hal-link naar een tijdelijk regelingdeel wordt opgenomen bij ieder voorkomen dat overlapt in tijd met het tijdelijk regelingdeel; - een hal-link naar een ontwerpregeling wordt opgenomen bij ieder voorkomen waarop de ontwerpregeling gebaseerd werd.\n", "operationId": "getRegelingVoorkomens", "parameters": [ { "name": "uriIdentificatie", "in": "path", "description": "Een identificatie van een omgevingsdocument, zoals gedefinieerd in de STOP-standaard, waarbij de schuine strepen en koppeltekens zijn vervangen door lage streepjes (onderstrepingstekens).", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_omgevingsplan" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "page", "in": "query", "description": "De page moet minimaal een waarde van 1 hebben.", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "format": "int32", "example": 1, "default": 1 } }, { "name": "size", "in": "query", "description": "De pagesize moet minimaal een waarde van 1 hebben en maximaal een waarde van 200.", "required": false, "style": "form", "explode": true, "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "example": 20, "default": 20 } }, { "name": "_sort", "in": "query", "description": "Sortering van de resultaten, waarden kunnen komma gescheiden opgegeven worden, sortering is ascending, descending kan door een - teken. Indien geen sortering parameters worden meegegeven, dan wordt de default parameter gebruikt (`registratietijdstip`).", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegelingVoorkomensSort" } }, "example": [ "geldigVanaf", "-registratietijdstip" ] } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Voorkomens" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/regelingen/{uriIdentificatie}/divisieannotaties": { "get": { "tags": [ "Regelingen" ], "summary": "Gestructureerde OW-objecten ophalen bij een regeling met vrije-tekststructuur.", "operationId": "getDivisieannotatiesVanRegeling", "parameters": [ { "name": "uriIdentificatie", "in": "path", "description": "Een identificatie van een omgevingsdocument, zoals gedefinieerd in de STOP-standaard, waarbij de schuine strepen en koppeltekens zijn vervangen door lage streepjes (onderstrepingstekens).", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_omgevingsplan" } }, { "name": "documentComponent", "in": "query", "description": "Een identificatie vanuit het OP-deel in de vorm van een wId, welke documentcomponenten uniek identificeert over alle omgevingsdocumenten heen.\n\nZie ook: https://koop.gitlab.io/stop/standaard/1.4.0-ic/data_xsd_Element_data_wId.html\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "gm0160_v1__chp_6__subchp_2.2__subsec_2.2.1__art_2.1" } }, { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_expand", "in": "query", "description": "Meeladen van resources", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "_expandScope", "in": "query", "description": "Welke resources worden meegeladen:\n* `registratiegegevens`: registratiegegevens van annotaties worden in `geregistreerdMet` attributen uitgeleverd.\n\nDeze queryparameter wordt alleen toegepast wanneer _expand queryparameter de waarde 'true' heeft.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/ExpandScopeVastgesteldeAnnotaties" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } }, { "name": "_extraInfo", "in": "query", "description": "Welke extra informatie kan worden opgevraagd:\n* `boundingBox`: De bounding box van locaties wordt uitgeleverd onder de `boundingBox` property.\n\nDeze informatie wordt uitgeleverd onder een `extraInfo` property bij het desbetreffende object.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExtraInfo" } } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DivisieannotatiesVastgesteld" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/regelingen/{uriIdentificatie}/divisieannotaties/_zoek": { "post": { "tags": [ "Regelingen" ], "summary": "Gestructureerde OW-objecten ophalen bij een regeling met vrije-tekststructuur, gefilterd op zoekcriteria.", "operationId": "geoZoekDivisieannotatiesVanRegeling", "parameters": [ { "name": "Content-Crs", "in": "header", "description": "De CRS van de meegeleverde geometrie-content. Wanneer de Content-Crs header ontbreekt, dan wordt de 'default' Crs aangenomen. Dat is WSG84 (CRS84) en dat ondersteunen wij niet.", "required": false, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/Crs" } }, { "name": "uriIdentificatie", "in": "path", "description": "Een identificatie van een omgevingsdocument, zoals gedefinieerd in de STOP-standaard, waarbij de schuine strepen en koppeltekens zijn vervangen door lage streepjes (onderstrepingstekens).", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_omgevingsplan" } }, { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoZoekRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DivisieannotatiesVastgesteldAtLocation" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "415": { "description": "Media type wordt niet ondersteund", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Ongeldig media type", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/media_type", "title": "Ongeldig media type", "status": 415, "detail": "Content-Type: 'application/xml' wordt niet ondersteund. Geldige waarden zijn: [application/json]", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "422": { "description": "De inhoud van het verzoek kan niet worden verwerkt.\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Niet ondersteunde CRS", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/unprocessable_entity", "title": "Niet-ondersteunde CRS", "status": 422, "detail": "Deze Content-CRS header wordt niet ondersteund: http://www.opengis.net/def/crs/EPSG/9.9.1/289", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/regelingen/{uriIdentificatie}/regeltekstannotaties": { "get": { "tags": [ "Regelingen" ], "summary": "Gestructureerde OW-objecten ophalen bij een regeling met artikelstructuur.", "operationId": "getRegeltekstannotatiesVanRegeling", "parameters": [ { "name": "uriIdentificatie", "in": "path", "description": "Een identificatie van een omgevingsdocument, zoals gedefinieerd in de STOP-standaard, waarbij de schuine strepen en koppeltekens zijn vervangen door lage streepjes (onderstrepingstekens).", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_omgevingsplan" } }, { "name": "documentComponent", "in": "query", "description": "Een identificatie vanuit het OP-deel in de vorm van een wId, welke documentcomponenten uniek identificeert over alle omgevingsdocumenten heen.\n\nZie ook: https://koop.gitlab.io/stop/standaard/1.4.0-ic/data_xsd_Element_data_wId.html\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "gm0160_v1__chp_6__subchp_2.2__subsec_2.2.1__art_2.1" } }, { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_expand", "in": "query", "description": "Meeladen van resources", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "_expandScope", "in": "query", "description": "Welke resources worden meegeladen:\n* `registratiegegevens`: registratiegegevens van annotaties worden in `geregistreerdMet` attributen uitgeleverd.\n\nDeze queryparameter wordt alleen toegepast wanneer _expand queryparameter de waarde 'true' heeft.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/ExpandScopeVastgesteldeAnnotaties" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } }, { "name": "_extraInfo", "in": "query", "description": "Welke extra informatie kan worden opgevraagd:\n* `boundingBox`: De bounding box van locaties wordt uitgeleverd onder de `boundingBox` property.\n\nDeze informatie wordt uitgeleverd onder een `extraInfo` property bij het desbetreffende object.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExtraInfo" } } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/RegeltekstannotatiesVastgesteld" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/regelingen/{uriIdentificatie}/regeltekstannotaties/_zoek": { "post": { "tags": [ "Regelingen" ], "summary": "Gestructureerde OW-objecten ophalen bij een regeling met artikelstructuur, gefilterd op zoekcriteria.", "operationId": "geoZoekRegeltekstannotatiesVanRegeling", "parameters": [ { "name": "Content-Crs", "in": "header", "description": "De CRS van de meegeleverde geometrie-content. Wanneer de Content-Crs header ontbreekt, dan wordt de 'default' Crs aangenomen. Dat is WSG84 (CRS84) en dat ondersteunen wij niet.", "required": false, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/Crs" } }, { "name": "uriIdentificatie", "in": "path", "description": "Een identificatie van een omgevingsdocument, zoals gedefinieerd in de STOP-standaard, waarbij de schuine strepen en koppeltekens zijn vervangen door lage streepjes (onderstrepingstekens).", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_omgevingsplan" } }, { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoZoekRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/RegeltekstannotatiesVastgesteldAtLocation" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "415": { "description": "Media type wordt niet ondersteund", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Ongeldig media type", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/media_type", "title": "Ongeldig media type", "status": 415, "detail": "Content-Type: 'application/xml' wordt niet ondersteund. Geldige waarden zijn: [application/json]", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "422": { "description": "De inhoud van het verzoek kan niet worden verwerkt.\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Niet ondersteunde CRS", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/unprocessable_entity", "title": "Niet-ondersteunde CRS", "status": 422, "detail": "Deze Content-CRS header wordt niet ondersteund: http://www.opengis.net/def/crs/EPSG/9.9.1/289", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/afbeeldingen/{bevoegdGezag}/{versieIdentificatie}/{bestandsnaam}": { "get": { "tags": [ "Regelingen" ], "summary": "Een afbeelding uit een document opvragen.", "operationId": "getDocumentAfbeelding", "parameters": [ { "name": "bevoegdGezag", "in": "path", "description": "Code van het bevoegd gezag, uit één van onderstaande waardelijsten:\n - https://identifier.overheid.nl/tooi/set/rwc_gemeenten_compleet\n - https://identifier.overheid.nl/tooi/set/rwc_ministeries_compleet\n - https://identifier.overheid.nl/tooi/set/rwc_provincies_compleet\n - https://identifier.overheid.nl/tooi/set/rwc_waterschappen_compleet\n", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "gm0000" } }, { "name": "versieIdentificatie", "in": "path", "description": "Een identificatie die verwijst naar de versie een omgevingsdocument.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "/akn/nl/act/gm1773/2020/omgevingsplan/nld@2025-06-11" } }, { "name": "bestandsnaam", "in": "path", "description": "De naam van het op te vragen bestand.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "Afbeelding.png" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "image/*": { "schema": { "$ref": "#/components/schemas/Afbeelding" } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-auth-type": "None" } }, "/besluitversies": { "get": { "tags": [ "Besluitversies" ], "summary": "Metadata van besluitversies opvragen", "operationId": "getBesluitversies", "parameters": [ { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met geconsolideerde regelingsgebieden", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } }, { "name": "page", "in": "query", "description": "De page moet minimaal een waarde van 1 hebben.", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "format": "int32", "example": 1, "default": 1 } }, { "name": "size", "in": "query", "description": "De pagesize moet minimaal een waarde van 1 hebben en maximaal een waarde van 200.", "required": false, "style": "form", "explode": true, "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "example": 20, "default": 20 } }, { "name": "_sort", "in": "query", "description": "Sortering van de resultaten, waarden kunnen komma gescheiden opgegeven worden, sortering is ascending, descending kan door een - teken. Indien geen sortering parameters worden meegegeven, dan wordt de default parameter gebruikt (`registratietijdstip`).", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BesluitversiesSort" } }, "example": [ "identificatie", "-registratietijdstip" ] } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Besluitversies" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/besluitversies/{technischId}": { "get": { "tags": [ "Besluitversies" ], "summary": "Metadata van een enkele besluitversie opvragen", "operationId": "getBesluitversie", "parameters": [ { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met geconsolideerde regelingsgebieden", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Besluitversie" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/besluitversies/{technischId}/documentstructuur": { "get": { "tags": [ "Besluitversies" ], "summary": "Alle documentcomponenten van een besluitversie in een boomstructuur opvragen", "operationId": "getBesluitversieDocumentstructuur", "parameters": [ { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "_transformXml", "in": "query", "description": "Transformeer de XML van bepaalde attributen\n\nIn het geval van `_transformXml=inhoud` worden `ref` attributen van `IORef` en `ExtIORef` elementen naar volledige URLs getransformeerd. De transformatie wordt toegepast op 'AKN', 'document', 'JCI' en 'JOIN'. Het soort is na transformatie altijd een URL.\n\nDe standaardwaarde null: er worden geen transformaties uitgevoerd.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/TransformXml" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_conditieArtikel", "in": "query", "description": "Bepaal hoe het conditie-artikel wordt uitgeleverd. \n\nDe huidige standaardaanpak levert de informatie uit onder het veld 'conditieArtikel' als onderdeel van een documentcomponent. \nDeze aanpak is deprecated: de aanbevolen uitlevermethode is als eigen documentcomponent. \n\nGebruik deze query parameter om gebruik te maken van de nieuwe aanpak, deze zal op den duur de standaardmanier van uitleveren worden.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/ConditieArtikelUitlevering" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/BesluitversieDocumentstructuur" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/besluitversies/{technischId}/documentstructuur/{documentComponentWorkId}": { "get": { "tags": [ "Besluitversies" ], "summary": "Alle documentcomponenten van een besluitversie, die binnen het opgegeven documentcomponent vallen, in een boomstructuur opvragen\n", "operationId": "getBesluitversieDocumentstructuurInWorkId", "parameters": [ { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "documentComponentWorkId", "in": "path", "description": "Een identificatie vanuit het OP-deel in de vorm van een wId, welke documentcomponenten uniek identificeert over alle omgevingsdocumenten heen.\n\nZie ook: https://koop.gitlab.io/stop/standaard/1.4.0-ic/data_xsd_Element_data_wId.html\n", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "gm9999_v1__cmp_I__content_o_1__list_o_1__item_o_5" } }, { "name": "_transformXml", "in": "query", "description": "Transformeer de XML van bepaalde attributen\n\nIn het geval van `_transformXml=inhoud` worden `ref` attributen van `IORef` en `ExtIORef` elementen naar volledige URLs getransformeerd. De transformatie wordt toegepast op 'AKN', 'document', 'JCI' en 'JOIN'. Het soort is na transformatie altijd een URL.\n\nDe standaardwaarde null: er worden geen transformaties uitgevoerd.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/TransformXml" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_conditieArtikel", "in": "query", "description": "Bepaal hoe het conditie-artikel wordt uitgeleverd. \n\nDe huidige standaardaanpak levert de informatie uit onder het veld 'conditieArtikel' als onderdeel van een documentcomponent. \nDeze aanpak is deprecated: de aanbevolen uitlevermethode is als eigen documentcomponent. \n\nGebruik deze query parameter om gebruik te maken van de nieuwe aanpak, deze zal op den duur de standaardmanier van uitleveren worden.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/ConditieArtikelUitlevering" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/BesluitversieDocumentstructuur" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/besluitversies/{technischId}/divisieannotaties/renvooi": { "get": { "tags": [ "Besluitversies" ], "summary": "Gestructureerde OW-objecten en wijzigingen ophalen die laten zien hoe de gegeven besluitversie\nmet vrije-tekststructuur is gewijzigd ten opzichte van de voorgaande versie.\n", "operationId": "getDivisieannotatiesVanBesluitversie", "parameters": [ { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "documentComponent", "in": "query", "description": "Een identificatie vanuit het OP-deel in de vorm van een wId, welke documentcomponenten uniek identificeert over alle omgevingsdocumenten heen.\n\nZie ook: https://koop.gitlab.io/stop/standaard/1.4.0-ic/data_xsd_Element_data_wId.html\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "gm0160_v1__chp_6__subchp_2.2__subsec_2.2.1__art_2.1" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DivisieannotatiesBesluitRenvooi" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/besluitversies/{technischId}/divisieannotaties/renvooi/_zoek": { "post": { "tags": [ "Besluitversies" ], "summary": "Een enkele besluitversie ophalen met vrijetekststructuur objecten gefilterd op zoekcriteria", "operationId": "geoZoekDivisieannotatiesVanBesluitversie", "parameters": [ { "name": "Content-Crs", "in": "header", "description": "De CRS van de meegeleverde geometrie-content. Wanneer de Content-Crs header ontbreekt, dan wordt de 'default' Crs aangenomen. Dat is WSG84 (CRS84) en dat ondersteunen wij niet.", "required": false, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/Crs" } }, { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoZoekRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DivisieannotatiesRenvooiAtLocation" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "415": { "description": "Media type wordt niet ondersteund", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Ongeldig media type", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/media_type", "title": "Ongeldig media type", "status": 415, "detail": "Content-Type: 'application/xml' wordt niet ondersteund. Geldige waarden zijn: [application/json]", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "422": { "description": "De inhoud van het verzoek kan niet worden verwerkt.\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Niet ondersteunde CRS", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/unprocessable_entity", "title": "Niet-ondersteunde CRS", "status": 422, "detail": "Deze Content-CRS header wordt niet ondersteund: http://www.opengis.net/def/crs/EPSG/9.9.1/289", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/besluitversies/{technischId}/regeltekstannotaties/renvooi": { "get": { "tags": [ "Besluitversies" ], "summary": "Gestructureerde OW-objecten en wijzigingen ophalen die laten zien hoe de gegeven besluitversie\nmet artikelstructuur is gewijzigd ten opzichte van de voorgaande versie.\n", "operationId": "getRegeltekstannotatiesVanBesluitversie", "parameters": [ { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "documentComponent", "in": "query", "description": "Een identificatie vanuit het OP-deel in de vorm van een wId, welke documentcomponenten uniek identificeert over alle omgevingsdocumenten heen.\n\nZie ook: https://koop.gitlab.io/stop/standaard/1.4.0-ic/data_xsd_Element_data_wId.html\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "gm0160_v1__chp_6__subchp_2.2__subsec_2.2.1__art_2.1" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/RegeltekstannotatiesBesluitRenvooi" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/besluitversies/{technischId}/regeltekstannotaties/renvooi/_zoek": { "post": { "tags": [ "Besluitversies" ], "summary": "Een enkele besluitversie ophalen met artikel-gestructureerde objecten gefilterd op zoekcriteria", "operationId": "geoZoekRegeltekstannotatiesVanBesluitversie", "parameters": [ { "name": "Content-Crs", "in": "header", "description": "De CRS van de meegeleverde geometrie-content. Wanneer de Content-Crs header ontbreekt, dan wordt de 'default' Crs aangenomen. Dat is WSG84 (CRS84) en dat ondersteunen wij niet.", "required": false, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/Crs" } }, { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoZoekRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/RegeltekstannotatiesRenvooiAtLocation" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "415": { "description": "Media type wordt niet ondersteund", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Ongeldig media type", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/media_type", "title": "Ongeldig media type", "status": 415, "detail": "Content-Type: 'application/xml' wordt niet ondersteund. Geldige waarden zijn: [application/json]", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "422": { "description": "De inhoud van het verzoek kan niet worden verwerkt.\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Niet ondersteunde CRS", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/unprocessable_entity", "title": "Niet-ondersteunde CRS", "status": 422, "detail": "Deze Content-CRS header wordt niet ondersteund: http://www.opengis.net/def/crs/EPSG/9.9.1/289", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/ontwerpregelingen": { "get": { "tags": [ "Ontwerpregelingen" ], "summary": "Alle ontwerpregelingen opvragen", "operationId": "getOntwerpregelingen", "parameters": [ { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met regelingsgebieden en ontwerpregelingsgebieden", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } }, { "name": "page", "in": "query", "description": "De page moet minimaal een waarde van 1 hebben.", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "format": "int32", "example": 1, "default": 1 } }, { "name": "size", "in": "query", "description": "De pagesize moet minimaal een waarde van 1 hebben en maximaal een waarde van 200.", "required": false, "style": "form", "explode": true, "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "example": 20, "default": 20 } }, { "name": "_sort", "in": "query", "description": "Sortering van de resultaten, waarden kunnen komma gescheiden opgegeven worden, sortering is ascending, descending kan door een - teken. Indien geen sortering parameters worden meegegeven, dan wordt de default parameter gebruikt (`registratietijdstip`).", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OntwerpregelingenSort" } }, "example": [ "identificatie", "-registratietijdstip" ] } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Ontwerpregelingen" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/ontwerpregelingen/{technischId}": { "get": { "tags": [ "Ontwerpregelingen" ], "summary": "Een enkel ontwerpregeling opvragen.", "operationId": "getOntwerpRegeling", "parameters": [ { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met regelingsgebieden en ontwerpregelingsgebieden", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Ontwerpregeling" } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/ontwerpregelingen/_zoek": { "post": { "tags": [ "Ontwerpregelingen" ], "summary": "Regelingen opvragen die voldoen aan zoekobject-parameters", "operationId": "zoekOntwerpregelingen", "parameters": [ { "name": "Content-Crs", "in": "header", "description": "De CRS van de meegeleverde geometrie-content. Wanneer de Content-Crs header ontbreekt, dan wordt de 'default' Crs aangenomen. Dat is WSG84 (CRS84) en dat ondersteunen wij niet.", "required": false, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/Crs" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met regelingsgebieden en ontwerpregelingsgebieden", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } }, { "name": "page", "in": "query", "description": "De page moet minimaal een waarde van 1 hebben.", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "format": "int32", "example": 1, "default": 1 } }, { "name": "size", "in": "query", "description": "De pagesize moet minimaal een waarde van 1 hebben en maximaal een waarde van 200.", "required": false, "style": "form", "explode": true, "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "example": 20, "default": 20 } }, { "name": "_sort", "in": "query", "description": "Sortering van de resultaten, waarden kunnen komma gescheiden opgegeven worden, sortering is ascending, descending kan door een - teken", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OntwerpregelingenSort" } }, "example": [ "identificatie", "-registratietijdstip" ] } ], "requestBody": { "description": "Zoekobject", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OntwerpregelingZoekobject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Ontwerpregelingen" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "415": { "description": "Media type wordt niet ondersteund", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Ongeldig media type", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/media_type", "title": "Ongeldig media type", "status": 415, "detail": "Content-Type: 'application/xml' wordt niet ondersteund. Geldige waarden zijn: [application/json]", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "422": { "description": "De inhoud van het verzoek kan niet worden verwerkt.\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Niet ondersteunde CRS", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/unprocessable_entity", "title": "Niet-ondersteunde CRS", "status": 422, "detail": "Deze Content-CRS header wordt niet ondersteund: http://www.opengis.net/def/crs/EPSG/9.9.1/289", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/ontwerpregelingen/{technischId}/divisieannotaties/renvooi": { "get": { "tags": [ "Ontwerpregelingen" ], "summary": "Gestructureerde OW-objecten en beoogde wijzigingen ophalen bij een ontwerpregeling met vrije-tekststructuur.", "operationId": "getDivisieannotatiesVanOntwerpregeling", "parameters": [ { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "documentComponent", "in": "query", "description": "Een identificatie vanuit het OP-deel in de vorm van een wId, welke documentcomponenten uniek identificeert over alle omgevingsdocumenten heen.\n\nZie ook: https://koop.gitlab.io/stop/standaard/1.4.0-ic/data_xsd_Element_data_wId.html\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "gm0160_v1__chp_6__subchp_2.2__subsec_2.2.1__art_2.1" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } }, { "name": "_extraInfo", "in": "query", "description": "Welke extra informatie kan worden opgevraagd:\n* `boundingBox`: De bounding box van locaties wordt uitgeleverd onder de `boundingBox` property.\n\nDeze informatie wordt uitgeleverd onder een `extraInfo` property bij het desbetreffende object.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExtraInfo" } } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DivisieannotatiesOntwerpRenvooi" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/ontwerpregelingen/{technischId}/regeltekstannotaties/renvooi": { "get": { "tags": [ "Ontwerpregelingen" ], "summary": "Gestructureerde OW-objecten en beoogde wijzigingen ophalen bij een ontwerpregeling met artikelstructuur.", "operationId": "getRegeltekstannotatiesVanOntwerpregeling", "parameters": [ { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "documentComponent", "in": "query", "description": "Een identificatie vanuit het OP-deel in de vorm van een wId, welke documentcomponenten uniek identificeert over alle omgevingsdocumenten heen.\n\nZie ook: https://koop.gitlab.io/stop/standaard/1.4.0-ic/data_xsd_Element_data_wId.html\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "gm0160_v1__chp_6__subchp_2.2__subsec_2.2.1__art_2.1" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } }, { "name": "_extraInfo", "in": "query", "description": "Welke extra informatie kan worden opgevraagd:\n* `boundingBox`: De bounding box van locaties wordt uitgeleverd onder de `boundingBox` property.\n\nDeze informatie wordt uitgeleverd onder een `extraInfo` property bij het desbetreffende object.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExtraInfo" } } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/RegeltekstannotatiesOntwerpRenvooi" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/ontwerpregelingen/{technischId}/documentstructuur": { "get": { "tags": [ "Ontwerpregelingen" ], "summary": "Alle documentcomponenten van een ontwerpregeling in een boomstructuur opvragen", "operationId": "getOntwerpregelingDocumentstructuur", "parameters": [ { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_transformXml", "in": "query", "description": "Transformeer de XML van bepaalde attributen\n\nIn het geval van `_transformXml=inhoud` worden `ref` attributen van `IORef` en `ExtIORef` elementen naar volledige URLs getransformeerd. De transformatie wordt toegepast op 'AKN', 'document', 'JCI' en 'JOIN'. Het soort is na transformatie altijd een URL.\n\nDe standaardwaarde null: er worden geen transformaties uitgevoerd.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/TransformXml" } }, { "name": "_conditieArtikel", "in": "query", "description": "Bepaal hoe het conditie-artikel wordt uitgeleverd. \n\nDe huidige standaardaanpak levert de informatie uit onder het veld 'conditieArtikel' als onderdeel van een documentcomponent. \nDeze aanpak is deprecated: de aanbevolen uitlevermethode is als eigen documentcomponent. \n\nGebruik deze query parameter om gebruik te maken van de nieuwe aanpak, deze zal op den duur de standaardmanier van uitleveren worden.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/ConditieArtikelUitlevering" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/OntwerpDocumentstructuur" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/ontwerpregelingen/{technischId}/documentstructuur/{documentComponentWorkId}": { "get": { "tags": [ "Ontwerpregelingen" ], "summary": "Alle documentcomponenten van een ontwerpregeling, die binnen het opgegeven documentcomponent vallen, in een boomstructuur opvragen\n", "operationId": "getOntwerpregelingDocumentstructuurInWorkId", "parameters": [ { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "documentComponentWorkId", "in": "path", "description": "Een identificatie vanuit het OP-deel in de vorm van een wId, welke documentcomponenten uniek identificeert over alle omgevingsdocumenten heen.\n\nZie ook: https://koop.gitlab.io/stop/standaard/1.4.0-ic/data_xsd_Element_data_wId.html\n", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "gm9999_v1__cmp_I__content_o_1__list_o_1__item_o_5" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_transformXml", "in": "query", "description": "Transformeer de XML van bepaalde attributen\n\nIn het geval van `_transformXml=inhoud` worden `ref` attributen van `IORef` en `ExtIORef` elementen naar volledige URLs getransformeerd. De transformatie wordt toegepast op 'AKN', 'document', 'JCI' en 'JOIN'. Het soort is na transformatie altijd een URL.\n\nDe standaardwaarde null: er worden geen transformaties uitgevoerd.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/TransformXml" } }, { "name": "_conditieArtikel", "in": "query", "description": "Bepaal hoe het conditie-artikel wordt uitgeleverd. \n\nDe huidige standaardaanpak levert de informatie uit onder het veld 'conditieArtikel' als onderdeel van een documentcomponent. \nDeze aanpak is deprecated: de aanbevolen uitlevermethode is als eigen documentcomponent. \n\nGebruik deze query parameter om gebruik te maken van de nieuwe aanpak, deze zal op den duur de standaardmanier van uitleveren worden.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/ConditieArtikelUitlevering" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/OntwerpDocumentstructuur" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/ontwerpregelingen/{technischId}/regeltekstannotaties/renvooi/_zoek": { "post": { "tags": [ "Ontwerpregelingen" ], "summary": "Een enkele ontwerpregeling ophalen met artikel-gestructureerde objecten gefilterd op zoekcriteria", "operationId": "geoZoekRegeltekstannotatiesVanOntwerpregeling", "parameters": [ { "name": "Content-Crs", "in": "header", "description": "De CRS van de meegeleverde geometrie-content. Wanneer de Content-Crs header ontbreekt, dan wordt de 'default' Crs aangenomen. Dat is WSG84 (CRS84) en dat ondersteunen wij niet.", "required": false, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/Crs" } }, { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoZoekRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/RegeltekstannotatiesRenvooiAtLocation" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "415": { "description": "Media type wordt niet ondersteund", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Ongeldig media type", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/media_type", "title": "Ongeldig media type", "status": 415, "detail": "Content-Type: 'application/xml' wordt niet ondersteund. Geldige waarden zijn: [application/json]", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "422": { "description": "De inhoud van het verzoek kan niet worden verwerkt.\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Niet ondersteunde CRS", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/unprocessable_entity", "title": "Niet-ondersteunde CRS", "status": 422, "detail": "Deze Content-CRS header wordt niet ondersteund: http://www.opengis.net/def/crs/EPSG/9.9.1/289", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/ontwerpregelingen/{technischId}/divisieannotaties/renvooi/_zoek": { "post": { "tags": [ "Ontwerpregelingen" ], "summary": "Een enkele ontwerpregeling ophalen met vrijetekststructuur-objecten gefilterd op zoekcriteria", "operationId": "geoZoekDivisieannotatiesVanOntwerpregeling", "parameters": [ { "name": "Content-Crs", "in": "header", "description": "De CRS van de meegeleverde geometrie-content. Wanneer de Content-Crs header ontbreekt, dan wordt de 'default' Crs aangenomen. Dat is WSG84 (CRS84) en dat ondersteunen wij niet.", "required": false, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/Crs" } }, { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoZoekRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/DivisieannotatiesRenvooiAtLocation" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "415": { "description": "Media type wordt niet ondersteund", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Ongeldig media type", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/media_type", "title": "Ongeldig media type", "status": 415, "detail": "Content-Type: 'application/xml' wordt niet ondersteund. Geldige waarden zijn: [application/json]", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "422": { "description": "De inhoud van het verzoek kan niet worden verwerkt.\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Niet ondersteunde CRS", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/unprocessable_entity", "title": "Niet-ondersteunde CRS", "status": 422, "detail": "Deze Content-CRS header wordt niet ondersteund: http://www.opengis.net/def/crs/EPSG/9.9.1/289", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/ontwerpafbeeldingen/{bevoegdGezag}/{ontwerpbesluitIdentificatie}/{bestandsnaam}": { "get": { "tags": [ "Ontwerpregelingen" ], "summary": "Een afbeelding uit een document opvragen.", "operationId": "getOntwerpDocumentAfbeelding", "parameters": [ { "name": "bevoegdGezag", "in": "path", "description": "Code van het bevoegd gezag, uit één van onderstaande waardelijsten:\n - https://identifier.overheid.nl/tooi/set/rwc_gemeenten_compleet\n - https://identifier.overheid.nl/tooi/set/rwc_ministeries_compleet\n - https://identifier.overheid.nl/tooi/set/rwc_provincies_compleet\n - https://identifier.overheid.nl/tooi/set/rwc_waterschappen_compleet\n", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "gm0000" } }, { "name": "ontwerpbesluitIdentificatie", "in": "path", "description": "Een identificatie die verwijst naar een versie een omgevingsdocument die in ontwerp is.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "/akn/nl/act/gm1759/2025/omgevingsplan/nld@2025-04-21" } }, { "name": "bestandsnaam", "in": "path", "description": "De naam van het op te vragen bestand.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "Afbeelding.png" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "image/*": { "schema": { "$ref": "#/components/schemas/Afbeelding" } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-auth-type": "None" } }, "/omgevingsvergunningen": { "get": { "tags": [ "Omgevingsvergunningen" ], "summary": "Alle omgevingsvergunningen opvragen", "operationId": "getOmgevingsvergunningen", "parameters": [ { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met omgevingsvergunninggebieden", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "description": "De page moet minimaal een waarde van 1 hebben.", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "format": "int32", "example": 1, "default": 1 } }, { "name": "size", "in": "query", "description": "De pagesize moet minimaal een waarde van 1 hebben en maximaal een waarde van 200.", "required": false, "style": "form", "explode": true, "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "example": 20, "default": 20 } }, { "name": "_sort", "in": "query", "description": "Sortering van de resultaten, waarden kunnen komma gescheiden opgegeven worden, sortering is ascending, descending kan door een - teken", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmgevingsvergunningenSort" } }, "example": [ "identificatie", "-registratietijdstip" ] } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Omgevingsvergunningen" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/omgevingsvergunningen/{uriIdentificatie}": { "get": { "tags": [ "Omgevingsvergunningen" ], "summary": "Een enkele omgevingsvergunning opvragen", "operationId": "getOmgevingsvergunning", "parameters": [ { "name": "uriIdentificatie", "in": "path", "description": "Een identificatie van een omgevingsvergunning, zoals gedefinieerd in de STOP-standaard, waarbij de schuine strepen en koppeltekens zijn vervangen door lage streepjes (onderstrepingstekens).", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "gm0599_Vergunning1234_01" } }, { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met omgevingsvergunninggebieden", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Omgevingsvergunning" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "404": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/omgevingsvergunningen/_zoek": { "post": { "tags": [ "Omgevingsvergunningen" ], "summary": "Omgevingsvergunningen opvragen die voldoen aan zoekobject-parameters", "operationId": "zoekOmgevingsvergunningen", "parameters": [ { "name": "Content-Crs", "in": "header", "description": "De CRS van de meegeleverde geometrie-content. Wanneer de Content-Crs header ontbreekt, dan wordt de 'default' Crs aangenomen. Dat is WSG84 (CRS84) en dat ondersteunen wij niet.", "required": false, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/Crs" } }, { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met omgevingsvergunninggebieden", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "description": "De page moet minimaal een waarde van 1 hebben.", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "format": "int32", "example": 1, "default": 1 } }, { "name": "size", "in": "query", "description": "De pagesize moet minimaal een waarde van 1 hebben en maximaal een waarde van 200.", "required": false, "style": "form", "explode": true, "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "example": 20, "default": 20 } }, { "name": "_sort", "in": "query", "description": "Sortering van de resultaten, waarden kunnen komma gescheiden opgegeven worden, sortering is ascending, descending kan door een - teken", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmgevingsvergunningenSort" } }, "example": [ "identificatie", "-registratietijdstip" ] } ], "requestBody": { "description": "Zoekobject", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmgevingsvergunningZoekobject" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Omgevingsvergunningen" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "415": { "description": "Media type wordt niet ondersteund", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Ongeldig media type", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/media_type", "title": "Ongeldig media type", "status": 415, "detail": "Content-Type: 'application/xml' wordt niet ondersteund. Geldige waarden zijn: [application/json]", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "422": { "description": "De inhoud van het verzoek kan niet worden verwerkt.\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Niet ondersteunde CRS", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/unprocessable_entity", "title": "Niet-ondersteunde CRS", "status": 422, "detail": "Deze Content-CRS header wordt niet ondersteund: http://www.opengis.net/def/crs/EPSG/9.9.1/289", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/onderwerpen/_zoek": { "post": { "tags": [ "Onderwerpen" ], "summary": "Zoek onderwerpen op basis van een geometrie", "operationId": "zoekOnderwerpen", "parameters": [ { "name": "Content-Crs", "in": "header", "description": "De CRS van de meegeleverde geometrie-content. Wanneer de Content-Crs header ontbreekt, dan wordt de 'default' Crs aangenomen. Dat is WSG84 (CRS84) en dat ondersteunen wij niet.", "required": false, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/Crs" } }, { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoZoekRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Onderwerpen" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "422": { "description": "De inhoud van het verzoek kan niet worden verwerkt.\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Niet ondersteunde CRS", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/unprocessable_entity", "title": "Niet-ondersteunde CRS", "status": 422, "detail": "Deze Content-CRS header wordt niet ondersteund: http://www.opengis.net/def/crs/EPSG/9.9.1/289", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/ontwerponderwerpen/_zoek": { "post": { "tags": [ "Ontwerponderwerpen" ], "summary": "Zoek ontwerp onderwerpen op basis van een geometrie", "operationId": "zoekOntwerpOnderwerpen", "parameters": [ { "name": "Content-Crs", "in": "header", "description": "De CRS van de meegeleverde geometrie-content. Wanneer de Content-Crs header ontbreekt, dan wordt de 'default' Crs aangenomen. Dat is WSG84 (CRS84) en dat ondersteunen wij niet.", "required": false, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/Crs" } }, { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, { "name": "inzagetermijn", "in": "query", "description": "Filter ontwerpregelingen op basis van het inzagetermijn en de opgegeven beschikbaarOp tijdreisparameter:\n - huidigEnToekomstig: retourneert ontwerpregelingen waarbij het inzagetermijn nog niet verstreken is.\n \n Wanneer deze parameter niet meegegeven wordt zal er geen filtering op basis van het inzagetermijn plaatsvinden.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Inzagetermijn" } }, { "name": "besluitType", "in": "query", "description": "Met behulp van deze parameter kan gefilterd worden op het type besluit, als volgt:\n - `initieel`: Alleen ontwerpen die zijn aangeleverd met een initieel besluit.\n - `wijziging`: Alleen ontwerpen die zijn aangeleverd met een wijzigingsbesluit.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/BesluitType" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoZoekRequestBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/OntwerpOnderwerpen" } } } }, "400": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "422": { "description": "De inhoud van het verzoek kan niet worden verwerkt.\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Niet ondersteunde CRS", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/unprocessable_entity", "title": "Niet-ondersteunde CRS", "status": 422, "detail": "Deze Content-CRS header wordt niet ondersteund: http://www.opengis.net/def/crs/EPSG/9.9.1/289", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/app-health": { "get": { "tags": [ "Meta" ], "summary": "app-health info", "operationId": "getHealth", "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Health" }, "example": { "app-health": { "status": "UP" } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Health" }, "example": { "app-health": { "status": "DOWN" } } } } }, "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/app-info": { "get": { "tags": [ "Meta" ], "summary": "applicatie info", "operationId": "getInfo", "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Info" } } } }, "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/crss": { "get": { "tags": [ "Meta" ], "summary": "Alle beschikbare CRS-en opvragen waarmee deze api bevraagd kan worden.", "operationId": "getCrss", "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Crs" } } } } } } } }, "/openapi.yaml": { "get": { "x-auth-type": "None", "tags": [ "Meta" ], "summary": "De OpenAPI specificatie in YAML-formaat", "description": "Vraag de OpenAPI specificatie op in YAML formaat.", "operationId": "getOpenApiYaml", "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/yaml": { "schema": { "title": "OpenApiSchemaYaml", "type": "object", "description": "Het YAML schema van de OpenAPI specificatie." } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } }, "/openapi.json": { "get": { "x-auth-type": "None", "tags": [ "Meta" ], "summary": "De OpenAPI specificatie in JSON-formaat", "description": "Vraag de OpenAPI specificatie op in JSON formaat.", "operationId": "getOpenApiJson", "responses": { "200": { "description": "OK", "headers": { "API-version": { "$ref": "#/components/headers/api-version" } }, "content": { "application/json": { "schema": { "title": "OpenApiSchemaJson", "type": "object", "description": "Het JSON schema van de OpenAPI specificatie." } } } }, "500": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } } } } }, "components": { "schemas": { "RegelingenSort": { "title": "RegelingenSort", "type": "string", "enum": [ "identificatie", "-identificatie", "registratietijdstip", "-registratietijdstip", "geldigVanaf", "-geldigVanaf", "inwerkingVanaf", "-inwerkingVanaf" ] }, "Tileset": { "title": "Tileset", "type": "string", "enum": [ "actueel", "volledig" ] }, "LocatieSelectie": { "title": "LocatieSelectie", "type": "string", "enum": [ "primair" ] }, "Regelingen": { "title": "Regelingen", "required": [ "_embedded", "_links", "page" ], "type": "object", "properties": { "_embedded": { "$ref": "#/components/schemas/RegelingenEmbedded" }, "_links": { "$ref": "#/components/schemas/HalPaginationLinks" }, "page": { "$ref": "#/components/schemas/Page" } } }, "Problem": { "title": "Problem", "type": "object", "properties": { "type": { "type": "string", "description": "Absolute URI dat het probleemtype identificeert.", "format": "uri" }, "title": { "type": "string", "description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars." }, "status": { "maximum": 600, "exclusiveMaximum": true, "minimum": 100, "type": "integer", "description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.", "format": "int32", "example": 500 }, "detail": { "type": "string", "description": "Mens-leesbare uitleg van dit specifieke probleem.", "example": "Interne server fout" }, "instance": { "type": "string", "description": "Absolute URI dat dit specifieke probleem identificeert.", "format": "uri" } }, "description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)." }, "InvalidParam": { "title": "InvalidParam", "required": [ "name" ], "type": "object", "properties": { "name": { "title": "name", "type": "string" }, "reason": { "title": "reason", "type": "string" } }, "description": "Beschrijving van een ongeldige parameter" }, "Regeling": { "title": "Regeling", "type": "object", "description": "Een tekst (met eventuele afbeeldingen en andere multimedia-elementen) die juridische voorschriften van algemene strekking of beleidsregels bevat.", "allOf": [ { "$ref": "#/components/schemas/Omgevingsdocument" }, { "required": [ "geregistreerdMet", "type" ], "type": "object", "properties": { "expressionId": { "type": "string" }, "type": { "$ref": "#/components/schemas/SoortRegeling" }, "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" }, "citeerTitel": { "title": "citeerTitel", "type": "string" }, "opschrift": { "title": "opschrift", "type": "string" }, "conditie": { "title": "conditie", "type": "string" }, "opvolgerVan": { "title": "beoogdeOpvolgerVan", "minItems": 0, "type": "array", "description": "De Regeling die een andere Regeling vervangt (en daarmee de opvolger van de oude Regeling is).", "items": { "$ref": "#/components/schemas/Regeling" } }, "heeftBijlagen": { "title": "heeftBijlagen", "type": "boolean" }, "heeftToelichtingen": { "title": "heeftToelichtingen", "type": "boolean" }, "publicatieID": { "type": "string" }, "inwerkingTot": { "title": "inwerkingTot", "type": "string" }, "geldigTot": { "title": "geldigTot", "type": "string" }, "_embedded": { "$ref": "#/components/schemas/RegelingAllOfEmbedded" }, "_links": { "$ref": "#/components/schemas/RegelingLinks" } } } ] }, "Crs": { "title": "Crs", "type": "string", "format": "uri", "enum": [ "http://www.opengis.net/def/crs/EPSG/0/28992" ] }, "RegelingZoekobject": { "title": "RegelingZoekobject", "type": "object", "properties": { "typeBevoegdGezag": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/BevoegdGezagType" } }, "bevoegdGezag": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/BevoegdGezagCode" } }, "geometrie": { "$ref": "#/components/schemas/Geometry" } }, "description": "Zoekobject voor specifieke regelingen-bevragingen.", "example": { "typeBevoegdGezag": [ "gemeente", "provincie" ], "bevoegdGezag": [ "gm0000", "pv0000" ], "geometrie": { "type": "Point", "coordinates": [ 139784, 442870 ] } } }, "TransformXml": { "type": "string", "enum": [ "inhoud" ] }, "ConditieArtikelUitlevering": { "type": "string", "enum": [ "eigenDocumentComponent" ] }, "Documentstructuur": { "required": [ "_embedded" ], "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/DocumentstructuurLinks" }, "_embedded": { "$ref": "#/components/schemas/Documentstructuur__embedded" } } }, "RegelingVoorkomensSort": { "title": "RegelingVoorkomensSort", "type": "string", "enum": [ "registratietijdstip", "-registratietijdstip", "geldigVanaf", "-geldigVanaf", "inwerkingVanaf", "-inwerkingVanaf" ] }, "Voorkomens": { "title": "Voorkomens", "required": [ "_embedded", "_links", "page" ], "type": "object", "properties": { "_embedded": { "$ref": "#/components/schemas/Voorkomens__embedded" }, "_links": { "$ref": "#/components/schemas/HalPaginationLinks" }, "page": { "$ref": "#/components/schemas/Page" } } }, "ExpandScopeVastgesteldeAnnotaties": { "title": "ExpandScopeVastgesteldeAnnotaties", "type": "string", "enum": [ "registratiegegevens" ] }, "ExtraInfo": { "title": "ExtraInfo", "type": "string", "enum": [ "boundingBox" ] }, "DivisieannotatiesVastgesteld": { "title": "Annotaties bij vrije-tekststructuur", "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/AnnotatieLinks" }, "divisies": { "type": "array", "items": { "$ref": "#/components/schemas/Divisie" } }, "divisieteksten": { "type": "array", "items": { "$ref": "#/components/schemas/Divisietekst" } }, "tekstdelen": { "type": "array", "items": { "$ref": "#/components/schemas/Tekstdeel" } }, "gebiedsaanwijzingen": { "type": "array", "items": { "$ref": "#/components/schemas/Gebiedsaanwijzing" } }, "hoofdlijnen": { "type": "array", "items": { "$ref": "#/components/schemas/Hoofdlijn" } }, "locaties": { "type": "array", "items": { "$ref": "#/components/schemas/Locatie" } }, "kaarten": { "type": "array", "items": { "$ref": "#/components/schemas/KaartDivisie" } } }, "description": "Gestructureerde OW-objecten bij een regeling met vrije-tekststructuur.\n\nOW-objecten worden uitgeleverd op basis van de vraagstelling, bijv. alle objecten die horen\nbij een regeling, of alle objecten die horen bij een documentcomponent binnen de tekststructuur.\nAlle objecten die direct of indirect horen bij de gevraagde regeling\nof het gevraagde documentcomponent, worden uitgeleverd. \n\nObjecten zijn geordend in lijsten (arrays) per objecttype.\n\nRelaties tussen de objecten worden aangegeven door '*Refs'-attributen, bijvoorbeeld \neen Tekstdeel heeft een relatie met een of meerdere locaties;\ndeze locaties zitten dan apart in deze resource, en er wordt vanuit het Tekstdeel \nnaar verwezen vanuit het 'locatieRefs' attribuut.\n" }, "GeoZoekRequestBody": { "title": "GeoZoekRequestBody", "required": [ "geometrie" ], "type": "object", "properties": { "geometrie": { "$ref": "#/components/schemas/Geometry" } }, "example": { "geometrie": { "type": "Point", "coordinates": [ 139784, 442870 ] } } }, "DivisieannotatiesVastgesteldAtLocation": { "title": "Annotaties bij vrije-tekststructuur op locatie", "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/AnnotatieZoekLinks" }, "divisies": { "type": "array", "items": { "$ref": "#/components/schemas/Divisie" } }, "divisieteksten": { "type": "array", "items": { "$ref": "#/components/schemas/Divisietekst" } }, "tekstdelen": { "type": "array", "items": { "$ref": "#/components/schemas/Tekstdeel" } }, "gebiedsaanwijzingen": { "type": "array", "items": { "$ref": "#/components/schemas/Gebiedsaanwijzing" } }, "hoofdlijnen": { "type": "array", "items": { "$ref": "#/components/schemas/Hoofdlijn" } }, "locaties": { "type": "array", "items": { "$ref": "#/components/schemas/Locatie" } }, "kaarten": { "type": "array", "items": { "$ref": "#/components/schemas/KaartDivisie" } }, "geselecteerdeLocatieRefs": { "$ref": "#/components/schemas/LocatieRefs" } }, "description": "Gestructureerde OW-objecten bij een regeling met vrije-tekststructuur en een geo-zoekvraag.\n\nOW-objecten worden uitgeleverd op basis van de vraagstelling, bijv. alle objecten die horen\nbij een regeling én de gegeven geo-zoekvraag, \nof alle objecten die horen bij een documentcomponent binnen de tekststructuur én de gegeven geo-zoekvraag.\nAlle objecten die direct of indirect horen bij de gevraagde regeling\nof het gevraagde documentcomponent, worden uitgeleverd. \n\nObjecten zijn geordend in lijsten (arrays) per objecttype.\n\nRelaties tussen de objecten worden aangegeven door '*Refs'-attributen, bijvoorbeeld \neen Tekstdeel heeft een relatie met een of meerdere locaties;\ndeze locaties zitten dan apart in deze resource, en er wordt vanuit het Tekstdeel \nnaar verwezen vanuit het 'locatieRefs' attribuut.\n" }, "RegeltekstannotatiesVastgesteld": { "title": "Annotaties bij artikelstructuur op locatie", "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/AnnotatieLinks" }, "regelteksten": { "type": "array", "items": { "$ref": "#/components/schemas/Regeltekst" } }, "regelsVoorIedereen": { "type": "array", "items": { "$ref": "#/components/schemas/RegelVoorIedereen" } }, "omgevingswaarderegels": { "type": "array", "items": { "$ref": "#/components/schemas/Omgevingswaarderegel" } }, "instructieregels": { "type": "array", "items": { "$ref": "#/components/schemas/Instructieregel" } }, "gebiedsaanwijzingen": { "type": "array", "items": { "$ref": "#/components/schemas/Gebiedsaanwijzing" } }, "locaties": { "type": "array", "items": { "$ref": "#/components/schemas/Locatie" } }, "activiteiten": { "type": "array", "items": { "$ref": "#/components/schemas/Activiteit" } }, "omgevingsnormen": { "type": "array", "items": { "$ref": "#/components/schemas/Norm" } }, "omgevingswaarden": { "type": "array", "items": { "$ref": "#/components/schemas/Norm" } }, "kaarten": { "type": "array", "items": { "$ref": "#/components/schemas/KaartRegeltekst" } } }, "description": "Gestructureerde OW-objecten bij een regeling met artikelstructuur.\n\nOW-objecten worden uitgeleverd op basis van de vraagstelling, bijv. alle objecten die horen\nbij een regeling, of alle objecten die horen bij een artikel of lid.\nAlle objecten die direct of indirect horen bij de gevraagde regeling\nof het gevraagde artikel/lid, worden uitgeleverd.\n\nObjecten zijn geordend in lijsten (arrays) per objecttype.\n\nRelaties tussen de objecten worden aangegeven door '*Refs'-attributen, bijvoorbeeld \neen RegelVoorIedereen heeft een relatie met een of meerdere locaties (het werkingsgebied);\ndeze locaties zitten dan apart in deze resource, en er wordt vanuit de RegelVoorIedereen \nnaar verwezen vanuit het 'locatieRefs' attribuut.\n" }, "RegeltekstannotatiesVastgesteldAtLocation": { "title": "Annotaties bij artikelstructuur op locatie", "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/AnnotatieZoekLinks" }, "regelteksten": { "type": "array", "items": { "$ref": "#/components/schemas/Regeltekst" } }, "regelsVoorIedereen": { "type": "array", "items": { "$ref": "#/components/schemas/RegelVoorIedereen" } }, "omgevingswaarderegels": { "type": "array", "items": { "$ref": "#/components/schemas/Omgevingswaarderegel" } }, "instructieregels": { "type": "array", "items": { "$ref": "#/components/schemas/Instructieregel" } }, "gebiedsaanwijzingen": { "type": "array", "items": { "$ref": "#/components/schemas/Gebiedsaanwijzing" } }, "locaties": { "type": "array", "items": { "$ref": "#/components/schemas/Locatie" } }, "activiteiten": { "type": "array", "items": { "$ref": "#/components/schemas/Activiteit" } }, "omgevingsnormen": { "type": "array", "items": { "$ref": "#/components/schemas/Norm" } }, "omgevingswaarden": { "type": "array", "items": { "$ref": "#/components/schemas/Norm" } }, "kaarten": { "type": "array", "items": { "$ref": "#/components/schemas/KaartRegeltekst" } }, "geselecteerdeLocatieRefs": { "$ref": "#/components/schemas/LocatieRefs" } }, "description": "Gestructureerde OW-objecten bij een regeling met artikelstructuur en een geo-zoekvraag.\n\nOW-objecten worden uitgeleverd op basis van de vraagstelling, bijv. alle objecten die horen\nbij een regeling én een geo-zoekvraag, of alle objecten die horen bij een artikel of lid én een geo-zoekvraag.\nAlle objecten die direct of indirect horen bij de gevraagde regeling\nof het gevraagde artikel/lid, worden uitgeleverd.\n\nObjecten zijn geordend in lijsten (arrays) per objecttype.\n\nRelaties tussen de objecten worden aangegeven door '*Refs'-attributen, bijvoorbeeld \neen RegelVoorIedereen heeft een relatie met een of meerdere locaties (het werkingsgebied);\ndeze locaties zitten dan apart in deze resource, en er wordt vanuit de RegelVoorIedereen \nnaar verwezen vanuit het 'locatieRefs' attribuut.\n" }, "Afbeelding": { "type": "string", "description": "Een afbeelding (PNG of JPG) uit een document.", "format": "binary" }, "BesluitversiesSort": { "title": "BesluitversiesSort", "type": "string", "enum": [ "identificatie", "-identificatie", "registratietijdstip", "-registratietijdstip" ] }, "Besluitversies": { "title": "Besluitversies", "required": [ "_embedded", "_links", "page" ], "type": "object", "properties": { "_embedded": { "$ref": "#/components/schemas/BesluitversiesEmbedded" }, "_links": { "$ref": "#/components/schemas/HalPaginationLinks" }, "page": { "$ref": "#/components/schemas/Page" } } }, "Besluitversie": { "title": "Besluitversie", "required": [ "bekendOp", "eindverantwoordelijke", "expressionId", "identificatie", "instrumentversie", "ontvangenOp", "opschrift", "technischId", "type" ], "type": "object", "properties": { "identificatie": { "$ref": "#/components/schemas/StopIdentificatie" }, "technischId": { "$ref": "#/components/schemas/TechnischId" }, "expressionId": { "$ref": "#/components/schemas/StopIdentificatie" }, "type": { "$ref": "#/components/schemas/SoortRegeling" }, "opschrift": { "title": "opschrift", "type": "string" }, "citeerTitel": { "title": "citeerTitel", "type": "string", "description": "De citeertitel van het besluit" }, "instrumentversie": { "title": "instrumentversie", "type": "string" }, "bekendOp": { "title": "bekendOp", "type": "string", "format": "date", "example": "2020-07-05" }, "ontvangenOp": { "title": "ontvangenOp", "type": "string", "format": "date", "example": "2020-07-05" }, "aangeleverdDoorEen": { "$ref": "#/components/schemas/BevoegdGezag" }, "eindverantwoordelijke": { "title": "eindverantwoordelijke", "type": "string" }, "officieleTitel": { "title": "officieleTitel", "type": "string" }, "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" }, "publicatieID": { "type": "string" }, "heeftBijlagen": { "title": "heeftBijlagen", "type": "boolean", "default": false }, "heeftToelichtingen": { "title": "heeftToelichtingen", "type": "boolean", "default": false }, "isVervangRegeling": { "title": "isVervangRegeling", "type": "boolean" }, "procedureverloop": { "$ref": "#/components/schemas/BesluitversieProcedureverloop" }, "_embedded": { "$ref": "#/components/schemas/Besluitversie__embedded" }, "_links": { "$ref": "#/components/schemas/BesluitversieLinks" } } }, "BesluitversieDocumentstructuur": { "required": [ "_embedded" ], "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/BesluitversieDocumentstructuurLinks" }, "_embedded": { "$ref": "#/components/schemas/BesluitversieDocumentstructuur__embedded" } } }, "DivisieannotatiesBesluitRenvooi": { "title": "Annotaties en renvooi bij artikelstructuur", "type": "object", "description": "Gestructureerde OW-objecten en beoogde wijzigingen (renvooi) bij een besluitversie met vrije-tekststructuur.\n\nOW-objecten worden uitgeleverd op basis van de vraagstelling, bijv. alle objecten die horen\nbij de gewijzigde regeling waar deze besluitversie op gebaseerd is,\nof alle objecten die horen bij een artikel of lid uit die gewijzigde regeling.\nAlle objecten die direct of indirect horen bij de gevraagde regeling\nof het gevraagde artikel/lid, worden uitgeleverd.\n\nObjecten zijn geordend in lijsten (arrays) per objecttype.\n\nRelaties tussen de objecten worden aangegeven door '*Refs'-attributen, bijvoorbeeld \neen Tekstdeel heeft een relatie met een of meerdere locaties;\ndeze locaties zitten dan apart in deze resource, en er wordt vanuit het Tekstdeel \nnaar verwezen vanuit het 'locatieRefs' attribuut.\n\nDaarnaast is per objecttype aangegeven welke wijzigingen er zijn gedaan in de geconsolideerde regeling.\nDit wordt gedaan in het attribuut '_delta'. Hierin wordt per object aangegeven welke toevoegingen,\nwijzigingen, of verwijderingen de geconsolideerde regeling beoogt te doen.\n", "allOf": [ { "$ref": "#/components/schemas/DivisieannotatiesRenvooi" }, { "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/AnnotatieBesluitRenvooiLinks" } } } ] }, "DivisieannotatiesRenvooiAtLocation": { "title": "Annotaties en renvooi bij vrije-tekststructuur op locatie", "type": "object", "properties": { "geselecteerdeLocatieRefs": { "$ref": "#/components/schemas/LocatieRefs" } }, "description": "Gestructureerde OW-objecten en beoogde wijzigingen (renvooi) bij een regeling met vrije-tekststructuur en een geo-zoekvraag.\n\nOW-objecten worden uitgeleverd op basis van de vraagstelling, bijv. alle objecten die horen\nbij de vastgestelde regeling waar deze ontwerpregeling op gebaseerd is én de gegeven geo-zoekvraag,\nof alle objecten die horen bij een documentcomponent uit die vastgestelde regeling én de gegeven geo-zoekvraag.\nAlle objecten die direct of indirect horen bij de gevraagde regeling\nof het gevraagde documentcomponent, worden uitgeleverd. \n\nObjecten zijn geordend in lijsten (arrays) per objecttype.\n\nRelaties tussen de objecten worden aangegeven door '*Refs'-attributen, bijvoorbeeld \neen Tekstdeel heeft een relatie met een of meerdere locaties;\ndeze locaties zitten dan apart in deze resource, en er wordt vanuit het Tekstdeel \nnaar verwezen vanuit het `locatieRefs` attribuut.\n\nDaarnaast is per objecttype aangegeven welke wijzigingen er zijn in de opvolgende regeling.\nDit wordt gedaan in het attribuut `_delta`. Hierin wordt per object aangegeven welke toevoegingen,\nwijzigingen, of verwijderingen de opvolgende regeling bevat.\n", "allOf": [ { "$ref": "#/components/schemas/DivisieannotatiesRenvooi" } ] }, "RegeltekstannotatiesBesluitRenvooi": { "title": "Annotaties en renvooi bij artikelstructuur", "type": "object", "description": "Gestructureerde OW-objecten en wijzigingen (renvooi) bij een besluitversie met artikelstructuur.\n\nOW-objecten worden uitgeleverd op basis van de vraagstelling, bijv. alle objecten die horen\nbij de gewijzigde regeling waar deze besluitversie op gebaseerd is,\nof alle objecten die horen bij een artikel of lid uit die gewijzigde regeling.\nAlle objecten die direct of indirect horen bij de gevraagde regeling\nof het gevraagde artikel/lid, worden uitgeleverd.\n\nObjecten zijn geordend in lijsten (arrays) per objecttype.\n\nRelaties tussen de objecten worden aangegeven door '*Refs'-attributen, bijvoorbeeld \neen Tekstdeel heeft een relatie met een of meerdere locaties;\ndeze locaties zitten dan apart in deze resource, en er wordt vanuit het Tekstdeel \nnaar verwezen vanuit het 'locatieRefs' attribuut.\n\nDaarnaast is per objecttype aangegeven welke wijzigingen er zijn gedaan in de geconsolideerde regeling.\nDit wordt gedaan in het attribuut '_delta'. Hierin wordt per object aangegeven welke toevoegingen,\nwijzigingen, of verwijderingen de geconsolideerde regeling beoogt te doen.\n", "allOf": [ { "$ref": "#/components/schemas/RegeltekstannotatiesRenvooi" }, { "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/AnnotatieBesluitRenvooiLinks" } } } ] }, "RegeltekstannotatiesRenvooiAtLocation": { "title": "Annotaties en renvooi bij artikelstructuur op locatie", "type": "object", "properties": { "geselecteerdeLocatieRefs": { "$ref": "#/components/schemas/LocatieRefs" } }, "description": "Gestructureerde OW-objecten en beoogde wijzigingen (renvooi) bij een regeling met artikelstructuur en een geo-zoekvraag.\n\nOW-objecten worden uitgeleverd op basis van de vraagstelling, bijv. alle objecten die horen\nbij de gewijzigde regeling waar de opvolgende regeling op gebaseerd is én de gegeven geo-zoekvraag,\nof alle objecten die horen bij een artikel of lid uit die gewijzigde regeling én de gegeven geo-zoekvraag.\nAlle objecten die direct of indirect horen bij de gevraagde regeling\nof het gevraagde artikel/lid, worden uitgeleverd.\n\nObjecten zijn geordend in lijsten (arrays) per objecttype.\n\nRelaties tussen de objecten worden aangegeven door '*Refs'-attributen, bijvoorbeeld \neen Tekstdeel heeft een relatie met een of meerdere locaties;\ndeze locaties zitten dan apart in deze resource, en er wordt vanuit het Tekstdeel \nnaar verwezen vanuit het `locatieRefs` attribuut.\n\nDaarnaast is per objecttype aangegeven welke wijzigingen er zijn in de opvolgende regeling.\nDit wordt gedaan in het attribuut `_delta`. Hierin wordt per object aangegeven welke toevoegingen,\nwijzigingen, of verwijderingen de opvolgende regeling bevat.\n", "allOf": [ { "$ref": "#/components/schemas/RegeltekstannotatiesRenvooi" } ] }, "OntwerpregelingenSort": { "title": "OntwerpregelingenSort", "type": "string", "enum": [ "identificatie", "-identificatie", "registratietijdstip", "-registratietijdstip" ] }, "Ontwerpregelingen": { "title": "Ontwerpregelingen", "required": [ "_embedded", "_links", "page" ], "type": "object", "properties": { "_embedded": { "$ref": "#/components/schemas/OntwerpregelingenEmbedded" }, "_links": { "$ref": "#/components/schemas/HalPaginationLinks" }, "page": { "$ref": "#/components/schemas/Page" } } }, "Ontwerpregeling": { "title": "Ontwerpregeling", "type": "object", "description": "Een ontwerp tekst (met eventuele afbeeldingen en andere multimedia-elementen) die juridische voorschriften van algemene strekking of beleidsregels bevat.", "allOf": [ { "$ref": "#/components/schemas/Omgevingsdocument" }, { "required": [ "geregistreerdMet", "ontwerpbesluitIdentificatie", "technischId", "type" ], "type": "object", "properties": { "ontwerpbesluitIdentificatie": { "$ref": "#/components/schemas/StopIdentificatie" }, "besluitMetadata": { "$ref": "#/components/schemas/BesluitMetadata" }, "technischId": { "$ref": "#/components/schemas/TechnischId" }, "expressionId": { "$ref": "#/components/schemas/StopIdentificatie" }, "type": { "$ref": "#/components/schemas/SoortRegeling" }, "geregistreerdMet": { "$ref": "#/components/schemas/Ontwerpregistratiegegevens" }, "opschrift": { "title": "opschrift", "type": "string", "description": "Het opschrift van de regeling. Deze dient overeen te komen met de officiële titel van de regeling." }, "citeerTitel": { "title": "citeerTitel", "type": "string", "description": "De titel van de regeling zoals deze wordt gebruikt in aanhalingen." }, "conditie": { "title": "conditie", "type": "string", "description": "De verhouding is tussen dit tijdelijk deel en de hoofdregeling." }, "heeftBijlagen": { "title": "heeftBijlagen", "type": "boolean" }, "heeftToelichtingen": { "title": "heeftToelichtingen", "type": "boolean" }, "isVervangRegeling": { "title": "isVervangRegeling", "type": "boolean" }, "publicatieID": { "type": "string", "description": "Verwijzing naar het besluit dat ten grondslag heeft gelegen aan het ontwerpbesluit." }, "procedureverloop": { "$ref": "#/components/schemas/OntwerpProcedureverloop" }, "_embedded": { "$ref": "#/components/schemas/Ontwerpregeling__embedded" }, "_links": { "$ref": "#/components/schemas/OntwerpregelingLinks" } } } ] }, "OntwerpregelingZoekobject": { "title": "OntwerpregelingZoekobject", "type": "object", "properties": { "typeBevoegdGezag": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/BevoegdGezagType" } }, "bevoegdGezag": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/BevoegdGezagCode" } }, "typeRegeling": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RegelingType" } }, "geometrie": { "$ref": "#/components/schemas/Geometry" } }, "description": "Zoekobject voor specifieke ontwerpregelingen-bevragingen.", "example": { "typeBevoegdGezag": [ "gemeente", "provincie" ], "bevoegdGezag": [ "gm0000", "pv0000" ], "geometrie": { "type": "Point", "coordinates": [ 139784, 442870 ] }, "typeRegeling": [ "/join/id/stop/regelingtype_001", "/join/id/stop/regelingtype_002" ] } }, "DivisieannotatiesOntwerpRenvooi": { "title": "Annotaties en renvooi bij vrije-tekststructuur", "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/AnnotatieOntwerpRenvooiLinks" } }, "description": "Gestructureerde OW-objecten en beoogde wijzigingen (renvooi) bij een ontwerpregeling met vrije-tekststructuur.\n\nOW-objecten worden uitgeleverd op basis van de vraagstelling, bijv. alle objecten die horen\nbij de vastgestelde regeling waar deze ontwerpregeling op gebaseerd is,\nof alle objecten die horen bij een documentcomponent uit die vastgestelde regeling.\nAlle objecten die direct of indirect horen bij de gevraagde regeling\nof het gevraagde documentcomponent, worden uitgeleverd. \n\nObjecten zijn geordend in lijsten (arrays) per objecttype.\n\nRelaties tussen de objecten worden aangegeven door '*Refs'-attributen, bijvoorbeeld \neen Tekstdeel heeft een relatie met een of meerdere locaties;\ndeze locaties zitten dan apart in deze resource, en er wordt vanuit het Tekstdeel \nnaar verwezen vanuit het 'locatieRefs' attribuut.\n\nDaarnaast is per objecttype aangegeven welke wijzigingen er beoogd zijn in de ontwerpregeling.\nDit wordt gedaan in het attribuut '_delta'. Hierin wordt per object aangegeven welke toevoegingen,\nwijzigingen, of verwijderingen de ontwerpregeling beoogt te doen.\n", "allOf": [ { "$ref": "#/components/schemas/DivisieannotatiesRenvooi" } ] }, "RegeltekstannotatiesOntwerpRenvooi": { "title": "Annotaties en renvooi bij artikelstructuur", "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/AnnotatieOntwerpRenvooiLinks" } }, "description": "Gestructureerde OW-objecten en beoogde wijzigingen bij een ontwerpregeling met artikelstructuur.\n\nOW-objecten worden uitgeleverd op basis van de vraagstelling, bijv. alle objecten die horen\nbij de vastgestelde regeling waar deze ontwerpregeling op gebaseerd is,\nof alle objecten die horen bij een artikel of lid uit die vastgestelde regeling.\nAlle objecten die direct of indirect horen bij de gevraagde regeling\nof het gevraagde artikel/lid, worden uitgeleverd.\n\nObjecten zijn geordend in lijsten (arrays) per objecttype.\n\nRelaties tussen de objecten worden aangegeven door '*Refs'-attributen, bijvoorbeeld \neen Tekstdeel heeft een relatie met een of meerdere locaties;\ndeze locaties zitten dan apart in deze resource, en er wordt vanuit het Tekstdeel \nnaar verwezen vanuit het 'locatieRefs' attribuut.\n\nDaarnaast is per objecttype aangegeven welke wijzigingen er beoogd zijn in de ontwerpregeling.\nDit wordt gedaan in het attribuut '_delta'. Hierin wordt per object aangegeven welke toevoegingen,\nwijzigingen, of verwijderingen de ontwerpregeling beoogt te doen.\n", "allOf": [ { "$ref": "#/components/schemas/RegeltekstannotatiesRenvooi" } ] }, "OntwerpDocumentstructuur": { "required": [ "_embedded" ], "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/OntwerpDocumentstructuurLinks" }, "_embedded": { "$ref": "#/components/schemas/OntwerpDocumentstructuur__embedded" } } }, "OmgevingsvergunningenSort": { "title": "OmgevingsvergunningenSort", "type": "string", "enum": [ "identificatie", "-identificatie", "registratietijdstip", "-registratietijdstip", "geldigVanaf", "-geldigVanaf", "inwerkingVanaf", "-inwerkingVanaf" ] }, "Omgevingsvergunningen": { "title": "Omgevingsvergunningen", "required": [ "_embedded", "_links", "page" ], "type": "object", "properties": { "_embedded": { "$ref": "#/components/schemas/OmgevingsvergunningenEmbedded" }, "_links": { "$ref": "#/components/schemas/HalPaginationLinks" }, "page": { "$ref": "#/components/schemas/Page" } } }, "Omgevingsvergunning": { "title": "Omgevingsvergunning", "type": "object", "description": "Een vergunning verleend voor het gebruiken van gronden of bouwwerken in strijd met geldende omgevingsdocumenten.", "allOf": [ { "$ref": "#/components/schemas/Omgevingsdocument" }, { "required": [ "_links", "geregistreerdMet", "publicatieID", "referentienummer", "type" ], "type": "object", "properties": { "referentienummer": { "title": "referentienummer", "type": "string" }, "type": { "$ref": "#/components/schemas/SoortVergunning" }, "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" }, "iMROPlanidentificatie": { "title": "IMRO-planidentificatie", "minItems": 0, "type": "array", "description": "het IMRO-plan-ID waar deze vergunning bij hoort/van afwijkt.", "items": { "type": "string" } }, "publicatieID": { "title": "publicatie-ID", "type": "string" }, "_embedded": { "$ref": "#/components/schemas/Omgevingsvergunning__embedded" }, "_links": { "$ref": "#/components/schemas/OmgevingsvergunningLinks" } } } ] }, "OmgevingsvergunningZoekobject": { "title": "OmgevingsvergunningZoekobject", "type": "object", "properties": { "typeBevoegdGezag": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/BevoegdGezagType" } }, "bevoegdGezag": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/BevoegdGezagCode" } }, "geometrie": { "$ref": "#/components/schemas/Geometry" } }, "description": "Zoekobject voor specifieke Omgevingsvergunning-bevragingen.", "example": { "typeBevoegdGezag": [ "gemeente", "provincie" ], "bevoegdGezag": [ "gm0000", "pv0000" ], "geometrie": { "type": "Point", "coordinates": [ 139784, 442870 ] } } }, "Onderwerpen": { "title": "Onderwerpen", "required": [ "regelingen" ], "type": "object", "properties": { "regelingen": { "type": "array", "items": { "$ref": "#/components/schemas/RegelingOnderwerpen" } } } }, "Inzagetermijn": { "title": "Inzagetermijn", "type": "string", "enum": [ "huidigEnToekomstig" ] }, "BesluitType": { "title": "BesluitType", "type": "string", "enum": [ "initieel", "wijziging" ] }, "OntwerpOnderwerpen": { "title": "OntwerpOnderwerpen", "required": [ "ontwerpregelingen" ], "type": "object", "properties": { "ontwerpregelingen": { "type": "array", "items": { "$ref": "#/components/schemas/OntwerpRegelingOnderwerpen" } } } }, "Health": { "title": "Health", "required": [ "app-health" ], "type": "object", "properties": { "app-health": { "$ref": "#/components/schemas/AppHealth" } } }, "Info": { "required": [ "app-info" ], "type": "object", "properties": { "app-info": { "$ref": "#/components/schemas/Info_appinfo" } }, "description": "Informatie over deze API, bijvoorbeeld de versie van de API en de versie van de gebruikte standaarden" }, "HalPaginationLinks": { "allOf": [ { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/HalPaginationLinks_self" } } }, { "type": "object", "properties": { "first": { "$ref": "#/components/schemas/HalPaginationLinks_first" }, "last": { "$ref": "#/components/schemas/HalPaginationLinks_last" }, "prev": { "$ref": "#/components/schemas/HalPaginationLinks_prev" }, "next": { "$ref": "#/components/schemas/HalPaginationLinks_next" } } } ] }, "Page": { "title": "Page", "required": [ "number", "size", "totalElements", "totalPages" ], "type": "object", "properties": { "size": { "type": "integer", "format": "int32", "example": 20 }, "totalElements": { "type": "integer", "format": "int32", "example": 1 }, "totalPages": { "type": "integer", "format": "int32", "example": 1 }, "number": { "type": "integer", "format": "int32", "example": 1 } }, "description": "Info voor paginering" }, "Omgevingsdocument": { "title": "Omgevingsdocument", "required": [ "_links", "aangeleverdDoorEen", "identificatie", "officieleTitel" ], "type": "object", "properties": { "identificatie": { "$ref": "#/components/schemas/StopIdentificatie" }, "officieleTitel": { "title": "officieleTitel", "type": "string" }, "aangeleverdDoorEen": { "$ref": "#/components/schemas/BevoegdGezag" }, "_links": { "$ref": "#/components/schemas/SelfLinks" } } }, "SoortRegeling": { "title": "SoortRegeling", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "title": "code", "type": "string" }, "waarde": { "title": "waarde", "type": "string" } } }, "Registratiegegevens": { "title": "Registratiegegevens", "required": [ "beginGeldigheid", "beginInwerking", "tijdstipRegistratie" ], "type": "object", "properties": { "versie": { "title": "versie", "type": "number", "example": 1 }, "beginInwerking": { "title": "beginInwerking", "type": "string", "format": "date", "example": "2020-05-08" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "format": "date", "example": "2020-05-05" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "format": "date", "example": "2020-07-05" }, "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Tijdstip waarop deze versie beschikbaar is bij Ozon. Deze versie is actief totdat er een nieuwe versie beschikbaar komt. Datumtijd in ISO 8601 formaat.", "format": "date-time", "example": "2022-04-12T23:20:50.52Z" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Tijdstip waarop een nieuwere versie beschikbaar is bij Ozon. Deze versie is vanaf dit moment niet meer actief. Datumtijd in ISO 8601 formaat.", "format": "date-time", "example": "2022-04-12T23:20:50.52Z" } }, "description": "Een informatieobject dat de tijdslijnen en versie van een geversioneerd object beschrijft. Voor locaties wordt hierbij\nde door Ozon afgeleide versionering aangehouden die rekening houdt met indirecte mutaties, zoals een gewijzigde\nsamengestelde geometrie van een locatiegroep (vanwege wijzigingen in de geometrie van een onderliggend item) of\nwijzigingen in de primair/secundair status van een locatie.\n" }, "EmbeddedLocatie": { "title": "EmbeddedLocatie", "required": [ "geregistreerdMet", "identificatie", "locatieType" ], "type": "object", "properties": { "identificatie": { "$ref": "#/components/schemas/StopIdentificatie" }, "geometrieIdentificatie": { "title": "identificatie van de geometrie", "type": "string", "description": "De unieke identificatie van de geometrie waar deze locatie naar verwijst.", "example": "4b46ca74-3840-4ce1-91b6-abf749802f6c" }, "locatieType": { "$ref": "#/components/schemas/LocatieType" }, "noemer": { "title": "noemer", "type": "string", "description": "Tekstuele beschrijving van een Locatie, zodat er als zodanig over deze locatie gesproken kan worden. De beschrijving kan een bepaalde naam zijn waaronder de Locatie bekend staat, maar (lang) niet elke Locatie heef een naam." }, "boundingBox": { "$ref": "#/components/schemas/BoundingBox" }, "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" }, "_embedded": { "$ref": "#/components/schemas/EmbeddedLocatie__embedded" } }, "description": "Locatie met de boundingbox van de geometrie die bij deze locatie behoort" }, "RegelingLinks": { "title": "RegelingLinks", "required": [ "annotaties", "documentstructuur", "self" ], "type": "object", "properties": { "self": { "$ref": "#/components/schemas/HalLink" }, "documentstructuur": { "$ref": "#/components/schemas/HalLink" }, "annotaties": { "$ref": "#/components/schemas/HalLink" }, "tijdelijkDeelVan": { "$ref": "#/components/schemas/HalLink" }, "beoogdeOpvolgers": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/HalLink" } }, "tijdelijkDelen": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/HalLink" } }, "ontwerpTijdelijkDelen": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/HalLink" } } } }, "BevoegdGezagType": { "title": "Bevoegd gezag TOOI-code", "type": "string", "description": "Type van het bevoegd gezag, gelimiteerd\n", "enum": [ "waterschap", "provincie", "gemeente", "ministerie" ] }, "BevoegdGezagCode": { "title": "Bevoegd gezag TOOI-code", "type": "string", "description": "Code van het bevoegd gezag, uit één van onderstaande waardelijsten:\n - https://identifier.overheid.nl/tooi/set/rwc_gemeenten_compleet\n - https://identifier.overheid.nl/tooi/set/rwc_ministeries_compleet\n - https://identifier.overheid.nl/tooi/set/rwc_provincies_compleet\n - https://identifier.overheid.nl/tooi/set/rwc_waterschappen_compleet\n", "example": "gm0000" }, "Geometry": { "title": "Geometry", "description": "Geometrie in GeoJSON formaat (RFC 7946).", "externalDocs": { "description": "RFC 7946 - The GeoJSON Format", "url": "https://tools.ietf.org/html/rfc7946" }, "oneOf": [ { "$ref": "#/components/schemas/GeometryCollection" }, { "$ref": "#/components/schemas/Point" }, { "$ref": "#/components/schemas/LineString" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPoint" }, { "$ref": "#/components/schemas/MultiLineString" }, { "$ref": "#/components/schemas/MultiPolygon" } ] }, "DocumentstructuurLinks": { "required": [ "afbeeldingenBasePath", "annotaties", "regeling", "self" ], "type": "object", "properties": { "self": { "$ref": "#/components/schemas/HalLink" }, "regeling": { "$ref": "#/components/schemas/HalLink" }, "annotaties": { "$ref": "#/components/schemas/HalLink" }, "afbeeldingenBasePath": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Het absolute pad waaronder de afbeeldingen van het document gevonden kunnen worden. \nDit pad kan gecombineerd worden met bestandsnamen van afbeeldingen afkomstig uit documentcomponenten om het bestand op te halen.\n" } ] } } }, "DocumentComponent": { "title": "DocumentComponent", "required": [ "expressie", "identificatie", "type", "volgordeNummer" ], "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/DocumentComponentLinks" }, "identificatie": { "$ref": "#/components/schemas/WId" }, "expressie": { "$ref": "#/components/schemas/EId" }, "type": { "title": "type", "type": "string" }, "volgordeNummer": { "title": "volgordeNummer", "type": "integer" }, "inhoud": { "title": "inhoud", "type": "string" }, "gereserveerd": { "title": "gereserveerd", "type": "boolean", "description": "Wordt getoond als een DocumentComponent geen 'inhoud' bevat." }, "vervallen": { "title": "vervallen", "type": "boolean", "description": "Wordt getoond als een bepaald DocumentComponent vervallen is." }, "conditieArtikel": { "$ref": "#/components/schemas/ConditieArtikel" }, "kop": { "title": "kop als XML", "type": "string" }, "_embedded": { "$ref": "#/components/schemas/Documentstructuur__embedded" } }, "description": "DocumentComponent van een vastgestelde regeling, zoals bedoeld in CIMOW.\nLet op: DocumentComponenten van het type 'Begrip' komen dubbel voor: \neerst in de inhoud van het bovenliggende DocumentComponent \nen daarnaast als op zichzelf staand embedded DocumentComponent. \nWanneer Begrippen gepresenteerd moeten worden als onderdeel van de lopende tekst, \ngebruik dan de inhoud van het bovenliggende DocumentComponent; \nwanneer verwezen wordt naar een Begrip vanuit een andere locatie, \ngebruik dan het embedded DocumentComponent.\n" }, "AnnotatieLinks": { "required": [ "documentstructuur", "regeling", "self" ], "type": "object", "properties": { "self": { "$ref": "#/components/schemas/HalLink" }, "regeling": { "$ref": "#/components/schemas/HalLink" }, "documentstructuur": { "$ref": "#/components/schemas/HalLink" } } }, "Divisie": { "title": "Divisie", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" } }, "allOf": [ { "$ref": "#/components/schemas/DivisieSpec" } ] }, "Divisietekst": { "title": "Divisietekst", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" } }, "allOf": [ { "$ref": "#/components/schemas/DivisietekstSpec" } ] }, "Tekstdeel": { "title": "Tekstdeel", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" } }, "allOf": [ { "$ref": "#/components/schemas/TekstdeelSpec" } ] }, "Gebiedsaanwijzing": { "title": "Gebiedsaanwijzing", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" } }, "allOf": [ { "$ref": "#/components/schemas/GebiedsaanwijzingSpec" } ] }, "Hoofdlijn": { "title": "Hoofdlijn", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" } }, "allOf": [ { "$ref": "#/components/schemas/HoofdlijnSpec" } ] }, "Locatie": { "title": "Locatie", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" }, "_extraInfo": { "$ref": "#/components/schemas/LocatieExtraInfo" } }, "allOf": [ { "$ref": "#/components/schemas/LocatieSpec" } ] }, "KaartDivisie": { "title": "Kaart", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" }, "kaartlagen": { "type": "array", "items": { "$ref": "#/components/schemas/KaartlaagDivisie" } } }, "allOf": [ { "$ref": "#/components/schemas/KaartSpec" } ] }, "AnnotatieZoekLinks": { "required": [ "documentstructuur", "regeling" ], "type": "object", "properties": { "regeling": { "$ref": "#/components/schemas/HalLink" }, "documentstructuur": { "$ref": "#/components/schemas/HalLink" } } }, "LocatieRefs": { "title": "LocatieRefs", "type": "array", "items": { "type": "string", "example": "nl.imow-gm1911.gebied.of.gebiedengroep.20240101" } }, "Regeltekst": { "title": "Regeltekst", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" } }, "allOf": [ { "$ref": "#/components/schemas/RegeltekstSpec" } ] }, "RegelVoorIedereen": { "title": "RegelVoorIedereen", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" } }, "allOf": [ { "$ref": "#/components/schemas/RegelVoorIedereenSpec" } ] }, "Omgevingswaarderegel": { "title": "Omgevingswaarderegel", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" } }, "allOf": [ { "$ref": "#/components/schemas/OmgevingswaarderegelSpec" } ] }, "Instructieregel": { "title": "Instructieregel", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" } }, "allOf": [ { "$ref": "#/components/schemas/InstructieregelSpec" } ] }, "Activiteit": { "title": "Activiteit", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" } }, "allOf": [ { "$ref": "#/components/schemas/ActiviteitSpec" } ] }, "Norm": { "title": "Norm", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" } }, "allOf": [ { "$ref": "#/components/schemas/NormSpec" } ] }, "KaartRegeltekst": { "title": "Kaart", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" }, "kaartlagen": { "type": "array", "items": { "$ref": "#/components/schemas/KaartlaagRegeltekst" } } }, "allOf": [ { "$ref": "#/components/schemas/KaartSpec" } ] }, "StopIdentificatie": { "title": "StopIdentificatie", "type": "string", "description": "STOP-Identificatie: De IRI van een document volgens de STOP standaard (https://koop.gitlab.io/STOP/standaard/1.3.0/identificatie_doc_pub.html).", "format": "uri" }, "TechnischId": { "title": "TechnischId", "type": "string", "description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten. De escaping gebeurt met de volgende regex: [^\\w]+ wordt vervangen door _" }, "BevoegdGezag": { "title": "BevoegdGezag", "required": [ "bestuurslaag", "code", "naam" ], "type": "object", "properties": { "naam": { "title": "naam", "type": "string", "example": "gemeente Hollands Kroon" }, "bestuurslaag": { "title": "bestuurslaag", "type": "string", "example": "gemeentebestuur" }, "code": { "$ref": "#/components/schemas/BevoegdGezagCode" } } }, "BesluitversieProcedureverloop": { "title": "Procedureverloop", "type": "object", "properties": { "bekendOp": { "title": "bekendOp", "type": "string", "description": "De datum waarop de besluitversie bekend is" }, "ontvangenOp": { "title": "bekendOp", "type": "string", "description": "De datum waarop de besluitversie ontvangen is" }, "procedurestappen": { "type": "array", "items": { "$ref": "#/components/schemas/BesluitversieProcedurestap" } } }, "description": "De procedure die doorlopen is door deze besluitversie." }, "BesluitversieLinks": { "title": "BesluitversieLinks", "required": [ "self" ], "type": "object", "properties": { "self": { "$ref": "#/components/schemas/HalLink" }, "documentstructuur": { "$ref": "#/components/schemas/HalLink" }, "annotaties": { "$ref": "#/components/schemas/HalLink" }, "wijzigtRegelingversie": { "$ref": "#/components/schemas/HalLink" }, "consolideertRegelingversie": { "$ref": "#/components/schemas/HalLink" } } }, "BesluitversieDocumentstructuurLinks": { "required": [ "afbeeldingenBasePath", "annotaties", "besluitversie", "self" ], "type": "object", "properties": { "self": { "$ref": "#/components/schemas/HalLink" }, "besluitversie": { "$ref": "#/components/schemas/HalLink" }, "annotaties": { "$ref": "#/components/schemas/HalLink" }, "afbeeldingenBasePath": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Het absolute pad waaronder de afbeeldingen van het document gevonden kunnen worden. \nDit pad kan gecombineerd worden met bestandsnamen van afbeeldingen afkomstig uit documentcomponenten om het bestand op te halen.\n" } ] } } }, "BesluitversieDocumentComponent": { "title": "BesluitversieDocumentComponent", "required": [ "expressie", "identificatie", "type", "volgordeNummer" ], "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/DocumentComponentLinks" }, "identificatie": { "$ref": "#/components/schemas/WId" }, "expressie": { "$ref": "#/components/schemas/EId" }, "type": { "title": "type", "type": "string" }, "volgordeNummer": { "title": "volgordeNummer", "type": "integer" }, "inhoud": { "title": "inhoud", "type": "string" }, "gereserveerd": { "title": "gereserveerd", "type": "string", "description": "Bevat een duiding of de documentComponent gereserveerd is voor toekomstige invulling" }, "vervallen": { "title": "vervallen", "type": "string", "description": "Bevat een duiding of de documentComponent eerder inhoud bevatte die nu vervallen is" }, "conditieArtikel": { "$ref": "#/components/schemas/ConditieArtikel" }, "kop": { "title": "label als XML", "type": "string" }, "wijzigactie": { "type": "string", "enum": [ "voegtoe", "verwijder", "nieuweContainer", "verwijderContainer" ] }, "bevatRenvooi": { "type": "boolean", "description": "`true` als de documentcomponent wijzigingen bevat in de kop of inhoud, zoals inhoudelijke wijziging, of een toevoeging of verwijdering." }, "_embedded": { "$ref": "#/components/schemas/BesluitversieDocumentstructuur__embedded" } }, "description": "DocumentComponent van een besluitversie, zoals bedoeld in CIMOW. Let op: DocumentComponenten van het type 'Begrip' komen dubbel voor: eerst in de inhoud van het bovenliggende DocumentComponent en daarnaast als op zichzelf staand embedded DocumentComponent. Wanneer Begrippen gepresenteerd moeten worden als onderdeel van de lopende tekst, gebruik dan de inhoud van het bovenliggende DocumentComponent; wanneer verwezen wordt naar een Begrip vanuit een andere locatie, gebruik dan het embedded DocumentComponent.\n" }, "DivisieannotatiesRenvooi": { "title": "Annotaties en renvooi bij vrije-tekststructuur", "type": "object", "properties": { "divisies": { "type": "array", "items": { "$ref": "#/components/schemas/DivisieRenvooi" } }, "divisieteksten": { "type": "array", "items": { "$ref": "#/components/schemas/DivisietekstRenvooi" } }, "tekstdelen": { "type": "array", "items": { "$ref": "#/components/schemas/TekstdeelRenvooi" } }, "hoofdlijnen": { "type": "array", "items": { "$ref": "#/components/schemas/HoofdlijnRenvooi" } }, "gebiedsaanwijzingen": { "type": "array", "items": { "$ref": "#/components/schemas/GebiedsaanwijzingRenvooi" } }, "kaarten": { "type": "array", "items": { "$ref": "#/components/schemas/KaartDivisieRenvooi" } }, "locaties": { "type": "array", "items": { "$ref": "#/components/schemas/LocatieRenvooi" } } } }, "AnnotatieBesluitRenvooiLinks": { "title": "AnnotatieRenvooiLinks", "required": [ "besluitversie", "documentcomponenten", "self" ], "type": "object", "properties": { "self": { "$ref": "#/components/schemas/HalLink" }, "besluitversie": { "$ref": "#/components/schemas/HalLink" }, "documentcomponenten": { "$ref": "#/components/schemas/HalLink" }, "wijzigtRegelingVersie": { "$ref": "#/components/schemas/HalLink" }, "geconsolideerdeRegelingVersie": { "$ref": "#/components/schemas/HalLink" } } }, "RegeltekstannotatiesRenvooi": { "title": "Annotaties en renvooi bij artikelstructuur", "type": "object", "properties": { "regelteksten": { "type": "array", "items": { "$ref": "#/components/schemas/RegeltekstRenvooi" } }, "regelsVoorIedereen": { "type": "array", "items": { "$ref": "#/components/schemas/RegelVoorIedereenRenvooi" } }, "omgevingswaarderegels": { "type": "array", "items": { "$ref": "#/components/schemas/OmgevingswaarderegelRenvooi" } }, "instructieregels": { "type": "array", "items": { "$ref": "#/components/schemas/InstructieregelRenvooi" } }, "omgevingsnormen": { "type": "array", "items": { "$ref": "#/components/schemas/NormRenvooi" } }, "omgevingswaarden": { "type": "array", "items": { "$ref": "#/components/schemas/NormRenvooi" } }, "gebiedsaanwijzingen": { "type": "array", "items": { "$ref": "#/components/schemas/GebiedsaanwijzingRenvooi" } }, "locaties": { "type": "array", "items": { "$ref": "#/components/schemas/LocatieRenvooi" } }, "activiteiten": { "type": "array", "items": { "$ref": "#/components/schemas/ActiviteitRenvooi" } }, "kaarten": { "type": "array", "items": { "$ref": "#/components/schemas/KaartRegeltekstRenvooi" } } } }, "BesluitMetadata": { "title": "BesluitMetadata", "type": "object", "properties": { "citeerTitel": { "title": "citeerTitel", "type": "string", "description": "De citeertitel van het besluit" } }, "description": "Kenmerken van het besluit die deze (ontwerp)regelingversie veroorzaakt heeft." }, "Ontwerpregistratiegegevens": { "title": "Ontwerpregistratiegegevens", "required": [ "tijdstipRegistratie", "versie" ], "type": "object", "properties": { "versie": { "title": "versie", "type": "number", "example": 1 }, "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Tijdstip waarop deze versie beschikbaar is bij Ozon. Deze versie is actief totdat er een nieuwe versie beschikbaar komt. Datumtijd in ISO 8601 formaat.", "format": "date-time", "example": "2022-04-12T23:20:50.52Z" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Tijdstip waarop een nieuwere versie beschikbaar is bij Ozon. Deze versie is vanaf dit moment niet meer actief. Datumtijd in ISO 8601 formaat.", "format": "date-time", "example": "2022-04-12T23:20:50.52Z" } }, "description": "Een informatieobject dat de tijdslijnen en versie van een ontwerpobject beschrijft" }, "OntwerpProcedureverloop": { "title": "Procedureverloop", "type": "object", "properties": { "bekendOp": { "title": "bekendOp", "type": "string", "description": "De datum waarop het ontwerp bekend is" }, "ontvangenOp": { "title": "bekendOp", "type": "string", "description": "De datum waarop het ontwerp ontvangen is" }, "procedurestappen": { "type": "array", "items": { "$ref": "#/components/schemas/OntwerpProcedurestap" } } }, "description": "De procedure die doorlopen is door deze ontwerpregeling." }, "EmbeddedOntwerpLocatie": { "title": "OntwerpLocatie", "required": [ "geregistreerdMet", "identificatie", "ontwerpbesluitIdentificatie", "technischId" ], "type": "object", "properties": { "identificatie": { "$ref": "#/components/schemas/StopIdentificatie" }, "ontwerpbesluitIdentificatie": { "$ref": "#/components/schemas/StopIdentificatie" }, "technischId": { "$ref": "#/components/schemas/TechnischId" }, "geometrieIdentificatie": { "title": "identificatie van de geometrie", "type": "string", "description": "De unieke identificatie van de geometrie waar deze locatie naar verwijst.", "example": "4b46ca74-3840-4ce1-91b6-abf749802f6c" }, "locatieType": { "$ref": "#/components/schemas/LocatieType" }, "noemer": { "title": "noemer", "type": "string", "description": "Tekstuele beschrijving van een Locatie, zodat er als zodanig over deze locatie gesproken kan worden. De beschrijving kan een bepaalde naam zijn waaronder de Locatie bekend staat, maar (lang) niet elke Locatie heef een naam." }, "status": { "title": "status", "type": "string", "description": "Met deze status kan aangegeven aangegeven dat een OW-object beëindigd moet worden." }, "boundingBox": { "$ref": "#/components/schemas/BoundingBox" }, "geregistreerdMet": { "$ref": "#/components/schemas/Ontwerpregistratiegegevens" }, "_embedded": { "$ref": "#/components/schemas/EmbeddedOntwerpLocatie__embedded" } }, "description": "Ontwerp Locatie met de boundingbox van de geometrie die bij deze locatie behoort" }, "OntwerpregelingLinks": { "title": "OntwerpregelingLinks", "required": [ "self" ], "type": "object", "properties": { "self": { "$ref": "#/components/schemas/HalLink" }, "annotaties": { "$ref": "#/components/schemas/HalLink" }, "documentstructuur": { "$ref": "#/components/schemas/HalLink" }, "beoogdeOpvolgerVan": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Een HalLink die verwijst naar de vastgestelde regelingen die de ontwerpregeling beoogt op te volgen." } ] } } }, "RegelingType": { "title": "RegelingType", "type": "string", "description": "Type regeling uit de limitatieve waardelijst https://gitlab.com/koop/STOP/standaard/-/blob/1.3.0/waardelijsten/soortregeling.xml", "example": "/join/id/stop/regelingtype_001" }, "AnnotatieOntwerpRenvooiLinks": { "title": "AnnotatieRenvooiLinks", "required": [ "documentstructuur", "ontwerpregeling", "self" ], "type": "object", "properties": { "self": { "$ref": "#/components/schemas/HalLink" }, "ontwerpregeling": { "$ref": "#/components/schemas/HalLink" }, "beoogdeOpvolgerVan": { "$ref": "#/components/schemas/HalLink" }, "documentstructuur": { "$ref": "#/components/schemas/HalLink" } } }, "OntwerpDocumentstructuurLinks": { "required": [ "afbeeldingenBasePath", "annotaties", "ontwerpregeling", "self" ], "type": "object", "properties": { "self": { "$ref": "#/components/schemas/HalLink" }, "regeling": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Deze property komt te vervallen, gebruik in plaats hiervan `ontwerpregeling`", "deprecated": true } ] }, "ontwerpregeling": { "$ref": "#/components/schemas/HalLink" }, "annotaties": { "$ref": "#/components/schemas/HalLink" }, "afbeeldingenBasePath": { "allOf": [ { "$ref": "#/components/schemas/HalLink" }, { "type": "object", "description": "Het absolute pad waaronder de afbeeldingen van het document gevonden kunnen worden. \nDit pad kan gecombineerd worden met bestandsnamen van afbeeldingen afkomstig uit documentcomponenten om het bestand op te halen.\n" } ] } } }, "OntwerpDocumentComponent": { "title": "OntwerpDocumentComponent", "required": [ "expressie", "identificatie", "type", "volgordeNummer" ], "type": "object", "properties": { "_links": { "$ref": "#/components/schemas/DocumentComponentLinks" }, "identificatie": { "$ref": "#/components/schemas/WId" }, "expressie": { "$ref": "#/components/schemas/EId" }, "type": { "title": "type", "type": "string" }, "volgordeNummer": { "title": "volgordeNummer", "type": "integer" }, "inhoud": { "title": "inhoud", "type": "string" }, "gereserveerd": { "title": "gereserveerd", "type": "string", "description": "Bevat een duiding of de document component gereserveerd is voor toekomstige invulling" }, "vervallen": { "title": "vervallen", "type": "string", "description": "Bevat een duiding of de document component eerder inhoud bevatte die nu vervallen is" }, "conditieArtikel": { "$ref": "#/components/schemas/ConditieArtikel" }, "kop": { "title": "label als XML", "type": "string" }, "bevatOntwerpInformatie": { "title": "bevatOntwerpInformatie", "type": "boolean", "description": "`true` als de property `bevatRenvooi` `true` is, of gekoppelde OW-objecten wijzigingen bevatten ten opzichte van de beoogde opvolger. \n\n*Deprecated:* Deze property komt te vervallen, de informatie kan opgehaald worden op basis van de `bevatRenvooi`-property en de `_refsBevattenDeltas`-property uit annotaties-endpoints.\n", "deprecated": true }, "bevatRenvooi": { "title": "bevatRenvooi", "type": "boolean", "description": "`true` als de documentcomponent wijzigingen bevat in de kop of inhoud, zoals inhoudelijke wijziging, of een toevoeging of verwijdering." }, "wijzigactie": { "type": "string", "enum": [ "voegtoe", "verwijder", "nieuweContainer", "verwijderContainer" ] }, "_embedded": { "$ref": "#/components/schemas/OntwerpDocumentstructuur__embedded" } }, "description": "DocumentComponent van een ontwerpregeling, zoals bedoeld in CIMOW. Let op: DocumentComponenten van het type 'Begrip' komen dubbel voor: eerst in de inhoud van het bovenliggende DocumentComponent en daarnaast als op zichzelf staand embedded DocumentComponent. Wanneer Begrippen gepresenteerd moeten worden als onderdeel van de lopende tekst, gebruik dan de inhoud van het bovenliggende DocumentComponent; wanneer verwezen wordt naar een Begrip vanuit een andere locatie, gebruik dan het embedded DocumentComponent.\n" }, "SoortVergunning": { "title": "SoortVergunning", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "title": "code", "type": "string" }, "waarde": { "title": "waarde", "type": "string" } } }, "OmgevingsvergunningLinks": { "title": "OmgevingsvergunningLinks", "required": [ "self" ], "type": "object", "properties": { "self": { "$ref": "#/components/schemas/HalLink" }, "heeftVergunningsgebied": { "$ref": "#/components/schemas/HalLink" } } }, "GebiedsaanwijzingOnderwerp": { "title": "GebiedsaanwijzingOnderwerp", "required": [ "identificatie", "naam" ], "type": "object", "properties": { "identificatie": { "type": "string" }, "naam": { "type": "string" } } }, "ActiviteitOnderwerp": { "title": "ActiviteitOnderwerp", "required": [ "activiteitLocatieaanduidingen", "identificatie", "naam" ], "type": "object", "properties": { "identificatie": { "type": "string" }, "naam": { "type": "string" }, "activiteitLocatieaanduidingen": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "ThemaOnderwerp": { "title": "ThemaOnderwerp", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/thema/id/concept/Bodem" }, "waarde": { "type": "string", "example": "bodem" } }, "description": "Kernachtige weergave van de grondgedachte achter een regel of tekstdeel.\nThema is één van de waarden op de limitatieve waardelijst https://standaarden.omgevingswet.overheid.nl/id/waardelijst/Thema.\n" }, "RegelingOnderwerpenLinks": { "title": "RegelingOntwerpenLinks", "required": [ "documentstructuur", "regeling" ], "type": "object", "properties": { "regeling": { "$ref": "#/components/schemas/HalLink" }, "documentstructuur": { "$ref": "#/components/schemas/HalLink" }, "tijdelijkDeelVan": { "$ref": "#/components/schemas/HalLink" } } }, "OntwerpGebiedsaanwijzingOnderwerp": { "title": "OntwerpGebiedsaanwijzingOnderwerp", "type": "object", "allOf": [ { "$ref": "#/components/schemas/GebiedsaanwijzingOnderwerp" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/GebiedsaanwijzingOnderwerpDelta" } } } ] }, "OntwerpActiviteitOnderwerp": { "title": "OntwerpActiviteitOnderwerp", "type": "object", "allOf": [ { "$ref": "#/components/schemas/ActiviteitOnderwerp" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/ActiviteitOnderwerpDelta" } } } ] }, "OntwerpThemaOnderwerp": { "title": "OntwerpThemaOnderwerp", "type": "object", "allOf": [ { "$ref": "#/components/schemas/ThemaOnderwerp" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/ThemaOnderwerpDelta" } } } ] }, "OntwerpRegelingOnderwerpenLinks": { "title": "RegelingOntwerpenLinks", "required": [ "documentstructuur", "ontwerpregeling" ], "type": "object", "properties": { "ontwerpregeling": { "$ref": "#/components/schemas/HalLink" }, "documentstructuur": { "$ref": "#/components/schemas/HalLink" }, "beoogdeOpvolgerVan": { "$ref": "#/components/schemas/HalLink" } } }, "Href": { "title": "Href", "type": "string", "format": "uri", "example": "datapunt.voorbeeldgemeente.nl/api/resourcename/123456789" }, "SelfLinks": { "title": "SelfLinks", "required": [ "self" ], "type": "object", "properties": { "self": { "$ref": "#/components/schemas/HalLink" } } }, "LocatieType": { "title": "LocatieType", "type": "string", "enum": [ "Gebied", "Lijn", "Punt", "Gebiedengroep", "Lijnengroep", "Puntengroep", "Ambtsgebied" ] }, "BoundingBox": { "title": "BoundingBox", "required": [ "maxX", "maxY", "minX", "minY" ], "type": "object", "properties": { "minX": { "multipleOf": 0.001, "type": "number" }, "minY": { "multipleOf": 0.001, "type": "number" }, "maxX": { "multipleOf": 0.001, "type": "number" }, "maxY": { "multipleOf": 0.001, "type": "number" } }, "description": "De bounding box van de bij de locatie behorende geometrie. Indien de locatie een groep is, is de bounding box het resultaat van alle onderliggende bounding boxes gecombineerd." }, "HalLink": { "title": "HalLink", "required": [ "href" ], "type": "object", "properties": { "href": { "$ref": "#/components/schemas/Href" } }, "description": "Hyperlink naar gerelateerde resource" }, "GeometryCollection": { "title": "GeometryCollection", "required": [ "geometries", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "GeometryCollection" ] }, "geometries": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Point" }, { "$ref": "#/components/schemas/LineString" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPoint" }, { "$ref": "#/components/schemas/MultiLineString" }, { "$ref": "#/components/schemas/MultiPolygon" } ] } } } }, "Point": { "title": "Point", "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "minItems": 2, "type": "array", "items": { "multipleOf": 0.001, "type": "number" } }, "bbox": { "minItems": 4, "type": "array", "items": { "multipleOf": 0.001, "type": "number" } } } }, "LineString": { "title": "LineString", "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "LineString" ] }, "coordinates": { "minItems": 2, "type": "array", "items": { "minItems": 2, "type": "array", "items": { "multipleOf": 0.001, "type": "number" } } }, "bbox": { "minItems": 4, "type": "array", "items": { "multipleOf": 0.001, "type": "number" } } } }, "Polygon": { "title": "Polygon", "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "Polygon" ] }, "coordinates": { "type": "array", "items": { "minItems": 4, "type": "array", "items": { "minItems": 2, "type": "array", "items": { "multipleOf": 0.001, "type": "number" } } } }, "bbox": { "minItems": 4, "type": "array", "items": { "multipleOf": 0.001, "type": "number" } } } }, "MultiPoint": { "title": "MultiPoint", "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "MultiPoint" ] }, "coordinates": { "type": "array", "items": { "minItems": 2, "type": "array", "items": { "multipleOf": 0.001, "type": "number" } } }, "bbox": { "minItems": 4, "type": "array", "items": { "multipleOf": 0.001, "type": "number" } } } }, "MultiLineString": { "title": "MultiLineString", "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "MultiLineString" ] }, "coordinates": { "type": "array", "items": { "minItems": 2, "type": "array", "items": { "minItems": 2, "type": "array", "items": { "multipleOf": 0.001, "type": "number" } } } }, "bbox": { "minItems": 4, "type": "array", "items": { "multipleOf": 0.001, "type": "number" } } } }, "MultiPolygon": { "title": "MultiPolygon", "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "MultiPolygon" ] }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "minItems": 4, "type": "array", "items": { "minItems": 2, "type": "array", "items": { "multipleOf": 0.001, "type": "number" } } } } }, "bbox": { "minItems": 4, "type": "array", "items": { "multipleOf": 0.001, "type": "number" } } } }, "DocumentComponentLinks": { "title": "DocumentComponentLinks", "type": "object", "properties": { "annotaties": { "$ref": "#/components/schemas/HalLink" } } }, "WId": { "title": "wId", "type": "string", "format": "uri", "example": "mnre0000_1__chp_1" }, "EId": { "title": "eId", "type": "string", "example": "chp_1__art_1.1" }, "ConditieArtikel": { "title": "conditieArtikel", "type": "object", "properties": { "kop": { "title": "kop", "type": "string" }, "inhoud": { "title": "inhoud", "type": "string" } }, "description": "Bevat basisinformatie over het ConditieArtikel, indien aanwezig.\nDeprecated: Komt te vervallen, gebruik de query parameter `_conditieArtikel=eigenDocumentComponent` om het ConditieArtikel als los documentcomponent te ontvangen.\n", "deprecated": true }, "DivisieSpec": { "title": "DivisieSpec", "required": [ "identificatie", "wId" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1911.divisie.20240101" }, "wId": { "type": "string", "example": "gm1911_1__div_o_1" } } }, "DivisietekstSpec": { "title": "DivisietekstSpec", "required": [ "identificatie", "wId" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1911.divisietekst.20240101" }, "wId": { "type": "string", "example": "gm1911_1__div_o_1__content_i" } } }, "TekstdeelSpec": { "title": "TekstdeelSpec", "required": [ "identificatie" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1911.tekstdeel.20220001" }, "idealisatie": { "$ref": "#/components/schemas/Idealisatie" }, "divisieRef": { "type": "string", "example": "nl.imow-gm1911.divisie.20220001" }, "divisietekstRef": { "type": "string", "example": "nl.imow-gm1911.divisietekst.20220003" }, "themas": { "type": "array", "items": { "$ref": "#/components/schemas/Thema" } }, "locatieRefs": { "type": "array", "items": { "type": "string", "example": "nl.imow-gm1911.gebiedengroep.BuitengebiedWieringerwaard" } }, "gebiedsaanwijzingRefs": { "type": "array", "items": { "type": "string", "example": "nl.imow-gm1911.gebiedsaanwijzing" } }, "hoofdlijnRefs": { "type": "array", "items": { "type": "string", "example": "nl.imow-gm1911.hoofdlijn" } }, "kaartRefs": { "type": "array", "items": { "type": "string", "example": "nl.imow-gm1911.kaart.Herleven" } } } }, "GebiedsaanwijzingSpec": { "title": "GebiedsaanwijzingSpec", "required": [ "groep", "identificatie", "locatieRefs", "naam", "symboolcodes", "type" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1911.gebiedsaanwijzing.20240101" }, "naam": { "type": "string", "example": "Leefmilieus" }, "groep": { "$ref": "#/components/schemas/Gebiedsaanwijzinggroep" }, "type": { "$ref": "#/components/schemas/TypeGebiedsaanwijzing" }, "symboolcodes": { "$ref": "#/components/schemas/Symboolcodes" }, "locatieRefs": { "$ref": "#/components/schemas/LocatieRefs" } } }, "HoofdlijnSpec": { "title": "HoofdlijnSpec", "required": [ "identificatie", "naam", "soort" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1911.hoofdlijn.20240101" }, "naam": { "type": "string", "example": "Visie" }, "soort": { "type": "string", "example": "Visie Hollands Kroon" }, "gerelateerdeHoofdlijnRefs": { "$ref": "#/components/schemas/HoofdlijnRefs" } } }, "LocatieSpec": { "title": "Locatie", "required": [ "identificatie", "locatieType" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1911.gebiedengroep.20240101" }, "noemer": { "type": "string", "example": "Gemeente Hollands Kroon" }, "locatieType": { "$ref": "#/components/schemas/LocatieType" }, "geometrieIdentificatie": { "type": "string", "example": "4b46ca74-3840-4ce1-91b6-abf749802f6c" }, "locatieRefs": { "$ref": "#/components/schemas/LocatieRefs" } } }, "LocatieExtraInfo": { "title": "extraInfo", "type": "object", "properties": { "boundingBox": { "$ref": "#/components/schemas/BoundingBox" } } }, "KaartSpec": { "title": "Kaart", "required": [ "identificatie", "naam" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1979.kaart.20240101" }, "naam": { "type": "string", "example": "Kaartvoorbeeld Delfzijl" }, "nummer": { "type": "string" }, "uitsnede": { "$ref": "#/components/schemas/Kaartextent" } }, "description": "Ruimtelijke weergave van een specifiek onderdeel van een beleid of realisatie. Een volledig Kaart-object heeft altijd\nde properties 'uitsnede' en 'kaartlagen', maar in bepaalde situaties worden Kaarten gereduceerd uitgeleverd en\nbevatten dan alleen de properties 'identificatie' en 'naam'. Dit gebeurt om precies te zijn als divisie- of\nregeltekstannotaties gefilterd worden opgehaald, als een wId ('documentComponent' parameter) of een geo-zoek\nrequest body aan het request worden meegegeven.\n" }, "KaartlaagDivisie": { "title": "KaartlaagDivisie", "type": "object", "allOf": [ { "$ref": "#/components/schemas/KaartlaagSpec" }, { "type": "object", "properties": { "gebiedsaanwijzingRefs": { "$ref": "#/components/schemas/GebiedsaanwijzingRefs" } } } ] }, "RegeltekstSpec": { "title": "RegeltekstSpec", "required": [ "identificatie", "wId" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1911.regeltekst.20240101" }, "wId": { "type": "string", "example": "gm1911_v1__chp_4__art_4.1" } } }, "RegelVoorIedereenSpec": { "title": "RegelVoorIedereenSpec", "required": [ "idealisatie", "identificatie", "locatieRefs", "regeltekstRef" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1911.juridischeregel.20240101" }, "idealisatie": { "$ref": "#/components/schemas/Idealisatie" }, "regeltekstRef": { "type": "string", "example": "nl.imow-gm1911.regeltekst.chp6art22" }, "themas": { "type": "array", "items": { "$ref": "#/components/schemas/Thema" } }, "activiteitLocatieaanduidingen": { "type": "array", "items": { "$ref": "#/components/schemas/ActiviteitLocatieaanduiding" } }, "locatieRefs": { "$ref": "#/components/schemas/LocatieRefs" }, "gebiedsaanwijzingRefs": { "$ref": "#/components/schemas/GebiedsaanwijzingRefs" }, "omgevingsnormRefs": { "$ref": "#/components/schemas/OmgevingsnormRefs" }, "kaartRefs": { "$ref": "#/components/schemas/KaartRefs" } } }, "OmgevingswaarderegelSpec": { "title": "OmgevingswaarderegelSpec", "required": [ "idealisatie", "identificatie", "locatieRefs", "regeltekstRef" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1911.juridischeregel.20240101" }, "idealisatie": { "$ref": "#/components/schemas/Idealisatie" }, "regeltekstRef": { "type": "string", "example": "nl.imow-gm1911.regeltekst.20240101" }, "themas": { "type": "array", "items": { "$ref": "#/components/schemas/Thema" } }, "locatieRefs": { "$ref": "#/components/schemas/LocatieRefs" }, "gebiedsaanwijzingRefs": { "$ref": "#/components/schemas/GebiedsaanwijzingRefs" }, "omgevingswaardeRefs": { "$ref": "#/components/schemas/OmgevingswaardeRefs" }, "kaartRefs": { "$ref": "#/components/schemas/KaartRefs" } } }, "InstructieregelSpec": { "title": "InstructieregelSpec", "required": [ "idealisatie", "identificatie", "locatieRefs", "regeltekstRef" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.gm19011.juridischeregel.20240101" }, "idealisatie": { "$ref": "#/components/schemas/Idealisatie" }, "regeltekstRef": { "type": "string", "example": "nl.gm19011.regeltekst.20240101" }, "themas": { "type": "array", "items": { "$ref": "#/components/schemas/Thema" } }, "instructieregelTaakuitoefeningen": { "type": "array", "items": { "$ref": "#/components/schemas/Adressaat" } }, "instructieregelInstrumenten": { "type": "array", "items": { "$ref": "#/components/schemas/Instrument" } }, "locatieRefs": { "$ref": "#/components/schemas/LocatieRefs" }, "gebiedsaanwijzingRefs": { "$ref": "#/components/schemas/GebiedsaanwijzingRefs" }, "omgevingsnormRefs": { "$ref": "#/components/schemas/OmgevingsnormRefs" }, "kaartRefs": { "$ref": "#/components/schemas/KaartRefs" } } }, "ActiviteitSpec": { "title": "ActiviteitSpec", "required": [ "groep", "identificatie", "naam", "symboolcodes" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-mnre1034.activiteit.ActiviteitenWerelderfgoed" }, "naam": { "type": "string", "example": "Activiteit die werelderfgoed betreft" }, "groep": { "$ref": "#/components/schemas/Activiteitengroep" }, "symboolcodes": { "$ref": "#/components/schemas/Symboolcodes" }, "bovenliggendeActiviteitRef": { "type": "string", "example": "nl.imow-mnre1034.activiteit.ActiviteitInAmvb" }, "gerelateerdeActiviteitRefs": { "$ref": "#/components/schemas/ActiviteitRefs" } } }, "NormSpec": { "title": "NormSpec", "required": [ "groep", "identificatie", "naam", "normwaarden", "symboolcodes", "type" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1911.omgevingsnorm.20240101" }, "naam": { "type": "string", "example": "Bouwhoogte" }, "type": { "$ref": "#/components/schemas/TypeNorm" }, "eenheid": { "$ref": "#/components/schemas/Eenheid" }, "groep": { "$ref": "#/components/schemas/Normgroep" }, "normwaarden": { "type": "array", "items": { "$ref": "#/components/schemas/Normwaarde" } }, "symboolcodes": { "$ref": "#/components/schemas/Symboolcodes" } } }, "KaartlaagRegeltekst": { "title": "KaartlaagRegeltekst", "type": "object", "allOf": [ { "$ref": "#/components/schemas/KaartlaagSpec" }, { "type": "object", "properties": { "gebiedsaanwijzingRefs": { "$ref": "#/components/schemas/GebiedsaanwijzingRefs" }, "omgevingsnormRefs": { "$ref": "#/components/schemas/OmgevingsnormRefs" }, "omgevingswaardeRefs": { "$ref": "#/components/schemas/OmgevingswaardeRefs" }, "activiteitLocatieaanduidingRefs": { "$ref": "#/components/schemas/ActiviteitLocatieaanduidingRefs" } } } ] }, "BesluitversieProcedurestap": { "title": "Procedurestap", "type": "object", "properties": { "soortStap": { "$ref": "#/components/schemas/BesluitversieSoortStap" }, "voltooidOp": { "title": "voltooidOp", "type": "string", "description": "De datum waarop het voltooid is." } } }, "DivisieRenvooi": { "title": "DivisieRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/DivisieSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/DivisieDelta" }, "_refsBevattenDeltas": { "$ref": "#/components/schemas/RefsBevattenDeltas" } } } ] }, "DivisietekstRenvooi": { "title": "DivisietekstRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/DivisietekstSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/DivisietekstDelta" }, "_refsBevattenDeltas": { "$ref": "#/components/schemas/RefsBevattenDeltas" } } } ] }, "TekstdeelRenvooi": { "title": "TekstdeelRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/TekstdeelSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/TekstdeelDelta" }, "themas": { "type": "array", "items": { "$ref": "#/components/schemas/ThemaRenvooi" } }, "idealisatie": { "$ref": "#/components/schemas/IdealisatieRenvooi" } } } ] }, "HoofdlijnRenvooi": { "title": "HoofdlijnRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HoofdlijnSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/HoofdlijnDelta" } } } ] }, "GebiedsaanwijzingRenvooi": { "title": "GebiedsaanwijzingRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/GebiedsaanwijzingSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/GebiedsaanwijzingDelta" }, "groep": { "$ref": "#/components/schemas/GebiedsaanwijzinggroepRenvooi" }, "type": { "$ref": "#/components/schemas/TypeGebiedsaanwijzingRenvooi" }, "symboolcodes": { "$ref": "#/components/schemas/SymboolcodesRenvooi" } } } ] }, "KaartDivisieRenvooi": { "title": "KaartDivisieRenvooi", "type": "object", "properties": { "kaartlagen": { "type": "array", "items": { "$ref": "#/components/schemas/KaartlaagDivisieRenvooi" } } }, "allOf": [ { "$ref": "#/components/schemas/KaartRenvooiSpec" } ] }, "LocatieRenvooi": { "title": "LocatieRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/LocatieSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/LocatieDelta" }, "_extraInfo": { "$ref": "#/components/schemas/LocatieExtraInfo" } } } ] }, "RegeltekstRenvooi": { "title": "RegeltekstRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/RegeltekstSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/RegeltekstDelta" }, "_refsBevattenDeltas": { "$ref": "#/components/schemas/RefsBevattenDeltas" } } } ] }, "RegelVoorIedereenRenvooi": { "title": "RegelVoorIedereenRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/RegelVoorIedereenSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/RegelVoorIedereenDelta" }, "themas": { "type": "array", "items": { "$ref": "#/components/schemas/ThemaRenvooi" } }, "activiteitLocatieaanduidingen": { "type": "array", "items": { "$ref": "#/components/schemas/ActiviteitLocatieaanduidingRenvooi" } }, "idealisatie": { "$ref": "#/components/schemas/IdealisatieRenvooi" } } } ] }, "OmgevingswaarderegelRenvooi": { "title": "OmgevingswaarderegelRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/OmgevingswaarderegelSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/OmgevingswaarderegelDelta" }, "themas": { "type": "array", "items": { "$ref": "#/components/schemas/ThemaRenvooi" } }, "idealisatie": { "$ref": "#/components/schemas/IdealisatieRenvooi" } } } ] }, "InstructieregelRenvooi": { "title": "InstructieregelRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/InstructieregelSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/InstructieregelDelta" }, "themas": { "type": "array", "items": { "$ref": "#/components/schemas/ThemaRenvooi" } }, "instructieregelTaakuitoefeningen": { "type": "array", "items": { "$ref": "#/components/schemas/AdressaatRenvooi" } }, "instructieregelInstrumenten": { "type": "array", "items": { "$ref": "#/components/schemas/InstrumentRenvooi" } }, "idealisatie": { "$ref": "#/components/schemas/IdealisatieRenvooi" } } } ] }, "NormRenvooi": { "title": "NormRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/NormSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/NormDelta" }, "normwaarden": { "type": "array", "items": { "$ref": "#/components/schemas/NormwaardeRenvooi" } }, "type": { "$ref": "#/components/schemas/TypeNormRenvooi" }, "eenheid": { "$ref": "#/components/schemas/EenheidRenvooi" }, "groep": { "$ref": "#/components/schemas/NormgroepRenvooi" }, "symboolcodes": { "$ref": "#/components/schemas/SymboolcodesRenvooi" } } } ] }, "ActiviteitRenvooi": { "title": "ActiviteitRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/ActiviteitSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/ActiviteitDelta" }, "groep": { "$ref": "#/components/schemas/ActiviteitengroepRenvooi" }, "symboolcodes": { "$ref": "#/components/schemas/SymboolcodesRenvooi" } } } ] }, "KaartRegeltekstRenvooi": { "title": "KaartRegeltekstRenvooi", "type": "object", "properties": { "kaartlagen": { "type": "array", "items": { "$ref": "#/components/schemas/KaartlaagRegeltekstRenvooi" } } }, "allOf": [ { "$ref": "#/components/schemas/KaartRenvooiSpec" } ] }, "OntwerpProcedurestap": { "title": "Procedurestap", "type": "object", "properties": { "soortStap": { "$ref": "#/components/schemas/OntwerpSoortStap" }, "voltooidOp": { "title": "voltooidOp", "type": "string", "description": "De datum waarop het voltooid is." } }, "description": "" }, "DeltaBewerking": { "title": "DeltaBewerking", "type": "string", "example": "wijzigen", "enum": [ "toevoegen", "verwijderen", "wijzigen" ] }, "DeltaBewerkingToevoegenVerwijderen": { "title": "DeltaBewerkingToevoegenVerwijderen", "type": "string", "example": "toevoegen", "enum": [ "toevoegen", "verwijderen" ] }, "Idealisatie": { "title": "Idealisatie", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/idealisatie/id/concept/Exact" }, "waarde": { "type": "string", "example": "exact" } }, "description": "Vastlegging van de manier waarop de begrenzing van Locatie voor deze Juridische\nregel of dit Tekstdeel geïnterpreteerd moet worden en door het bevoegd gezag bedoeld is.\nIdealisatie is één van de waarden op de limitatieve waardelijst https://standaarden.omgevingswet.overheid.nl/id/waardelijst/Idealisatie.\n" }, "Thema": { "title": "Thema", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/thema/id/concept/Bodem" }, "waarde": { "type": "string", "example": "bodem" } }, "description": "Kernachtige weergave van de grondgedachte achter een regel of tekstdeel.\nThema is één van de waarden op de limitatieve waardelijst https://standaarden.omgevingswet.overheid.nl/id/waardelijst/Thema.\n" }, "Gebiedsaanwijzinggroep": { "title": "Gebiedsaanwijzinggroep", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/bodem/id/concept/Bodembeheergebied" }, "waarde": { "type": "string", "example": "bodembeheergebied" } }, "description": "Een categorie, of groep, waaronder het object valt.\nGebiedsaanwijzingGroep is één van de waarden op één van de limitatieve waardelijsten\nbehorende bij een specifiek type gebiedsaanwijzing. Bijvoorbeeld, voor het type gebiedsaanwijzing\n'Bodem' is de bijbehorende waardelijst https://standaarden.omgevingswet.overheid.nl/id/waardelijst/Bodemgroep.\nZie voor de verschillende types gebiedsaanwijzing de limitatieve waardelijst \nhttps://standaarden.omgevingswet.overheid.nl/id/waardelijst/TypeGebiedsaanwijzing\n" }, "TypeGebiedsaanwijzing": { "title": "TypeGebiedsaanwijzing", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/typegebiedsaanwijzing/id/concept/Beperkingengebied" }, "waarde": { "type": "string", "example": "beperkingengebied" } }, "description": "Het type gebiedsaanwijzing \nType Gebiedsaanwijzing is één van de waarden op de limitatieve waardelijst https://standaarden.omgevingswet.overheid.nl/id/waardelijst/TypeGebiedsaanwijzing.\n" }, "Symboolcodes": { "title": "Symboolcodes", "type": "object", "properties": { "lijn": { "type": "string", "example": "l001" }, "punt": { "type": "string", "example": "p103" }, "vlak": { "type": "string", "example": "v035" } } }, "HoofdlijnRefs": { "title": "HoofdlijnRefs", "type": "array", "items": { "type": "string", "example": "nl.imow-gm1911.hoofdlijn.20240101" } }, "Kaartextent": { "title": "Kaartextent", "required": [ "maxX", "maxY", "minX", "minY" ], "type": "object", "properties": { "minX": { "type": "number", "example": 256721 }, "minY": { "type": "number", "example": 590605 }, "maxX": { "type": "number", "example": 264383 }, "maxY": { "type": "number", "example": 595713 } } }, "KaartlaagSpec": { "title": "Kaartlaag", "required": [ "identificatie", "niveau" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1979.kaartlaag.20240101" }, "naam": { "type": "string", "example": "Industrieterrein" }, "niveau": { "type": "integer", "format": "int32", "example": 1 } } }, "GebiedsaanwijzingRefs": { "title": "GebiedsaanwijzingRefs", "type": "array", "items": { "type": "string", "example": "nl.imow-gm1911.gebiedsaanwijzing.20240101" } }, "ActiviteitLocatieaanduiding": { "title": "ActiviteitLocatieaanduiding", "required": [ "activiteitRef", "activiteitregelkwalificatie", "identificatie", "locatieRefs" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1911.activiteit.20240101" }, "activiteitRef": { "type": "string", "example": "nl.imow-gm1911.activiteit.20240101" }, "activiteitregelkwalificatie": { "$ref": "#/components/schemas/ActiviteitRegelkwalificatie" }, "locatieRefs": { "$ref": "#/components/schemas/LocatieRefs" } } }, "OmgevingsnormRefs": { "title": "OmgevingsnormRefs", "type": "array", "items": { "type": "string", "example": "nl.imow-gm1911.omgevingsnorm.20240101" } }, "KaartRefs": { "title": "KaartRefs", "type": "array", "items": { "type": "string", "example": "nl.imow-gm1911.kaart.20240101" } }, "OmgevingswaardeRefs": { "title": "OmgevingswaardeRefs", "type": "array", "items": { "type": "string", "example": "nl.imow-gm1911.omgevingswaarde.20240101" } }, "Adressaat": { "title": "Adressaat", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/adressaat/id/concept/BeheerderSpoor" }, "waarde": { "type": "string", "example": "beheerder spoor" } }, "description": "Het bestuursorgaan dat of de organisatie die de taak waarover de juridische regel gaat, moet uitvoeren.\nAdressaat is één van de waarden op de limitatieve waardelijst https://standaarden.omgevingswet.overheid.nl/id/waardelijst/Adressaat.\n" }, "Instrument": { "title": "Instrument", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/instrument/id/concept/BesluitGeldelijkeRegelingen" }, "waarde": { "type": "string", "example": "besluit geldelijke regelingen" } }, "description": "De naam van het instrument waartoe de instructieregel zich richt.\nInstrument is één van de waarden op de limitatieve waardelijst https://standaarden.omgevingswet.overheid.nl/id/waardelijst/Instrument.\n" }, "Activiteitengroep": { "title": "Activiteitengroep", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/activiteit/id/concept/Aansluitactiviteit" }, "waarde": { "type": "string", "example": "aansluitactiviteit" } }, "description": "Een categorie, of groep, waaronder een activiteit valt.\nThema is één van de waarden op de limitatieve waardelijst https://standaarden.omgevingswet.overheid.nl/id/waardelijst/Thema.\n" }, "ActiviteitRefs": { "title": "ActiviteitRefs", "type": "array", "items": { "type": "string", "example": "nl.imow-gm1911.activiteit.20240101" } }, "TypeNorm": { "title": "TypeNorm", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/typenorm/id/concept/Aaneengebouwd" }, "waarde": { "type": "string", "example": "aaneengebouwd" } }, "description": "Het type/soort norm, zoals bijvoorbeeld een maximumbouwhoogte.\nType norm is één van de waarden op de limitatieve waardelijst https://standaarden.omgevingswet.overheid.nl/id/waardelijst/TypeNorm.\n" }, "Eenheid": { "title": "Eenheid", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/eenheid/id/concept/Aantal" }, "waarde": { "type": "string", "example": "aantal" } }, "description": "De eenheid van de waarde, voluit geschreven. \nEenheid is één van de waarden op de limitatieve waardelijst https://standaarden.omgevingswet.overheid.nl/id/waardelijst/Eenheid.\n" }, "Normgroep": { "title": "Normgroep", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/omgevingswaarde/id/concept/Energie" }, "waarde": { "type": "string", "example": "energie" } }, "description": "Omgevingsnormgroep of Omgevingswaardegroep, afhankelijk van het soort Norm. \nEen categorie, of groep, waaronder een omgevingsnorm resp. omgevingswaarde valt.\nOmgevingsnormgroep is één van de waarden op de limitatieve waardelijst https://standaarden.omgevingswet.overheid.nl/id/waardelijst/Omgevingsnormgroep.\nOmgevingswaardegroep is één van de waarden op de limitatieve waardelijst https://standaarden.omgevingswet.overheid.nl/id/waardelijst/Omgevingswaardegroep.\n" }, "Normwaarde": { "title": "Normwaarde", "type": "object", "properties": { "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" } }, "allOf": [ { "$ref": "#/components/schemas/NormwaardeSpec" } ] }, "ActiviteitLocatieaanduidingRefs": { "title": "ActiviteitLocatieaanduidingRefs", "type": "array", "items": { "type": "string", "example": "nl.imow-gm1911.activiteitlocatieaanduiding.20240101" } }, "BesluitversieSoortStap": { "title": "soortStap", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "title": "code", "type": "string" }, "waarde": { "title": "waarde", "type": "string" } }, "description": "De verschillende soorten stappen zijn te vinden in [deze waardelijst](https://gitlab.com/koop/STOP/standaard/-/blob/1.3.0/waardelijsten/procedurestap_definitief.xml).'\n" }, "RefsBevattenDeltas": { "title": "RefsBevattenDeltas", "type": "boolean", "description": "`true` als een van de direct en/of indirect onderliggende OW-objecten een bewerking bevat.\n\nIn volgende gevallen worden verwijzingen naar onderliggende OW-objecten genegeerd:\n- van kaartlagen naar gebiedsaanwijzingen, omgevingsnormen, omgevingswaarden en activiteitlocatieaanduidingen.\n- van activiteiten naar bovenliggende en gerelateerde activiteiten.\n- van hoofdlijnen naar gerelateerde hoofdlijnen.\n\nBewerkingen van de attributen van kaartlagen, activiteiten en hoofdlijnen worden niet genegeerd.\n\nBewerkingen van symboolcodes worden ook genegeerd. Dat is verbeelden-metadata, dus geen inhoudelijke aanpassing van de annotaties.\n" }, "LijstWijzigingenLocatieRefs": { "title": "LijstWijzigingenLocatieRefs", "type": "object", "properties": { "toegevoegd": { "$ref": "#/components/schemas/LocatieRefs" }, "verwijderd": { "$ref": "#/components/schemas/LocatieRefs" } } }, "LijstWijzigingenGebiedsaanwijzingRefs": { "title": "LijstWijzigingenGebiedsaanwijzingRefs", "type": "object", "properties": { "toegevoegd": { "$ref": "#/components/schemas/GebiedsaanwijzingRefs" }, "verwijderd": { "$ref": "#/components/schemas/GebiedsaanwijzingRefs" } } }, "LijstWijzigingenHoofdlijnRefs": { "title": "LijstWijzigingenHoofdlijnRefs", "type": "object", "properties": { "toegevoegd": { "$ref": "#/components/schemas/HoofdlijnRefs" }, "verwijderd": { "$ref": "#/components/schemas/HoofdlijnRefs" } } }, "LijstWijzigingenKaartRefs": { "title": "LijstWijzigingenKaartRefs", "type": "object", "properties": { "toegevoegd": { "$ref": "#/components/schemas/KaartRefs" }, "verwijderd": { "$ref": "#/components/schemas/KaartRefs" } } }, "ThemaRenvooi": { "title": "ThemaRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Thema" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/ThemaDelta" } } } ] }, "IdealisatieRenvooi": { "title": "IdealisatieRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Idealisatie" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/IdealisatieDelta" } } } ] }, "GebiedsaanwijzinggroepRenvooi": { "title": "GebiedsaanwijzinggroepRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Gebiedsaanwijzinggroep" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/GebiedsaanwijzinggroepDelta" } } } ] }, "TypeGebiedsaanwijzingRenvooi": { "title": "TypeGebiedsaanwijzingRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/TypeGebiedsaanwijzing" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/TypeGebiedsaanwijzingDelta" } } } ] }, "SymboolcodesRenvooi": { "title": "SymboolcodesRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Symboolcodes" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/SymboolcodesDelta" } } } ] }, "KaartRenvooiSpec": { "title": "KaartRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/KaartSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/KaartDelta" }, "uitsnede": { "$ref": "#/components/schemas/KaartextentRenvooi" } } } ] }, "KaartlaagDivisieRenvooi": { "title": "KaartlaagDivisieRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/KaartlaagDivisie" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/KaartlaagDivisieDelta" } } } ] }, "LijstWijzigingenOmgevingsnormRefs": { "title": "LijstWijzigingenOmgevingsnormRefs", "type": "object", "properties": { "toegevoegd": { "$ref": "#/components/schemas/OmgevingsnormRefs" }, "verwijderd": { "$ref": "#/components/schemas/OmgevingsnormRefs" } } }, "ActiviteitLocatieaanduidingRenvooi": { "title": "ActiviteitLocatieaanduidingRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/ActiviteitLocatieaanduiding" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/ActiviteitLocatieaanduidingDelta" }, "activiteitregelkwalificatie": { "$ref": "#/components/schemas/ActiviteitRegelkwalificatieRenvooi" } } } ] }, "LijstWijzigingenOmgevingswaardeRefs": { "title": "LijstWijzigingenOmgevingswaardeRefs", "type": "object", "properties": { "toegevoegd": { "$ref": "#/components/schemas/OmgevingswaardeRefs" }, "verwijderd": { "$ref": "#/components/schemas/OmgevingswaardeRefs" } } }, "AdressaatRenvooi": { "title": "AdressaatRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Adressaat" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/AdressaatDelta" } } } ] }, "InstrumentRenvooi": { "title": "InstrumentRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Instrument" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/InstrumentDelta" } } } ] }, "NormwaardeRenvooi": { "title": "NormwaardeRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/NormwaardeSpec" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/NormwaardeDelta" } } } ] }, "TypeNormRenvooi": { "title": "TypeNormRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/TypeNorm" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/TypeNormDelta" } } } ] }, "EenheidRenvooi": { "title": "EenheidRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Eenheid" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/EenheidDelta" } } } ] }, "NormgroepRenvooi": { "title": "NormgroepRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Normgroep" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/NormgroepDelta" } } } ] }, "LijstWijzigingenActiviteitRefs": { "title": "LijstWijzigingenActiviteitRefs", "type": "object", "properties": { "toegevoegd": { "$ref": "#/components/schemas/ActiviteitRefs" }, "verwijderd": { "$ref": "#/components/schemas/ActiviteitRefs" } } }, "ActiviteitengroepRenvooi": { "title": "ActiviteitengroepRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Activiteitengroep" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/ActiviteitengroepDelta" } } } ] }, "KaartlaagRegeltekstRenvooi": { "title": "KaartlaagRegeltekstRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/KaartlaagRegeltekst" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/KaartlaagRegeltekstDelta" } } } ] }, "OntwerpSoortStap": { "title": "soortStap", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "title": "code", "type": "string" }, "waarde": { "title": "waarde", "type": "string" } }, "description": "De verschillende soorten stappen zijn te vinden in [deze waardelijst](https://gitlab.com/koop/STOP/standaard/-/blob/1.3.0/waardelijsten/procedurestap_ontwerp.xml)." }, "ActiviteitRegelkwalificatie": { "title": "ActiviteitRegelkwalificatie", "required": [ "code", "waarde" ], "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/activiteitregelkwalificatie/id/concept/Gebod" }, "waarde": { "type": "string", "example": "gebod" } }, "description": "De naam van de kwalificatie van de Juridische regel over een activiteit. \nThema is één van de waarden op de limitatieve waardelijst https://standaarden.omgevingswet.overheid.nl/id/waardelijst/Activiteitregelkwalificatie.\n" }, "NormwaardeSpec": { "title": "NormwaardeSpec", "required": [ "identificatie", "locatieRefs" ], "type": "object", "properties": { "identificatie": { "type": "string", "example": "nl.imow-gm1911.normwaarde.20240101" }, "kwantitatieveWaarde": { "type": "number", "example": 3 }, "kwalitatieveWaarde": { "type": "string", "example": "laag" }, "waardeInRegeltekst": { "type": "string", "example": "waarde staat in regeltekst" }, "locatieRefs": { "$ref": "#/components/schemas/LocatieRefs" } } }, "DeltaBewerkingWijzigen": { "title": "DeltaBewerkingWijzigen", "type": "string", "example": "wijzigen", "enum": [ "wijzigen" ] }, "KaartextentRenvooi": { "title": "KaartextentRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Kaartextent" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/KaartextentDelta" } } } ] }, "ActiviteitRegelkwalificatieRenvooi": { "title": "ActiviteitRegelkwalificatieRenvooi", "type": "object", "allOf": [ { "$ref": "#/components/schemas/ActiviteitRegelkwalificatie" }, { "type": "object", "properties": { "_delta": { "$ref": "#/components/schemas/ActiviteitRegelkwalificatieDelta" } } } ] }, "LijstWijzigingenActiviteitLocatieaanduidingRefs": { "title": "LijstWijzigingenActiviteitLocatieaanduidingRefs", "type": "object", "properties": { "toegevoegd": { "$ref": "#/components/schemas/ActiviteitLocatieaanduidingRefs" }, "verwijderd": { "$ref": "#/components/schemas/ActiviteitLocatieaanduidingRefs" } } }, "Problem400": { "title": "Problem400", "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "type": "object", "properties": { "invalid-params": { "type": "array", "description": "Ongeldige parameters.", "items": { "$ref": "#/components/schemas/InvalidParam" } } } } ] }, "RegelingenEmbedded": { "title": "RegelingenEmbedded", "required": [ "regelingen" ], "type": "object", "properties": { "regelingen": { "type": "array", "items": { "$ref": "#/components/schemas/Regeling" } } } }, "RegelingAllOfEmbedded": { "title": "RegelingAllOfEmbedded", "type": "object", "properties": { "regelingsgebied": { "$ref": "#/components/schemas/EmbeddedLocatie" }, "pons": { "$ref": "#/components/schemas/EmbeddedLocatie" } } }, "Documentstructuur__embedded": { "required": [ "documentComponenten" ], "type": "object", "properties": { "documentComponenten": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentComponent" } } } }, "Voorkomens__embedded": { "required": [ "voorkomens" ], "type": "object", "properties": { "voorkomens": { "type": "array", "items": { "$ref": "#/components/schemas/Regeling" } } } }, "BesluitversiesEmbedded": { "title": "BesluitversiesEmbedded", "required": [ "besluitversies" ], "type": "object", "properties": { "besluitversies": { "type": "array", "items": { "$ref": "#/components/schemas/Besluitversie" } } } }, "Besluitversie__embedded": { "type": "object", "properties": { "wijzigtRegelingsgebied": { "$ref": "#/components/schemas/EmbeddedLocatie" }, "consolideertRegelingsgebied": { "$ref": "#/components/schemas/EmbeddedLocatie" } } }, "BesluitversieDocumentstructuur__embedded": { "required": [ "besluitversieDocumentComponenten" ], "type": "object", "properties": { "besluitversieDocumentComponenten": { "type": "array", "items": { "$ref": "#/components/schemas/BesluitversieDocumentComponent" } } } }, "OntwerpregelingenEmbedded": { "title": "OntwerpregelingenEmbedded", "required": [ "ontwerpregelingen" ], "type": "object", "properties": { "ontwerpregelingen": { "type": "array", "items": { "$ref": "#/components/schemas/Ontwerpregeling" } } } }, "Ontwerpregeling__embedded": { "type": "object", "properties": { "ontwerpRegelingsgebied": { "$ref": "#/components/schemas/EmbeddedOntwerpLocatie" }, "vastgesteldRegelingsgebied": { "$ref": "#/components/schemas/EmbeddedLocatie" } } }, "OntwerpDocumentstructuur__embedded": { "required": [ "ontwerpDocumentComponenten" ], "type": "object", "properties": { "ontwerpDocumentComponenten": { "type": "array", "items": { "$ref": "#/components/schemas/OntwerpDocumentComponent" } } } }, "OmgevingsvergunningenEmbedded": { "title": "OmgevingsvergunningenEmbedded", "required": [ "omgevingsvergunningen" ], "type": "object", "properties": { "omgevingsvergunningen": { "type": "array", "items": { "$ref": "#/components/schemas/Omgevingsvergunning" } } } }, "Omgevingsvergunning__embedded": { "type": "object", "properties": { "vergunningsgebied": { "$ref": "#/components/schemas/EmbeddedLocatie" } } }, "RegelingOnderwerpen": { "title": "RegelingOnderwerpen", "required": [ "_links", "identificatie" ], "type": "object", "properties": { "identificatie": { "type": "string" }, "gebiedsaanwijzingen": { "title": "GebiedsaanwijzingOnderwerpen", "type": "array", "items": { "$ref": "#/components/schemas/GebiedsaanwijzingOnderwerp" } }, "activiteiten": { "title": "ActiviteitOnderwerpen", "type": "array", "items": { "$ref": "#/components/schemas/ActiviteitOnderwerp" } }, "themas": { "title": "ThemaOnderwerpen", "type": "array", "items": { "$ref": "#/components/schemas/ThemaOnderwerp" } }, "_links": { "$ref": "#/components/schemas/RegelingOnderwerpenLinks" } } }, "OntwerpRegelingOnderwerpen": { "title": "OntwerpRegelingOnderwerpen", "required": [ "_links", "technischId" ], "type": "object", "properties": { "technischId": { "type": "string" }, "beoogdeOpvolgerVan": { "type": "string" }, "beoogdTijdelijkDeelVan": { "type": "string" }, "gebiedsaanwijzingen": { "title": "OntwerpGebiedsaanwijzingOnderwerpen", "type": "array", "items": { "$ref": "#/components/schemas/OntwerpGebiedsaanwijzingOnderwerp" } }, "activiteiten": { "title": "OntwerpActiviteitOnderwerpen", "type": "array", "items": { "$ref": "#/components/schemas/OntwerpActiviteitOnderwerp" } }, "themas": { "title": "OntwerpThemasOnderwerpen", "type": "array", "items": { "$ref": "#/components/schemas/OntwerpThemaOnderwerp" } }, "_links": { "$ref": "#/components/schemas/OntwerpRegelingOnderwerpenLinks" } } }, "AppHealth": { "title": "AppHealth", "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string", "enum": [ "UP", "DOWN" ] } } }, "Info_appinfo": { "type": "object", "properties": { "name": { "type": "string", "description": "Mens-leesbare naam van deze API." }, "version": { "type": "string", "description": "De versie van deze API zoals te lezen in de API spec en overeenkomende met de API-Version response header" }, "description": { "type": "string", "description": "Mens-leesbare beschrijving van deze API" }, "stopVersion": { "type": "string", "description": "Versie van de STOP/TPOD standaard waar deze API zich aan houdt" }, "cimowVersion": { "type": "string", "description": "Versie van het CIMOW informatiemodel waar deze API zich aan houdt" }, "imowVersion": { "type": "string", "description": "versie van het IMOW informatiemodel waar deze API zich aan houdt" } } }, "HalPaginationLinks_self": { "type": "object", "properties": { "href": { "$ref": "#/components/schemas/Href" } }, "description": "uri van de api aanroep die tot dit resultaat heeft geleid" }, "HalPaginationLinks_first": { "type": "object", "properties": { "href": { "$ref": "#/components/schemas/Href" }, "title": { "type": "string", "example": "Eerste pagina" } }, "description": "uri voor het opvragen van de eerste pagina van deze collectie" }, "HalPaginationLinks_last": { "type": "object", "properties": { "href": { "$ref": "#/components/schemas/Href" }, "title": { "type": "string", "example": "Laatste pagina" } }, "description": "uri voor het opvragen van de laatste pagina van deze collectie" }, "HalPaginationLinks_prev": { "type": "object", "properties": { "href": { "$ref": "#/components/schemas/Href" }, "title": { "type": "string", "example": "Vorige pagina" } }, "description": "uri voor het opvragen van de vorige pagina van deze collectie" }, "HalPaginationLinks_next": { "type": "object", "properties": { "href": { "$ref": "#/components/schemas/Href" }, "title": { "type": "string", "example": "Volgende pagina" } }, "description": "uri voor het opvragen van de volgende pagina van deze collectie" }, "EmbeddedLocatie__embedded": { "type": "object", "properties": { "omvat": { "type": "array", "items": { "$ref": "#/components/schemas/EmbeddedLocatie" } } } }, "EmbeddedOntwerpLocatie__embedded": { "type": "object", "properties": { "omvat": { "type": "array", "items": { "$ref": "#/components/schemas/EmbeddedOntwerpLocatie" } }, "omvatVastgesteld": { "type": "array", "items": { "$ref": "#/components/schemas/EmbeddedLocatie" } } } }, "GebiedsaanwijzingOnderwerpDeltaWijzigingen": { "title": "GebiedsaanwijzingOnderwerpDeltaWijzigingen", "type": "object", "properties": { "naam": { "type": "string", "example": "Leefmilieus" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd.\n" }, "GebiedsaanwijzingOnderwerpDelta": { "title": "GebiedsaanwijzingOnderwerpDelta", "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/GebiedsaanwijzingOnderwerpDeltaWijzigingen" } } }, "ActiviteitOnderwerpDeltaWijzigingen": { "title": "ActiviteitOnderwerpDeltaWijzigingen", "type": "object", "properties": { "naam": { "type": "string", "example": "Activiteit die werelderfgoed betreft" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nSommige velden zijn aangemerkt als `nullable`. Een nullable veld met waarde `null` betekent dat het veld in de vastgestelde regeling aanwezig is, maar afwezig in de ontwerpregeling.\n" }, "ActiviteitOnderwerpDelta": { "title": "ActiviteitOnderwerpDelta", "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/ActiviteitOnderwerpDeltaWijzigingen" } } }, "ThemaOnderwerpDelta": { "title": "ThemaOnderwerpDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerkingToevoegenVerwijderen" } } }, "DivisieDeltaWijzigingen": { "title": "DivisieDeltaWijzigingen", "type": "object", "properties": { "wId": { "type": "string", "example": "gm1911_1__div_o_1__content_i" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd.\n" }, "DivisieDelta": { "title": "DivisieDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/DivisieDeltaWijzigingen" } } }, "DivisietekstDeltaWijzigingen": { "title": "DivisietekstDeltaWijzigingen", "type": "object", "properties": { "wId": { "type": "string", "example": "gm1911_1__div_o_1__content_i" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd.\n" }, "DivisietekstDelta": { "title": "DivisietekstDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/DivisietekstDeltaWijzigingen" } } }, "TekstdeelDeltaWijzigingen": { "title": "TekstdeelDeltaWijzigingen", "type": "object", "properties": { "divisieRef": { "type": "string", "nullable": true, "example": "nl.imow-gm1911.divisie.20220001" }, "divisietekstRef": { "type": "string", "nullable": true, "example": "nl.imow-gm1911.divisietekst.20220003" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nSommige velden zijn aangemerkt als `nullable`. Een nullable veld met waarde `null` betekent dat het veld in de vastgestelde regeling aanwezig is, maar afwezig in de ontwerpregeling.\n" }, "TekstdeelDelta": { "title": "TekstdeelDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/TekstdeelDeltaWijzigingen" }, "lijstWijzigingen": { "allOf": [ { "title": "TekstdeelDeltaLijstWijzigingen", "type": "object", "properties": { "locatieRefs": { "$ref": "#/components/schemas/LijstWijzigingenLocatieRefs" }, "gebiedsaanwijzingRefs": { "$ref": "#/components/schemas/LijstWijzigingenGebiedsaanwijzingRefs" }, "hoofdlijnRefs": { "$ref": "#/components/schemas/LijstWijzigingenHoofdlijnRefs" }, "kaartRefs": { "$ref": "#/components/schemas/LijstWijzigingenKaartRefs" } } } ] } } }, "HoofdlijnDeltaWijzigingen": { "title": "HoofdlijnDeltaWijzigingen", "type": "object", "properties": { "naam": { "type": "string", "example": "Visie" }, "soort": { "type": "string", "example": "Visie Hollands Kroon" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd.\n" }, "HoofdlijnDeltaLijstWijzigingen": { "title": "HoofdlijnDeltaLijstWijzigingen", "type": "object", "properties": { "gerelateerdeHoofdlijnRefs": { "$ref": "#/components/schemas/LijstWijzigingenHoofdlijnRefs" } } }, "HoofdlijnDelta": { "title": "HoofdlijnDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/HoofdlijnDeltaWijzigingen" }, "lijstWijzigingen": { "$ref": "#/components/schemas/HoofdlijnDeltaLijstWijzigingen" } } }, "GebiedsaanwijzingDeltaWijzigingen": { "title": "GebiedsaanwijzingDeltaWijzigingen", "type": "object", "properties": { "naam": { "type": "string", "example": "Leefmilieus" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd.\n" }, "GebiedsaanwijzingDeltaLijstWijzigingen": { "title": "GebiedsaanwijzingDeltaLijstWijzigingen", "type": "object", "properties": { "locatieRefs": { "$ref": "#/components/schemas/LijstWijzigingenLocatieRefs" } } }, "GebiedsaanwijzingDelta": { "title": "GebiedsaanwijzingDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/GebiedsaanwijzingDeltaWijzigingen" }, "lijstWijzigingen": { "$ref": "#/components/schemas/GebiedsaanwijzingDeltaLijstWijzigingen" } } }, "LocatieDeltaWijzigingen": { "title": "LocatieDeltaWijzigingen", "type": "object", "properties": { "noemer": { "type": "string", "nullable": true, "example": "Gemeente Hollands Kroon" }, "geometrieIdentificatie": { "type": "string", "nullable": true, "example": "4b46ca74-3840-4ce1-91b6-abf749802f6c" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nSommige velden zijn aangemerkt als `nullable`. Een nullable veld met waarde `null` betekent dat het veld in de vastgestelde regeling aanwezig is, maar afwezig in de ontwerpregeling.\n" }, "LocatieDeltaLijstWijzigingen": { "title": "LocatieDeltaLijstWijzigingen", "type": "object", "properties": { "locatieRefs": { "$ref": "#/components/schemas/LijstWijzigingenLocatieRefs" } } }, "LocatieDelta": { "title": "LocatieDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/LocatieDeltaWijzigingen" }, "lijstWijzigingen": { "$ref": "#/components/schemas/LocatieDeltaLijstWijzigingen" } } }, "RegeltekstDeltaWijzigingen": { "title": "RegeltekstDeltaWijzigingen", "type": "object", "properties": { "wId": { "type": "string", "example": "gm1911_v1__chp_4__art_4.1" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd.\n" }, "RegeltekstDelta": { "title": "RegeltekstDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/RegeltekstDeltaWijzigingen" } } }, "RegelVoorIedereenDeltaWijzigingen": { "title": "RegelVoorIedereenDeltaWijzigingen", "type": "object", "properties": { "regeltekstRef": { "type": "string", "example": "nl.imow-gm1911.regeltekst.chp6art22" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd.\n" }, "RegelVoorIedereenDeltaLijstWijzigingen": { "title": "RegelVoorIedereenDeltaLijstWijzigingen", "type": "object", "properties": { "locatieRefs": { "$ref": "#/components/schemas/LijstWijzigingenLocatieRefs" }, "gebiedsaanwijzingRefs": { "$ref": "#/components/schemas/LijstWijzigingenGebiedsaanwijzingRefs" }, "omgevingsnormRefs": { "$ref": "#/components/schemas/LijstWijzigingenOmgevingsnormRefs" }, "kaartRefs": { "$ref": "#/components/schemas/LijstWijzigingenKaartRefs" } } }, "RegelVoorIedereenDelta": { "title": "RegelVoorIedereenDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/RegelVoorIedereenDeltaWijzigingen" }, "lijstWijzigingen": { "$ref": "#/components/schemas/RegelVoorIedereenDeltaLijstWijzigingen" } } }, "OmgevingswaarderegelDeltaWijzigingen": { "title": "OmgevingswaarderegelDeltaWijzigingen", "type": "object", "properties": { "regeltekstRef": { "type": "string", "example": "nl.imow-gm1911.regeltekst.20240101" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd.\n" }, "OmgevingswaarderegelDeltaLijstWijzigingen": { "title": "OmgevingswaarderegelDeltaLijstWijzigingen", "type": "object", "properties": { "locatieRefs": { "$ref": "#/components/schemas/LijstWijzigingenLocatieRefs" }, "gebiedsaanwijzingRefs": { "$ref": "#/components/schemas/LijstWijzigingenGebiedsaanwijzingRefs" }, "omgevingswaardeRefs": { "$ref": "#/components/schemas/LijstWijzigingenOmgevingswaardeRefs" }, "kaartRefs": { "$ref": "#/components/schemas/LijstWijzigingenKaartRefs" } } }, "OmgevingswaarderegelDelta": { "title": "OmgevingswaarderegelDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/OmgevingswaarderegelDeltaWijzigingen" }, "lijstWijzigingen": { "$ref": "#/components/schemas/OmgevingswaarderegelDeltaLijstWijzigingen" } } }, "InstructieregelDeltaWijzigingen": { "title": "InstructieregelDeltaWijzigingen", "type": "object", "properties": { "regeltekstRef": { "type": "string", "example": "nl.gm19011.regeltekst.20240101" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd.\n" }, "InstructieregelDeltaLijstWijzigingen": { "title": "InstructieregelDeltaLijstWijzigingen", "type": "object", "properties": { "locatieRefs": { "$ref": "#/components/schemas/LijstWijzigingenLocatieRefs" }, "gebiedsaanwijzingRefs": { "$ref": "#/components/schemas/LijstWijzigingenGebiedsaanwijzingRefs" }, "omgevingsnormRefs": { "$ref": "#/components/schemas/LijstWijzigingenOmgevingsnormRefs" }, "kaartRefs": { "$ref": "#/components/schemas/LijstWijzigingenKaartRefs" } } }, "InstructieregelDelta": { "title": "InstructieregelDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/InstructieregelDeltaWijzigingen" }, "lijstWijzigingen": { "$ref": "#/components/schemas/InstructieregelDeltaLijstWijzigingen" } } }, "NormDeltaWijzigingen": { "title": "NormDeltaWijzigingen", "type": "object", "properties": { "naam": { "type": "string", "example": "Bouwhoogte" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd.\n" }, "NormDelta": { "title": "NormDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/NormDeltaWijzigingen" } } }, "ActiviteitDeltaWijzigingen": { "title": "ActiviteitDeltaWijzigingen", "type": "object", "properties": { "naam": { "type": "string", "example": "Activiteit die werelderfgoed betreft" }, "bovenliggendeActiviteitRef": { "type": "string", "nullable": true, "example": "nl.imow-mnre1034.activiteit.Omgevingsplanactiviteit" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nSommige velden zijn aangemerkt als `nullable`. Een nullable veld met waarde `null` betekent dat het veld in de vastgestelde regeling aanwezig is, maar afwezig in de ontwerpregeling.\n" }, "ActiviteitDeltaLijstWijzigingen": { "title": "ActiviteitDeltaLijstWijzigingen", "type": "object", "properties": { "gerelateerdeActiviteitRefs": { "$ref": "#/components/schemas/LijstWijzigingenActiviteitRefs" } } }, "ActiviteitDelta": { "title": "ActiviteitDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/ActiviteitDeltaWijzigingen" }, "lijstWijzigingen": { "$ref": "#/components/schemas/ActiviteitDeltaLijstWijzigingen" } } }, "ThemaDelta": { "title": "ThemaDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerkingToevoegenVerwijderen" } } }, "IdealisatieDeltaWijzigingen": { "title": "IdealisatieDeltaWijzigingen", "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/idealisatie/id/concept/Indicatief" }, "waarde": { "type": "string", "nullable": true, "example": "indicatief" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nWaarde is `nullable`: indien aanwezig zonder waarde (`null`) betekent dat de veld aanwezig was, maar in renvooi is verwijderd.\n" }, "IdealisatieDelta": { "title": "IdealisatieDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/IdealisatieDeltaWijzigingen" } } }, "GebiedsaanwijzinggroepDeltaWijzigingen": { "title": "GebiedsaanwijzinggroepDeltaWijzigingen", "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/bodem/id/concept/Bodemdalingsgebied" }, "waarde": { "type": "string", "nullable": true, "example": "bodemdalingsgebied" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nWaarde is `nullable`: indien aanwezig zonder waarde (`null`) betekent dat de veld aanwezig was, maar in renvooi is verwijderd.\n" }, "GebiedsaanwijzinggroepDelta": { "title": "GebiedsaanwijzinggroepDelta", "required": [ "bewerking", "wijzigingen" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerkingWijzigen" }, "wijzigingen": { "$ref": "#/components/schemas/GebiedsaanwijzinggroepDeltaWijzigingen" } } }, "TypeGebiedsaanwijzingDeltaWijzigingen": { "title": "TypeGebiedsaanwijzingDeltaWijzigingen", "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/typegebiedsaanwijzing/id/concept/Bodem" }, "waarde": { "type": "string", "nullable": true, "example": "bodem" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nWaarde is `nullable`: indien aanwezig zonder waarde (`null`) betekent dat de veld aanwezig was, maar in renvooi is verwijderd.\n" }, "TypeGebiedsaanwijzingDelta": { "title": "TypeGebiedsaanwijzingDelta", "required": [ "bewerking", "wijzigingen" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerkingWijzigen" }, "wijzigingen": { "$ref": "#/components/schemas/TypeGebiedsaanwijzingDeltaWijzigingen" } } }, "SymboolcodesDeltaWijzigingen": { "title": "SymboolcodesDeltaWijzigingen", "type": "object", "properties": { "lijn": { "type": "string", "nullable": true, "example": "l001" }, "punt": { "type": "string", "nullable": true, "example": "p103" }, "vlak": { "type": "string", "nullable": true, "example": "v035" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nSommige velden zijn aangemerkt als `nullable`. Een nullable veld met waarde `null` betekent dat het veld in de vastgestelde regeling aanwezig is, maar afwezig in de ontwerpregeling.\n" }, "SymboolcodesDelta": { "title": "SymboolcodesDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/SymboolcodesDeltaWijzigingen" } } }, "KaartDeltaWijzigingen": { "title": "KaartDeltaWijzigingen", "type": "object", "properties": { "naam": { "type": "string", "example": "Kaartvoorbeeld Delfzijl" }, "nummer": { "type": "string", "nullable": true } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nSommige velden zijn aangemerkt als `nullable`. Een nullable veld met waarde `null` betekent dat het veld in de vastgestelde regeling aanwezig is, maar afwezig in de ontwerpregeling.\n" }, "KaartDelta": { "title": "KaartDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/KaartDeltaWijzigingen" } } }, "KaartlaagDeltaWijzigingen": { "title": "KaartlaagDeltaWijzigingen", "type": "object", "properties": { "naam": { "type": "string", "nullable": true, "example": "Industrieterrein" }, "niveau": { "type": "integer", "format": "int32", "nullable": true, "example": 1 } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nSommige velden zijn aangemerkt als `nullable`. Een nullable veld met waarde `null` betekent dat het veld in de vastgestelde regeling aanwezig is, maar afwezig in de ontwerpregeling.\n" }, "KaartlaagDivisieDeltaLijstWijzigingen": { "title": "KaartlaagDivisieDeltaLijstWijzigingen", "type": "object", "properties": { "gebiedsaanwijzingRefs": { "$ref": "#/components/schemas/LijstWijzigingenGebiedsaanwijzingRefs" } } }, "KaartlaagDivisieDelta": { "title": "KaartlaagDivisieDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/KaartlaagDeltaWijzigingen" }, "lijstWijzigingen": { "$ref": "#/components/schemas/KaartlaagDivisieDeltaLijstWijzigingen" } } }, "ActiviteitLocatieaanduidingDeltaWijzigingen": { "title": "ActiviteitLocatieaanduidingDeltaWijzigingen", "type": "object", "properties": { "activiteitRef": { "type": "string", "example": "nl.imow-gm1911.activiteit.20240101" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd.\n" }, "ActiviteitLocatieaanduidingDeltaLijstWijzigingen": { "title": "ActiviteitLocatieaanduidingDeltaLijstWijzigingen", "type": "object", "properties": { "locatieRefs": { "$ref": "#/components/schemas/LijstWijzigingenLocatieRefs" } } }, "ActiviteitLocatieaanduidingDelta": { "title": "ActiviteitLocatieaanduidingDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/ActiviteitLocatieaanduidingDeltaWijzigingen" }, "lijstWijzigingen": { "$ref": "#/components/schemas/ActiviteitLocatieaanduidingDeltaLijstWijzigingen" } } }, "AdressaatDelta": { "title": "AdressaatDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerkingToevoegenVerwijderen" } } }, "InstrumentDelta": { "title": "InstrumentDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerkingToevoegenVerwijderen" } } }, "NormwaardeDeltaWijzigingen": { "title": "NormwaardeDeltaWijzigingen", "type": "object", "properties": { "kwantitatieveWaarde": { "type": "number", "nullable": true, "example": 3 }, "kwalitatieveWaarde": { "type": "string", "nullable": true, "example": "laag" }, "waardeInRegeltekst": { "type": "string", "nullable": true, "example": "waarde staat in regeltekst" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nSommige velden zijn aangemerkt als `nullable`. Een nullable veld met waarde `null` betekent dat het veld in de vastgestelde regeling aanwezig is, maar afwezig in de ontwerpregeling.\n" }, "NormwaardeDeltaLijstWijzigingen": { "title": "NormwaardeDeltaLijstWijzigingen", "type": "object", "properties": { "locatieRefs": { "$ref": "#/components/schemas/LijstWijzigingenLocatieRefs" } } }, "NormwaardeDelta": { "title": "NormwaardeDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/NormwaardeDeltaWijzigingen" }, "lijstWijzigingen": { "$ref": "#/components/schemas/NormwaardeDeltaLijstWijzigingen" } } }, "TypeNormDeltaWijzigingen": { "title": "TypeNormDeltaWijzigingen", "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/typenorm/id/concept/Aantal" }, "waarde": { "type": "string", "nullable": true, "example": "aantal" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nWaarde is `nullable`: indien aanwezig zonder waarde (`null`) betekent dat de veld aanwezig was, maar in renvooi is verwijderd.\n" }, "TypeNormDelta": { "title": "TypeNormDelta", "required": [ "bewerking", "wijzigingen" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerkingWijzigen" }, "wijzigingen": { "$ref": "#/components/schemas/TypeNormDeltaWijzigingen" } } }, "EenheidDeltaWijzigingen": { "title": "EenheidDeltaWijzigingen", "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/eenheid/id/concept/Centimeter" }, "waarde": { "type": "string", "nullable": true, "example": "centimeter" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nWaarde is `nullable`: indien aanwezig zonder waarde (`null`) betekent dat de veld aanwezig was, maar in renvooi is verwijderd.\n" }, "EenheidDelta": { "title": "EenheidDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/EenheidDeltaWijzigingen" } } }, "NormgroepDeltaWijzigingen": { "title": "NormgroepDeltaWijzigingen", "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/omgevingswaarde/id/concept/Geluid" }, "waarde": { "type": "string", "nullable": true, "example": "geluid" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nWaarde is `nullable`: indien aanwezig zonder waarde (`null`) betekent dat de veld aanwezig was, maar in renvooi is verwijderd.\n" }, "NormgroepDelta": { "title": "NormgroepDelta", "required": [ "bewerking", "wijzigingen" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerkingWijzigen" }, "wijzigingen": { "$ref": "#/components/schemas/NormgroepDeltaWijzigingen" } } }, "ActiviteitengroepDeltaWijzigingen": { "title": "ActiviteitengroepDeltaWijzigingen", "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/activiteit/id/concept/MilieubelastendeActiviteit" }, "waarde": { "type": "string", "nullable": true, "example": "milieubelastende activiteit" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nWaarde is `nullable`: indien aanwezig zonder waarde (`null`) betekent dat de veld aanwezig was, maar in renvooi is verwijderd.\n" }, "ActiviteitengroepDelta": { "title": "ActiviteitengroepDelta", "required": [ "bewerking", "wijzigingen" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerkingWijzigen" }, "wijzigingen": { "$ref": "#/components/schemas/ActiviteitengroepDeltaWijzigingen" } } }, "KaartlaagRegeltekstDeltaLijstWijzigingen": { "title": "KaartlaagRegeltekstDeltaLijstWijzigingen", "type": "object", "properties": { "gebiedsaanwijzingRefs": { "$ref": "#/components/schemas/LijstWijzigingenGebiedsaanwijzingRefs" }, "omgevingsnormRefs": { "$ref": "#/components/schemas/LijstWijzigingenOmgevingsnormRefs" }, "omgevingswaardeRefs": { "$ref": "#/components/schemas/LijstWijzigingenOmgevingswaardeRefs" }, "activiteitLocatieaanduidingRefs": { "$ref": "#/components/schemas/LijstWijzigingenActiviteitLocatieaanduidingRefs" } } }, "KaartlaagRegeltekstDelta": { "title": "KaartlaagRegeltekstDelta", "required": [ "bewerking" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerking" }, "wijzigingen": { "$ref": "#/components/schemas/KaartlaagDeltaWijzigingen" }, "lijstWijzigingen": { "$ref": "#/components/schemas/KaartlaagRegeltekstDeltaLijstWijzigingen" } } }, "KaartextentDeltaWijzigingen": { "title": "KaartextentDeltaWijzigingen", "type": "object", "properties": { "minX": { "type": "number", "example": 256721 }, "minY": { "type": "number", "example": 590605 }, "maxX": { "type": "number", "example": 264383 }, "maxY": { "type": "number", "example": 595713 } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd.\n" }, "KaartextentDelta": { "title": "KaartextentDelta", "required": [ "bewerking", "wijzigingen" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerkingWijzigen" }, "wijzigingen": { "$ref": "#/components/schemas/KaartextentDeltaWijzigingen" } } }, "ActiviteitRegelkwalificatieDeltaWijzigingen": { "title": "ActiviteitRegelkwalificatieDeltaWijzigingen", "type": "object", "properties": { "code": { "type": "string", "example": "http://standaarden.omgevingswet.overheid.nl/activiteitregelkwalificatie/id/concept/Informatieplicht" }, "waarde": { "type": "string", "nullable": true, "example": "informatieplicht" } }, "description": "Bevat wijzigingen ten opzichte van de originele annotatie. Velden die niet aanwezig zijn, zijn ongewijzigd. \nWaarde is `nullable`: indien aanwezig zonder waarde (`null`) betekent dat de veld aanwezig was, maar in renvooi is verwijderd.\n" }, "ActiviteitRegelkwalificatieDelta": { "title": "ActiviteitRegelkwalificatieDelta", "required": [ "bewerking", "wijzigingen" ], "type": "object", "properties": { "bewerking": { "$ref": "#/components/schemas/DeltaBewerkingWijzigen" }, "wijzigingen": { "$ref": "#/components/schemas/ActiviteitRegelkwalificatieDeltaWijzigingen" } } } }, "responses": { "BadRequest": { "description": "Ongeldig verzoek", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" }, "examples": { "servererror": { "summary": "Bad Request", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/bad_request", "title": "Ongeldige combinatie of inhoud van parameters", "status": 400, "detail": "Het verzoek heeft een ongeldige request parameter", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "invalid-params": [ { "name": "size", "reason": "Ongeldige waarde: abc" } ] } } } } } }, "NotFound": { "description": "Geen resultaat gevonden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Not Found", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/not_found", "title": "Resource niet gevonden", "status": 404, "detail": "Er zijn geen gegevens gevonden op grond van de opgegeven input parameters", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "UnsupportedMediaType": { "description": "Media type wordt niet ondersteund", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Ongeldig media type", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/media_type", "title": "Ongeldig media type", "status": 415, "detail": "Content-Type: 'application/xml' wordt niet ondersteund. Geldige waarden zijn: [application/json]", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "UnprocessableContent": { "description": "De inhoud van het verzoek kan niet worden verwerkt.\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Niet ondersteunde CRS", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/unprocessable_entity", "title": "Niet-ondersteunde CRS", "status": 422, "detail": "Deze Content-CRS header wordt niet ondersteund: http://www.opengis.net/def/crs/EPSG/9.9.1/289", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } }, "ServerError": { "description": "Interne serverfout", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "servererror": { "summary": "Server error", "value": { "type": "https://service.omgevingswet.overheid.nl/publiek/catalogus/internal_server_error", "title": "Fout aan de serverkant", "status": 500, "detail": "Detailgegevens van de server", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b" } } } } } } }, "parameters": { "geldigOp": { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, "inWerkingOp": { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. \nDeze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\nEen gecombineerde tijdreisvraag langs `geldigOp` en `inWerkingOp` geeft de versie van het object\ndie op de opgegeven datum juridisch geldig is.\nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, "beschikbaarOp": { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. \nDeze tijdreis toont de versie van het object die beschikbaar is op de opgegeven UTC datumtijd. \nWanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige UTC datumtijd. \nDe tijdreisparameter wordt doorgegeven aan onderliggende hal-links en wordt naar boven afgerond op hele seconden.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, "synchroniseerMetTileset": { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd.\nHiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt.\nEr kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - `actueel`: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens;\n - `volledig`: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische en niet meer geldige gegevens.\n\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. \nWanneer beide parameters meegegeven worden, dan krijgt de expliciete `beschikbaarOp`-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Tileset" } }, "expand-regelingen": { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met regelingsgebieden en ponsen", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, "locatieSelectie": { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties met een verwijzing uitgeleverd, dus ook zgn. secundaire locaties waar alleen naar\nverwezen wordt door andere locaties omdat ze onderdeel zijn van een locatiegroep. Met deze parameter kunnen locaties\nuitgeleverd worden met een andere dan de standaardselectie:\n - `primair`: Secundaire locaties worden niet uitgeleverd. Locatiegroepen krijgen een geometrie-identificatie,\n welke verwijst naar een geometrie die een samenstelling is van alle onderliggende geometrieën.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/LocatieSelectie" } }, "page": { "name": "page", "in": "query", "description": "De page moet minimaal een waarde van 1 hebben.", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "format": "int32", "example": 1, "default": 1 } }, "size": { "name": "size", "in": "query", "description": "De pagesize moet minimaal een waarde van 1 hebben en maximaal een waarde van 200.", "required": false, "style": "form", "explode": true, "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "example": 20, "default": 20 } }, "uriIdentificatie": { "name": "uriIdentificatie", "in": "path", "description": "Een identificatie van een omgevingsdocument, zoals gedefinieerd in de STOP-standaard, waarbij de schuine strepen en koppeltekens zijn vervangen door lage streepjes (onderstrepingstekens).", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_omgevingsplan" } }, "contentCrs": { "name": "Content-Crs", "in": "header", "description": "De CRS van de meegeleverde geometrie-content. Wanneer de Content-Crs header ontbreekt, dan wordt de 'default' Crs aangenomen. Dat is WSG84 (CRS84) en dat ondersteunen wij niet.", "required": false, "style": "simple", "explode": false, "schema": { "$ref": "#/components/schemas/Crs" } }, "transformXml": { "name": "_transformXml", "in": "query", "description": "Transformeer de XML van bepaalde attributen\n\nIn het geval van `_transformXml=inhoud` worden `ref` attributen van `IORef` en `ExtIORef` elementen naar volledige URLs getransformeerd. De transformatie wordt toegepast op 'AKN', 'document', 'JCI' en 'JOIN'. Het soort is na transformatie altijd een URL.\n\nDe standaardwaarde null: er worden geen transformaties uitgevoerd.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/TransformXml" } }, "conditieArtikel": { "name": "_conditieArtikel", "in": "query", "description": "Bepaal hoe het conditie-artikel wordt uitgeleverd. \n\nDe huidige standaardaanpak levert de informatie uit onder het veld 'conditieArtikel' als onderdeel van een documentcomponent. \nDeze aanpak is deprecated: de aanbevolen uitlevermethode is als eigen documentcomponent. \n\nGebruik deze query parameter om gebruik te maken van de nieuwe aanpak, deze zal op den duur de standaardmanier van uitleveren worden.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/ConditieArtikelUitlevering" } }, "documentComponentPath": { "name": "documentComponentWorkId", "in": "path", "description": "Een identificatie vanuit het OP-deel in de vorm van een wId, welke documentcomponenten uniek identificeert over alle omgevingsdocumenten heen.\n\nZie ook: https://koop.gitlab.io/stop/standaard/1.4.0-ic/data_xsd_Element_data_wId.html\n", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "gm9999_v1__cmp_I__content_o_1__list_o_1__item_o_5" } }, "documentComponentQuery": { "name": "documentComponent", "in": "query", "description": "Een identificatie vanuit het OP-deel in de vorm van een wId, welke documentcomponenten uniek identificeert over alle omgevingsdocumenten heen.\n\nZie ook: https://koop.gitlab.io/stop/standaard/1.4.0-ic/data_xsd_Element_data_wId.html\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "gm0160_v1__chp_6__subchp_2.2__subsec_2.2.1__art_2.1" } }, "expand": { "name": "_expand", "in": "query", "description": "Meeladen van resources", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, "expandScope-vastgesteldeAnnotaties": { "name": "_expandScope", "in": "query", "description": "Welke resources worden meegeladen:\n* `registratiegegevens`: registratiegegevens van annotaties worden in `geregistreerdMet` attributen uitgeleverd.\n\nDeze queryparameter wordt alleen toegepast wanneer _expand queryparameter de waarde 'true' heeft.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/ExpandScopeVastgesteldeAnnotaties" } }, "extraInfo": { "name": "_extraInfo", "in": "query", "description": "Welke extra informatie kan worden opgevraagd:\n* `boundingBox`: De bounding box van locaties wordt uitgeleverd onder de `boundingBox` property.\n\nDeze informatie wordt uitgeleverd onder een `extraInfo` property bij het desbetreffende object.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExtraInfo" } } }, "bevoegdGezagCodeParameter": { "name": "bevoegdGezag", "in": "path", "description": "Code van het bevoegd gezag, uit één van onderstaande waardelijsten:\n - https://identifier.overheid.nl/tooi/set/rwc_gemeenten_compleet\n - https://identifier.overheid.nl/tooi/set/rwc_ministeries_compleet\n - https://identifier.overheid.nl/tooi/set/rwc_provincies_compleet\n - https://identifier.overheid.nl/tooi/set/rwc_waterschappen_compleet\n", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "gm0000" } }, "versieIdentificatie": { "name": "versieIdentificatie", "in": "path", "description": "Een identificatie die verwijst naar de versie een omgevingsdocument.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "/akn/nl/act/gm1773/2020/omgevingsplan/nld@2025-06-11" } }, "bestandsnaam": { "name": "bestandsnaam", "in": "path", "description": "De naam van het op te vragen bestand.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "Afbeelding.png" } }, "expand-besluitversies": { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met geconsolideerde regelingsgebieden", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, "technischId": { "name": "technischId", "in": "path", "description": "Een technische identificatie voor (ontwerp)objecten, samengesteld uit de IMOW-identificatie en de (ontwerp)besluitIdentificatie.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "_akn_nl_act_gm0160_2023_Omgevingsplan_HelloDSO_akn_nl_bill_gm0160_2024_3521" } }, "expand-ontwerpregelingen": { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met regelingsgebieden en ontwerpregelingsgebieden", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, "ontwerpbesluitIdentificatie": { "name": "ontwerpbesluitIdentificatie", "in": "path", "description": "Een identificatie die verwijst naar een versie een omgevingsdocument die in ontwerp is.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "/akn/nl/act/gm1759/2025/omgevingsplan/nld@2025-04-21" } }, "expand-omgevingsvergunningen": { "name": "_expand", "in": "query", "description": "Meeladen van embedded resources met omgevingsvergunninggebieden", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, "inzagetermijn": { "name": "inzagetermijn", "in": "query", "description": "Filter ontwerpregelingen op basis van het inzagetermijn en de opgegeven beschikbaarOp tijdreisparameter:\n - huidigEnToekomstig: retourneert ontwerpregelingen waarbij het inzagetermijn nog niet verstreken is.\n \n Wanneer deze parameter niet meegegeven wordt zal er geen filtering op basis van het inzagetermijn plaatsvinden.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/Inzagetermijn" } }, "besluitType": { "name": "besluitType", "in": "query", "description": "Met behulp van deze parameter kan gefilterd worden op het type besluit, als volgt:\n - `initieel`: Alleen ontwerpen die zijn aangeleverd met een initieel besluit.\n - `wijziging`: Alleen ontwerpen die zijn aangeleverd met een wijzigingsbesluit.\n", "required": false, "style": "form", "explode": true, "schema": { "$ref": "#/components/schemas/BesluitType" } } }, "headers": { "api-version": { "description": "De versie van de API", "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.0" } } }, "securitySchemes": { "apiKey": { "type": "apiKey", "description": "De API-key die je hebt gekregen dient bij elke request naar de\nAPI via de `x-api-key` request header meegestuurd te worden. Indien deze\nniet juist wordt meegestuurd, of het een ongeldige key betreft, zul je de\nfoutmelding `403 Forbidden` terugkrijgen.\n", "name": "x-api-key", "in": "header" } } } }