{
"openapi": "3.0.0",
"info": {
"title": "Omgevingsdocumenten-Presenteren",
"description": "De Omgevingsdocumenten Presenteren API ontsluit beschikbaar gestelde omgevingsdocumenten op zo'n manier dat deze eenvoudig visueel te verbeelden zijn. Op de Ontwikkel, Test, Acceptatie en Pre-productieomgeving worden ook omgevingsdocumenten toegevoegd en verwijderd door beheerders voor testdoeleinden binnen en buiten de voorziening.
\n
\nDe Omgevingsdocumenten Presenteren API volgt de standaarden zoals beschreven in de DSO API-strategie versie 1.1. Zo is het standaard mediatype HAL (`application/hal+json`). Dit is een mediatype voor het weergeven van resources en hun relaties via hyperlinks.",
"version": "7.11.8"
},
"servers": [
{
"url": "/publiek/omgevingsdocumenten/api/presenteren/v7",
"description": "basePath"
}
],
"tags": [
{
"name": "Afbeeldingen",
"description": "Afbeeldingen uit omgevingsdocumenten."
},
{
"name": "Activiteiten",
"description": "Activiteiten bevat activiteit uitspraken die in omgevingsdocumenten staan."
},
{
"name": "Regelingen",
"description": "Regelingen en hun structuur."
},
{
"name": "Omgevingsvergunningen",
"description": "Omgevingsvergunningen en hun structuur."
},
{
"name": "Regelteksten",
"description": "Regelteksten bevatten JuridischeRegels die beschreven zijn in omgevingsdocumenten."
},
{
"name": "Kaarten",
"description": "Kaarten bevatten aparte visualisaties van informatie over CIMOW-objecten."
},
{
"name": "Gebiedsaanwijzingen",
"description": "Gebiedsaanwijzingen zijn gebieden waar een regel betrekking op heeft."
},
{
"name": "Omgevingsnormen",
"description": "Omgevingsnormen zoals beschreven in de omgevingswet."
},
{
"name": "Omgevingswaarden",
"description": "Omgevingswaarden zoals beschreven in de omgevingswet."
},
{
"name": "Meta",
"description": "Operaties die niet domeinspecifiek zijn, maar over de applicatie gaan."
}
],
"paths": {
"/activiteiten": {
"get": {
"tags": [
"Activiteiten"
],
"summary": "Alle activiteiten opvragen",
"operationId": "getActiviteiten",
"parameters": [
{
"name": "gerelateerdeActiviteitIdentificatie",
"in": "query",
"description": "Activiteiten ophalen die gerelateerd zijn aan deze activiteit",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.activiteit.2019000242example"
},
{
"name": "regeltekstIdentificatie",
"in": "query",
"description": "Alleen activiteiten opvragen die opgenomen zijn in de gegeven regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.regeltekst.2019000242example"
},
{
"name": "ontwerpRegeltekstTechnischId",
"in": "query",
"description": "Alleen activiteiten opvragen die opgenomen zijn in de gegeven regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.regeltekst.2019000046example_akn_nl_bill_pv26_2020_example"
},
{
"name": "ontwerpgerelateerdeActiviteitTechnischId",
"in": "query",
"description": "Activiteiten ophalen die gerelateerd zijn aan deze ontwerp activiteit",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.activiteit.2019000242example"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-Total-Count": {
"$ref": "#/components/headers/X-Total-Count"
},
"X-Pagination-Count": {
"$ref": "#/components/headers/X-Pagination-Count"
},
"X-Pagination-Page": {
"$ref": "#/components/headers/X-Pagination-Page"
},
"X-Pagination-Limit": {
"$ref": "#/components/headers/X-Pagination-Limit"
}
},
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Activiteiten"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/activiteiten/{identificatie}": {
"get": {
"tags": [
"Activiteiten"
],
"summary": "Een enkele activiteit opvragen",
"operationId": "getActiviteit",
"parameters": [
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.activiteit.2019000241example"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Activiteit"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/activiteiten/_zoek": {
"post": {
"tags": [
"Activiteiten"
],
"summary": "Activiteiten opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekActiviteiten",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_expandScope"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActiviteitZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Activiteiten"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/activiteitlocatieaanduidingen/_zoek": {
"post": {
"tags": [
"Activiteiten"
],
"summary": "ActiviteitLocatieaanduidingen opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekActiviteitLocatieaanduidingen",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_expandScope"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActiviteitLocatieaanduidingZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"X-Total-Count": {
"$ref": "#/components/headers/X-Total-Count"
},
"X-Pagination-Count": {
"$ref": "#/components/headers/X-Pagination-Count"
},
"X-Pagination-Page": {
"$ref": "#/components/headers/X-Pagination-Page"
},
"X-Pagination-Limit": {
"$ref": "#/components/headers/X-Pagination-Limit"
}
},
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/ActiviteitLocatieaanduidingen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/activiteiten/{identificatie}/activiteitlocatieaanduidingen": {
"get": {
"tags": [
"Activiteiten"
],
"summary": "Activiteitlocatieaanduidingen opvragen bij een activiteit",
"operationId": "getActiviteitLocatieaanduidingen",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.activiteit.2019000241example"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/ActiviteitLocatieaanduidingen"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/activiteiten/{identificatie}/activiteitlocatieaanduidingen/{activiteitlocatieaanduidingidentificatie}": {
"get": {
"tags": [
"Activiteiten"
],
"summary": "Een enkele activiteitlocatieaanduiding opvragen",
"operationId": "getActiviteitLocatieaanduiding",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.activiteit.2019000241example"
},
{
"name": "activiteitlocatieaanduidingidentificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.activiteitlocatieaanduiding.2019000241example"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/ActiviteitLocatieaanduiding"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ponsen/{identificatie}": {
"get": {
"tags": [
"Ponsen"
],
"summary": "Een enkele pons opvragen",
"operationId": "getPons",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.pons.2019000241example"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Pons"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ponsen/_zoek": {
"post": {
"tags": [
"Ponsen"
],
"summary": "Ponsen opvragen die voldoen aan het geozoekgebied",
"operationId": "zoekPonsen",
"parameters": [
{
"name": "Content-Crs",
"in": "header",
"description": "Content-Crs",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "EPSG:28992"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"requestBody": {
"description": "PonsZoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PonsZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Ponsen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ponsen/_afgedekt-door": {
"post": {
"tags": [
"Ponsen"
],
"summary": "geeft een boolean terug afhanklijk of de pons de zoek gebied afdekt",
"operationId": "isPonsAfgedekt",
"parameters": [
{
"name": "Content-Crs",
"in": "header",
"description": "Content-Crs",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "EPSG:28992"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeoJsonGeometry"
}
}
}
},
"responses": {
"200": {
"description": "boolean",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OmgevingsplanPons"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"422": {
"$ref": "#/components/responses/UnprocessableContent"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelteksten": {
"get": {
"tags": [
"Regelteksten"
],
"summary": "Alle regelteksten opvragen, de regelteksten kunnen ook gesorteerd op workId opgeleverd worden (met sort=workId)",
"operationId": "getRegelteksten",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "omgevingsnormIdentificatie",
"in": "query",
"description": "Regelteksten ophalen die deze omgevingsnorm beschrijven",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.omgevingsnorm.2019000242example"
},
{
"name": "omgevingswaardeIdentificatie",
"in": "query",
"description": "Regelteksten ophalen die deze omgevingswaarde beschrijven",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.omgevingswaarde.2019000242example"
},
{
"name": "gebiedsaanwijzingIdentificatie",
"in": "query",
"description": "Regelteksten ophalen waar deze gebiedsaanwijzing in opgenomen is",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.bodem.2019000242example"
},
{
"name": "activiteitIdentificatie",
"in": "query",
"description": "Regelteksten ophalen die deze activiteit beschrijven",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.activiteit.2019000242example"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-Total-Count": {
"$ref": "#/components/headers/X-Total-Count"
},
"X-Pagination-Count": {
"$ref": "#/components/headers/X-Pagination-Count"
},
"X-Pagination-Page": {
"$ref": "#/components/headers/X-Pagination-Page"
},
"X-Pagination-Limit": {
"$ref": "#/components/headers/X-Pagination-Limit"
}
},
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Regelteksten"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelteksten/{identificatie}": {
"get": {
"tags": [
"Regelteksten"
],
"summary": "Een enkele regeltekst opvragen",
"operationId": "getRegeltekst",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_expandScopeOntwerpJuridischeRegelsLocaties"
},
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.regeltekst.2019000001example"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Regeltekst"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelteksten/_zoek": {
"post": {
"tags": [
"Regelteksten"
],
"summary": "Regelteksten opvragen die voldoen aan zoekobject-parameters, de regelteksten kunnen ook gesorteerd op workId opgeleverd worden (met sort=workId)",
"operationId": "zoekRegelteksten",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_expandScopeOntwerpJuridischeRegelsLocaties"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegeltekstZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"X-Total-Count": {
"$ref": "#/components/headers/X-Total-Count"
},
"X-Pagination-Count": {
"$ref": "#/components/headers/X-Pagination-Count"
},
"X-Pagination-Page": {
"$ref": "#/components/headers/X-Pagination-Page"
},
"X-Pagination-Limit": {
"$ref": "#/components/headers/X-Pagination-Limit"
}
},
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Regelteksten"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/kaarten": {
"get": {
"tags": [
"Kaarten"
],
"summary": "Alle kaarten opvragen",
"operationId": "getKaarten",
"parameters": [
{
"name": "regeltekstIdentificatie",
"in": "query",
"description": "Alleen kaarten opvragen die opgenomen zijn in de gegeven regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.regeltekst.2019000242example"
},
{
"name": "divisieannotatieIdentificatie",
"in": "query",
"description": "Alleen kaarten opvragen die opgenomen zijn in de gegeven divisie",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.divisie.2019000046example"
},
{
"name": "ontwerpDivisieannotatieTechnischId",
"in": "query",
"description": "Alleen kaarten opvragen die opgenomen zijn in de gegeven ontwerp divisie annotatie",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_pv26_divisie_2019000046example_akn_nl_bill_pv26_2020_example"
},
{
"name": "ontwerpRegeltekstTechnischId",
"in": "query",
"description": "Alleen kaarten opvragen die opgenomen zijn in de gegeven ontwerp regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.regeltekst.2019000046example_akn_nl_bill_pv26_2020_example"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-Total-Count": {
"$ref": "#/components/headers/X-Total-Count"
},
"X-Pagination-Count": {
"$ref": "#/components/headers/X-Pagination-Count"
},
"X-Pagination-Page": {
"$ref": "#/components/headers/X-Pagination-Page"
},
"X-Pagination-Limit": {
"$ref": "#/components/headers/X-Pagination-Limit"
}
},
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Kaarten"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/kaarten/{identificatie}": {
"get": {
"tags": [
"Kaarten"
],
"summary": "Een enkele kaart opvragen",
"operationId": "getKaart",
"parameters": [
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.kaart.2019000001example"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Kaart"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/kaarten/_zoek": {
"post": {
"tags": [
"Kaarten"
],
"summary": "Kaarten opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekKaarten",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KaartZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"X-Total-Count": {
"$ref": "#/components/headers/X-Total-Count"
},
"X-Pagination-Count": {
"$ref": "#/components/headers/X-Pagination-Count"
},
"X-Pagination-Page": {
"$ref": "#/components/headers/X-Pagination-Page"
},
"X-Pagination-Limit": {
"$ref": "#/components/headers/X-Pagination-Limit"
}
},
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Kaarten"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpkaarten": {
"get": {
"tags": [
"OntwerpKaarten"
],
"summary": "Alle ontwerpkaarten opvragen",
"operationId": "getOntwerpKaarten",
"parameters": [
{
"name": "ontwerpRegeltekstTechnischId",
"in": "query",
"description": "Alleen kaarten opvragen die opgenomen zijn in de gegeven regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.regeltekst.2019000046example_akn_nl_bill_pv26_2020_example"
},
{
"name": "ontwerpDivisieannotatieTechnischId",
"in": "query",
"description": "Alleen kaarten opvragen die opgenomen zijn in de gegeven divisie",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_pv26_divisie_2019000046example_akn_nl_bill_pv26_2020_example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpKaarten"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpkaarten/{technischId}": {
"get": {
"tags": [
"OntwerpKaarten"
],
"summary": "Een enkele ontwerpkaart opvragen aan de hand van identificatie en ontwerpbesluitIdentificatie",
"operationId": "getOntwerpKaart",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.kaart.2019000046example_akn_nl_bill_pv26_2020_example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpKaart"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpkaarten/_zoek": {
"post": {
"tags": [
"OntwerpKaarten"
],
"summary": "OntwerpKaarten opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekOntwerpKaarten",
"parameters": [
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OntwerpKaartZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpKaarten"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/divisieannotaties": {
"get": {
"tags": [
"Divisieannotaties"
],
"summary": "Alle divisieannotatiess opvragen, deze kunnen ook gesorteerd op workId opgeleverd worden (met sort=workId)",
"operationId": "getDivisieannotaties",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "gebiedsaanwijzingIdentificatie",
"in": "query",
"description": "Divisieannotaties waar deze gebiedsaanwijzing in opgenomen is",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.gebiedsaanwijzing.2019000025example"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Divisieannotaties"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/divisieannotaties/{identificatie}": {
"get": {
"tags": [
"Divisieannotaties"
],
"summary": "Een enkele divisieannotatie opvragen",
"operationId": "getDivisieannotatie",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.divisie.2019000001example"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Divisieannotatie"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/divisieannotaties/_zoek": {
"post": {
"tags": [
"Divisieannotaties"
],
"summary": "Divisieannotaties opvragen die voldoen aan zoekobject-parameters,de divisieannotaties kunnen ook gesorteerd op workId opgeleverd worden (met sort=workId)",
"operationId": "zoekDivisieannotaties",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_expandScope"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DivisieannotatieZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"X-Total-Count": {
"$ref": "#/components/headers/X-Total-Count"
},
"X-Pagination-Count": {
"$ref": "#/components/headers/X-Pagination-Count"
},
"X-Pagination-Page": {
"$ref": "#/components/headers/X-Pagination-Page"
},
"X-Pagination-Limit": {
"$ref": "#/components/headers/X-Pagination-Limit"
}
},
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Divisieannotaties"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/hoofdlijnen": {
"get": {
"tags": [
"Hoofdlijnen"
],
"summary": "Alle hoofdlijnen opvragen",
"operationId": "getHoofdlijnen",
"parameters": [
{
"name": "gerelateerdeHoofdlijnIdentificatie",
"in": "query",
"description": "Vastgestelde Hoofdlijnen die aan deze Hoofdlijn zijn gerelateerd",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.hoofdlijn.2019000242example"
},
{
"name": "gerelateerdeOntwerpHoofdlijnTechnischId",
"in": "query",
"description": "Vastgestelde Hoofdlijnen die aan deze Ontwerp Hoofdlijn zijn gerelateerd",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_gm0037_hoofdlijn_2019000242example_akn_nl_bill_pv26_2020_example"
},
{
"name": "divisieannotatieIdentificatie",
"in": "query",
"description": "Alleen hoofdlijnen opvragen die opgenomen zijn in de gegeven divisie",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.divisie.2019000046example"
},
{
"name": "ontwerpDivisieannotatieTechnischId",
"in": "query",
"description": "Alleen hoofdlijnen opvragen die opgenomen zijn in de gegeven ontwerp divisie",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_pv26_divisie_2019000046example_akn_nl_bill_pv26_2020_example"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-Total-Count": {
"$ref": "#/components/headers/X-Total-Count"
},
"X-Pagination-Count": {
"$ref": "#/components/headers/X-Pagination-Count"
},
"X-Pagination-Page": {
"$ref": "#/components/headers/X-Pagination-Page"
},
"X-Pagination-Limit": {
"$ref": "#/components/headers/X-Pagination-Limit"
}
},
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Hoofdlijnen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/hoofdlijnen/{identificatie}": {
"get": {
"tags": [
"Hoofdlijnen"
],
"summary": "Een enkele hoofdlijn opvragen",
"operationId": "getHoofdlijn",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.omgevingsnorm.201900002example"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Hoofdlijn"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/hoofdlijnen/{identificatie}/gerelateerd": {
"get": {
"tags": [
"Hoofdlijnen"
],
"summary": "Alle hoofdlijnen opvragen die gerelateerd zijn aan een hoofdlijn",
"operationId": "getHoofdlijnGerelateerd",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.omgevingsnorm.201900002example"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Hoofdlijnen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/hoofdlijnen/_zoek": {
"post": {
"tags": [
"Hoofdlijnen"
],
"summary": "Alle hoofdlijnen opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekHoofdlijnen",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HoofdlijnZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Hoofdlijnen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/omgevingsnormen": {
"get": {
"tags": [
"Omgevingsnormen"
],
"summary": "Alle omgevingsnormen opvragen",
"operationId": "getOmgevingsnormen",
"parameters": [
{
"name": "regeltekstIdentificatie",
"in": "query",
"description": "Omgevingsnormen ophalen die beschreven worden in deze Regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.regeltekst.2019000242example"
},
{
"name": "ontwerpRegeltekstTechnischId",
"in": "query",
"description": "Omgevingsnormen opvragen die opgenomen zijn in de gegeven ontwerp regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.regeltekst.2019000046example_akn_nl_bill_pv26_2020_example"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-Total-Count": {
"$ref": "#/components/headers/X-Total-Count"
},
"X-Pagination-Count": {
"$ref": "#/components/headers/X-Pagination-Count"
},
"X-Pagination-Page": {
"$ref": "#/components/headers/X-Pagination-Page"
},
"X-Pagination-Limit": {
"$ref": "#/components/headers/X-Pagination-Limit"
}
},
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Omgevingsnormen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/omgevingsnormen/{identificatie}": {
"get": {
"tags": [
"Omgevingsnormen"
],
"summary": "Een enkele omgevingsnorm opvragen",
"operationId": "getOmgevingsnorm",
"parameters": [
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.omgevingsnorm.201900002example"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Omgevingsnorm"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/omgevingsnormen/{identificatie}/normwaarden/{normwaardeIdentificatie}": {
"get": {
"tags": [
"Omgevingsnormen"
],
"summary": "Een enkele normwaarde opvragen behorend bij een omgevingsnorm opvragen",
"operationId": "getOmgevingsnormNormwaarde",
"parameters": [
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.omgevingsnorm.2019000241example"
},
{
"name": "normwaardeIdentificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.normwaarde.2019000241example"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Normwaarde"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/omgevingsnormen/_zoek": {
"post": {
"tags": [
"Omgevingsnormen"
],
"summary": "Omgevingsnormen opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekOmgevingsnormen",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_expandScope"
}
],
"requestBody": {
"description": "OmgevingsnormZoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OmgevingsnormZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"X-Total-Count": {
"$ref": "#/components/headers/X-Total-Count"
},
"X-Pagination-Count": {
"$ref": "#/components/headers/X-Pagination-Count"
},
"X-Pagination-Page": {
"$ref": "#/components/headers/X-Pagination-Page"
},
"X-Pagination-Limit": {
"$ref": "#/components/headers/X-Pagination-Limit"
}
},
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Omgevingsnormen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/omgevingswaarden": {
"get": {
"tags": [
"Omgevingswaarden"
],
"summary": "Alle omgevingswaarden opvragen",
"operationId": "getOmgevingswaarden",
"parameters": [
{
"name": "regeltekstIdentificatie",
"in": "query",
"description": "Omgevingswaarden ophalen die beschreven worden in deze Regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.regeltekst.2019000242example"
},
{
"name": "ontwerpRegeltekstTechnischId",
"in": "query",
"description": "Omgevingswaarden opvragen die opgenomen zijn in de gegeven ontwerp regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.regeltekst.2019000046example_akn_nl_bill_pv26_2020_example"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-Total-Count": {
"$ref": "#/components/headers/X-Total-Count"
},
"X-Pagination-Count": {
"$ref": "#/components/headers/X-Pagination-Count"
},
"X-Pagination-Page": {
"$ref": "#/components/headers/X-Pagination-Page"
},
"X-Pagination-Limit": {
"$ref": "#/components/headers/X-Pagination-Limit"
}
},
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Omgevingswaarden"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/omgevingswaarden/{identificatie}": {
"get": {
"tags": [
"Omgevingswaarden"
],
"summary": "Een enkele omgevingswaarde opvragen",
"operationId": "getOmgevingswaarde",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.omgevingswaarde.201900001example"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Omgevingswaarde"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/omgevingswaarden/{identificatie}/normwaarden/{normwaardeIdentificatie}": {
"get": {
"tags": [
"Omgevingswaarden"
],
"summary": "Een enkele normwaarde opvragen behorend bij een omgevingswaarde opvragen",
"operationId": "getOmgevingswaardeNormwaarde",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.omgevingswaarde.2019000241example"
},
{
"name": "normwaardeIdentificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.normwaarde.2019000241example"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Normwaarde"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/omgevingswaarden/_zoek": {
"post": {
"tags": [
"Omgevingswaarden"
],
"summary": "Omgevingswaarden opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekOmgevingswaarden",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_expandScope"
}
],
"requestBody": {
"description": "OmgevingswaardeZoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OmgevingswaardeZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {
"X-Total-Count": {
"$ref": "#/components/headers/X-Total-Count"
},
"X-Pagination-Count": {
"$ref": "#/components/headers/X-Pagination-Count"
},
"X-Pagination-Page": {
"$ref": "#/components/headers/X-Pagination-Page"
},
"X-Pagination-Limit": {
"$ref": "#/components/headers/X-Pagination-Limit"
}
},
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Omgevingswaarden"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/gebiedsaanwijzingen": {
"get": {
"tags": [
"Gebiedsaanwijzingen"
],
"summary": "Alle gebiedsaanwijzingen opvragen",
"operationId": "getGebiedsaanwijzingen",
"parameters": [
{
"name": "regeltekstIdentificatie",
"in": "query",
"description": "Alleen gebiedsaanwijzingen opvragen die opgenomen zijn in de gegeven regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.regeltekst.2019000242example"
},
{
"name": "divisieannotatieIdentificatie",
"in": "query",
"description": "Alleen gebiedsaanwijzingen opvragen die opgenomen zijn in de gegeven divisie",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.divisie.2019000046example"
},
{
"name": "ontwerpDivisieannotatieTechnischId",
"in": "query",
"description": "Alleen kaarten opvragen die opgenomen zijn in de gegeven ontwerp divisie",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_pv26_divisie_2019000046example_akn_nl_bill_pv26_2020_example"
},
{
"name": "ontwerpRegeltekstTechnischId",
"in": "query",
"description": "Alleen gebiedsaanwijzingen opvragen die opgenomen zijn in de gegeven ontwerp regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.regeltekst.2019000046example_akn_nl_bill_pv26_2020_example"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Gebiedsaanwijzingen"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/gebiedsaanwijzingen/{identificatie}": {
"get": {
"tags": [
"Gebiedsaanwijzingen"
],
"summary": "Een enkele gebiedsaanwijzing opvragen",
"operationId": "getGebiedsaanwijzing",
"parameters": [
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.gebiedsaanwijzing.2019000025example"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Gebiedsaanwijzing"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/gebiedsaanwijzingen/_zoek": {
"post": {
"tags": [
"Gebiedsaanwijzingen"
],
"summary": "Gebiedsaanwijzingen opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekGebiedsaanwijzingen",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_expandScope"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GebiedsaanwijzingZoekobject"
},
"examples": {
"zoekobjectWaterschapsverordening": {
"$ref": "#/components/examples/zoekobjectWaterschapsverordening"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Gebiedsaanwijzingen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpgebiedsaanwijzingen": {
"get": {
"tags": [
"OntwerpGebiedsaanwijzingen"
],
"summary": "Alle ontwerpgebiedsaanwijzingen opvragen",
"operationId": "getOntwerpGebiedsaanwijzingen",
"parameters": [
{
"name": "ontwerpRegeltekstTechnischId",
"in": "query",
"description": "Alleen ontwerpgebiedsaanwijzingen opvragen die opgenomen zijn in de gegeven ontwerpregeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_gm0037_ontwerpregeltekst_2019000242example_akn_nl_bill_pv26_2020_example"
},
{
"name": "ontwerpDivisieannotatieTechnischId",
"in": "query",
"description": "Alleen ontwerpgebiedsaanwijzingen opvragen die opgenomen zijn in de gegeven ontwerpdivisie",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_pv26_ontwerpdivisie_2019000046example_akn_nl_bill_pv26_2020_example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpGebiedsaanwijzingen"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpgebiedsaanwijzingen/{technischId}": {
"get": {
"tags": [
"OntwerpGebiedsaanwijzingen"
],
"summary": "Een enkele gebiedsaanwijzing opvragen",
"operationId": "getOntwerpGebiedsaanwijzing",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerp objecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.gebiedsaanwijzing.example_akn_nl_bill_pv26_2020_example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpGebiedsaanwijzing"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpgebiedsaanwijzingen/_zoek": {
"post": {
"tags": [
"OntwerpGebiedsaanwijzingen"
],
"summary": "OntwerpGebiedsaanwijzingen opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekOntwerpGebiedsaanwijzingen",
"parameters": [
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_ontwerpExpandScope"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OntwerpGebiedsaanwijzingZoekobject"
},
"examples": {
"zoekobjectWaterschapsverordening": {
"$ref": "#/components/examples/zoekobjectWaterschapsverordening"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpGebiedsaanwijzingen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelingen": {
"get": {
"tags": [
"Regelingen"
],
"summary": "Alle regelingen opvragen",
"operationId": "getRegelingen",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Regelingen"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelingen/{identificatie}": {
"get": {
"tags": [
"Regelingen"
],
"summary": "Een enkel regeling opvragen.",
"operationId": "getRegeling",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "path",
"description": "De pad parameter 'identificatie' is een ge-escapete versie van het document-id. De escaping gebeurt met de volgende regex: [^\\w]+ wordt vervangen door _",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_example"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Regeling"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelingen/findById": {
"get": {
"tags": [
"Regelingen"
],
"summary": "Een enkel regeling opvragen.",
"operationId": "getRegelingFindById",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "query",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "/akn/nl/act/gm0037/2019/3520-example"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Regeling"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelingen/{identificatie}/voorkomens": {
"get": {
"tags": [
"Regelingen"
],
"summary": "Alle voorkomens door de tijd van deze regeling opvragen.",
"operationId": "getRegelingVoorkomens",
"parameters": [
{
"$ref": "#/components/parameters/voorkomensGeldigOp"
},
{
"$ref": "#/components/parameters/voorkomensInWerkingOp"
},
{
"$ref": "#/components/parameters/voorkomensBeschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "path",
"description": "De pad parameter ''identificatie'' is een ge-escapete versie van het document-id. De escaping gebeurt met de volgende regex: [^\\w]+ wordt vervangen door _",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_example"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Voorkomens"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelingen/{identificatie}/tekststructuur": {
"get": {
"tags": [
"Regelingen"
],
"summary": "Alle documentcomponenten van een regeling in een boomstructuur opvragen",
"operationId": "getRegelingTekststructuur",
"parameters": [
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_example"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/TekststructuurDocumentComponenten"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelingen/{identificatie}/documentcomponenten": {
"get": {
"tags": [
"Regelingen"
],
"summary": "Alle root documentcomponenten van een regeling opvragen",
"operationId": "getRegelingComponenten",
"parameters": [
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_example"
},
{
"name": "Content-Type-Embedded",
"in": "header",
"description": "Content-Type-Embedded",
"required": false,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"enum": [
"application/xml",
"text/html"
]
},
"example": "application/xml"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/DocumentComponenten"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"deprecated": true
}
},
"/regelingen/{identificatie}/documentcomponenten/{componentWorkId}": {
"get": {
"tags": [
"Regelingen"
],
"summary": "Een documentcomponent opvragen",
"operationId": "getRegelingDocumentComponent",
"parameters": [
{
"name": "identificatie",
"in": "path",
"description": "De pad parameter 'identificatie' is een ge-escapete versie van het document-id. De escaping gebeurt met de volgende regex: [^\\w]+ wordt vervangen door _",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_example"
},
{
"name": "componentWorkId",
"in": "path",
"description": "De workId van het DocumentComponent",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "gm1979_2__chp_1"
},
{
"name": "Content-Type-Embedded",
"in": "header",
"description": "Content-Type-Embedded",
"required": false,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"enum": [
"application/xml",
"text/html"
]
},
"example": "application/xml"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/DocumentComponent"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelingen/{identificatie}/themas": {
"get": {
"tags": [
"Regelingen"
],
"summary": "Themas opvragen",
"operationId": "getThemas",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_example"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Themas"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelingen/voorkomens/_zoek": {
"post": {
"tags": [
"Regelingen"
],
"summary": "Regelingen opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekRegelVoorkomens",
"parameters": [
{
"$ref": "#/components/parameters/vanaf"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/VoorkomensSort"
}
],
"requestBody": {
"description": "### Zoekobject\nAls \"locatie.identificatie\" parameter onderdeel is van het zoekobject, worden ook tijdelijke delen gefilterd op locatie.\nDe locatie van een tijdelijk deel wordt bepaald op basis van de locatie van zijn regels of tekstdelen, \nafhankelijk van of het een regeling met regelstructuur of een regeling met vrijetekststructuur is.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Voorkomens"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelingen/regels/_zoek": {
"post": {
"tags": [
"Regelingen"
],
"summary": "Regelingen (regeltekstdocumenten) opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekRegelsDocumenten",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"requestBody": {
"description": "### Zoekobject\nAls \"locatie.identificatie\" parameter onderdeel is van het zoekobject, worden ook tijdelijke delen gefilterd op locatie.\nDe locatie van een tijdelijk deel wordt bepaald op basis van de locatie van zijn regels.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentregeltekstZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Regelingen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelingen/tekstdelen/_zoek": {
"post": {
"tags": [
"Regelingen"
],
"summary": "Regelingen met tekstdelen opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekTekstdelenDocumenten",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"requestBody": {
"description": "### Zoekobject\nAls \"locatie.identificatie\" parameter onderdeel is van het zoekobject, worden ook tijdelijke delen gefilterd op locatie.\nDe locatie van een tijdelijk deel wordt bepaald op basis van de locatie van zijn tekstdelen.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentvrijetekstZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Regelingen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/regelingen/_suggesties": {
"get": {
"tags": [
"Regelingen"
],
"summary": "Alle zoekmogelijheden ophalen voor regelingen. Tijdelijke delen zijn niet los opvraagbaar en komen dus niet als suggestie terug.",
"operationId": "getZoekSuggesties",
"parameters": [
{
"$ref": "#/components/parameters/zoekTerm"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/RegelingSuggestieCollectie"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/omgevingsvergunningen": {
"get": {
"tags": [
"Omgevingsvergunningen"
],
"summary": "Alle omgevingsvergunningen opvragen",
"operationId": "getOmgevingsvergunningen",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Omgevingsvergunningen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/omgevingsvergunningen/{identificatie}": {
"get": {
"tags": [
"Omgevingsvergunningen"
],
"summary": "Een enkele omgevingsvergunning opvragen",
"description": "De pad parameter 'identificatie' is een ge-escapete versie van het document-id. De escaping gebeurt met de volgende regex: [^\\w]+ wordt vervangen door _",
"operationId": "getOmgevingsvergunning",
"parameters": [
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Omgevingsvergunning"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/omgevingsvergunningen/_suggesties": {
"get": {
"tags": [
"Omgevingsvergunningen"
],
"summary": "Alle zoekmogelijheden ophalen voor omgevingsvergunningen",
"operationId": "getOmgevingsVergunningZoekSuggesties",
"parameters": [
{
"$ref": "#/components/parameters/zoekTerm"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OmgevingsvergunningSuggestieCollectie"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/omgevingsvergunningen/_zoek": {
"post": {
"tags": [
"Omgevingsvergunningen"
],
"summary": "Omgevingsvergunningen opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekOmgevingsvergunningen",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OmgevingsvergunningZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Omgevingsvergunningen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/locaties": {
"get": {
"tags": [
"Locaties"
],
"summary": "Alle locaties opvragen",
"operationId": "getLocaties",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "activiteitIdentificatie",
"in": "query",
"description": "Alleen locaties opvragen die gereguleerd zijn voor de gegeven activiteit",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "juridischeRegelIdentificatie",
"in": "query",
"description": "Alleen locaties opvragen die gereguleerd zijn voor de gegeven juridischeRegelIdentificatie. Deprecated since version 7.2.1",
"required": false,
"deprecated": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "activiteitlocatieaanduidingIdentificatie",
"in": "query",
"description": "Alleen locaties opvragen die kwalificeert voor de gegeven activiteitlocatieaanduiding. De activiteitlocatieaanduidingIdentificatie parameter moet altijd in combinatie met RegeltekstIdentificatie gebruikt worden.\n",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "tekstdeelIdentificatie",
"in": "query",
"description": "Alleen locaties opvragen die gedefinieerd zijn voor dit tekstdeel. Deprecated since version 7.2.1",
"required": false,
"deprecated": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "regeltekstIdentificatie",
"in": "query",
"description": "Alleen locaties opvragen die gelden als werkingsgebied voor de gegeven regeltekst. Indien de regeltekstIdentificatie in combinatie met de activiteitlocatieaanduidingIdentificatie gebruikt wordt, dan worden alleen de aan activiteitlocatieaanduiding gerelateerde locaties uitgeleverd.\n",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "divisieannotatieIdentificatie",
"in": "query",
"description": "Alleen locaties opvragen die gelden als werkingsgebied voor de gegeven divisie",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "gebiedsaanwijzingIdentificatie",
"in": "query",
"description": "Alleen locaties opvragen die gelden als werkingsgebied voor de gegeven gebiedsaanwijzing",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "omgevingsnormIdentificatie",
"in": "query",
"description": "Alleen locaties opvragen die gelden voor een normwaarde in combinatie met de gegeven omgevingsnorm.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "omgevingswaardeIdentificatie",
"in": "query",
"description": "Alleen locaties opvragen die gelden voor een normwaarde in combinatie met de gegeven omgevingswaarde.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "normwaardeIdentificatie",
"in": "query",
"description": "Alleen locaties opvragen die gelden voor de gegeven normwaarde. omgevingsnormIdentificatie of omgevingswaardeIdentificatie moet ook ingevuld zijn.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "idealisatie",
"in": "query",
"description": "de idealisatie van de juridischeregels",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "ontwerpGebiedsaanwijzingTechnischId",
"in": "query",
"description": "Alleen locaties opvragen die gelden als werkingsgebied voor de gegeven ontwerpgebiedsaanwijzing",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "ontwerpOmgevingswaardeTechnischId",
"in": "query",
"description": "Alleen locaties opvragen die gelden als werkingsgebied voor de gegeven ontwerpOmgevingswaarde",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "ontwerpOmgevingsnormTechnischId",
"in": "query",
"description": "Alleen locaties opvragen die gelden als werkingsgebied voor de gegeven ontwerpOmgevingsnorm",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "ontwerpNormwaardeIdentificatie",
"in": "query",
"description": "Alleen locaties opvragen die gelden als werkingsgebied voor de gegeven ontwerpNormwaarde",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "ontwerpRegeltekstTechnischId",
"in": "query",
"description": "Alleen locaties opvragen die gelden als werkingsgebied voor de gegeven ontwerpRegeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "ontwerpDivisieannotatieTechnischId",
"in": "query",
"description": "Alleen locaties opvragen die gelden als werkingsgebied voor de gegeven ontwerpDivisie",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "ontwerpActiviteitTechnischId",
"in": "query",
"description": "Alleen locaties opvragen die gelden als werkingsgebied voor de gegeven ontwerpActiviteit",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "ontwerpActiviteitlocatieaanduidingIdentificatie",
"in": "query",
"description": "Alleen locaties opvragen die gelden als werkingsgebied voor de gegeven ontwerpActiviteitlocatieaanduiding",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NoemerSort"
}
],
"responses": {
"200": {
"description": "Locaties",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Locaties"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/locaties/{identificatie}": {
"get": {
"tags": [
"Locaties"
],
"summary": "Een bepaalde locatie met de bounding box van de bijbehorende geometrie ophalen",
"operationId": "getLocatie",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.locatie.2019000242example"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/LocatieMetBoundingBox"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/locaties/{identificatie}/bounding-box": {
"get": {
"tags": [
"Locaties"
],
"summary": "Een bepaalde locatie of locatiegroep met de bounding box van de bijbehorende geometrie ophalen",
"operationId": "getLocatieBoundingBox",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"name": "identificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.locatie.2019000242example"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/LocatieMetBoundingBox"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/locaties/_zoek": {
"post": {
"tags": [
"Locaties"
],
"summary": "Alle locaties opvragen die voldoen aan de zoekparameters in het zoekObject en eventuele filters.",
"operationId": "zoekLocaties",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NoemerSort"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/toonAlleenWerkingsgebieden"
},
{
"$ref": "#/components/parameters/nietOpgenomenIn"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_expandScopeGeometrieIdentificaties"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocatieZoekObject"
},
"examples": {
"documentIdentificatie": {
"value": {
"zoekParameters": [
{
"parameter": "document.identificatie",
"zoekWaarden": [
"/akn/nl/act/gm0037/2019/3520_example"
]
}
]
}
},
"ontwerpdocumentTechnischId": {
"value": {
"zoekParameters": [
{
"parameter": "ontwerpdocument.technischId",
"zoekWaarden": [
"_akn_nl_act_gm0037_2019_3520_example_ontwerpbesluit_example"
]
}
]
}
},
"locatieIdentificatie": {
"value": {
"zoekParameters": [
{
"parameter": "locatie.identificatie",
"zoekWaarden": [
"nl.imow-mnre1034.gebied.Waddengebied"
]
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Locaties"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/locatieidentificaties/toekomstig/_zoek": {
"post": {
"tags": [
"Locaties"
],
"summary": "Alle actuele en toekomstige locatieIdentificaties opvragen die voldoen aan de geo in het zoekobject en controleren of het zoekgebied binnen pons valt",
"operationId": "zoekLocatieIdentificatiesToekomstig",
"parameters": [
{
"$ref": "#/components/parameters/ContentCrsHeader"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/vanaf"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocatieIdentificatieZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/LocatieZoekgebiedenToekomstig"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/locatieidentificaties/_zoek": {
"post": {
"tags": [
"Locaties"
],
"summary": "Alle locatieIdentificaties opvragen die voldoen aan de geo in het zoekobject en controleren of het zoekgebied binnen pons valt",
"operationId": "zoekLocatieIdentificaties",
"parameters": [
{
"$ref": "#/components/parameters/ContentCrsHeader"
},
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocatieIdentificatieZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/LocatieZoekgebieden"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/afbeeldingen/{bevoegdGezag}/{toestandIdentificatie}/{naam}": {
"get": {
"tags": [
"Regelingen",
"Afbeeldingen"
],
"summary": "Een afbeelding uit een document opvragen",
"operationId": "getDocumentAfbeelding",
"parameters": [
{
"name": "bevoegdGezag",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "pv26"
},
{
"name": "toestandIdentificatie",
"in": "path",
"description": "De pad parameter 'toestandIdentificatie' is een ge-escapete versie van de toestandIdentificatie. De escaping gebeurt met de volgende regex: [^\\w]+ wordt vervangen door _",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_example_nld_2019_06_25_1"
},
{
"name": "naam",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "afbeelding.png"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/*": {
"schema": {
"$ref": "#/components/schemas/Afbeelding"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"x-auth-type": "None"
}
},
"/ontwerpregelingen": {
"get": {
"tags": [
"OntwerpRegelingen"
],
"summary": "Alle ontwerp regelingen opvragen",
"operationId": "getOntwerpRegelingen",
"parameters": [
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpRegelingen"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpregelingen/_suggesties": {
"get": {
"tags": [
"OntwerpRegelingen"
],
"summary": "Alle zoek mogelijkheden ophalen voor ontwerpregelingen",
"operationId": "getOntwerpRegelingZoekSuggesties",
"parameters": [
{
"$ref": "#/components/parameters/zoekTerm"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpRegelingSuggestieCollectie"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpregelingen/findByExpressionId": {
"get": {
"tags": [
"OntwerpRegelingen"
],
"summary": "Een enkele ontwerp regeling opvragen.",
"operationId": "getOntwerpRegelingByExpressionId",
"parameters": [
{
"name": "expressionId",
"in": "query",
"description": "ontwerpregelingen op halen aan de hand van het expressionId",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.expressionId.2019000242example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpRegeling"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpregelingen/{technischId}": {
"get": {
"tags": [
"OntwerpRegelingen"
],
"summary": "Een enkel van ontwerp regeling opvragen.",
"operationId": "getOntwerpRegeling",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_ontwerp_example_akn_nl_act_gm0037_2019_3520_ontwerp_exampl"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpRegeling"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpregelingen/{technischId}/tekststructuur": {
"get": {
"tags": [
"OntwerpRegelingen"
],
"summary": "Alle documentcomponenten van een regeling in een boomstructuur opvragen",
"operationId": "getOntwerpRegelingTekststructuur",
"parameters": [
{
"name": "technischId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpTekststructuurDocumentComponenten"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpregelingen/{technischId}/ontwerpdocumentcomponenten": {
"get": {
"tags": [
"OntwerpRegelingen"
],
"summary": "Alle root ontwerp documentcomponenten van een ontwerp regeling opvragen",
"operationId": "getOntwerpRegelingComponenten",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_example"
},
{
"name": "Content-Type-Embedded",
"in": "header",
"description": "Content-Type-Embedded",
"required": false,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"enum": [
"application/xml",
"text/html"
]
},
"example": "application/xml"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpDocumentComponenten"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"deprecated": true
}
},
"/ontwerpregelingen/{technischId}/ontwerpdocumentcomponenten/{componentWorkId}": {
"get": {
"tags": [
"OntwerpRegelingen"
],
"summary": "Een ontwerp van documentcomponent opvragen",
"operationId": "getOntwerpRegelingComponent",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_example"
},
{
"name": "componentWorkId",
"in": "path",
"description": "De workId van het ontwerp DocumentComponent",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "gm1979_2__chp_1"
},
{
"name": "Content-Type-Embedded",
"in": "header",
"description": "Content-Type-Embedded",
"required": false,
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"enum": [
"application/xml",
"text/html"
]
},
"example": "application/xml"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpDocumentComponent"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpregelingen/{technischId}/themas": {
"get": {
"tags": [
"OntwerpRegelingen"
],
"summary": "Themas opvragen",
"operationId": "getOntwerpRegelingThemas",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/Themas"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpregelingen/regels/_zoek": {
"post": {
"tags": [
"OntwerpRegelingen"
],
"summary": "Ontwerp Omgevingsdocumenten (regeltekstdocumenten) opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekOntwerpRegelsDocumenten",
"parameters": [
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OntwerpDocumentregeltekstZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpRegelingen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpregelingen/tekstdelen/_zoek": {
"post": {
"tags": [
"OntwerpRegelingen"
],
"summary": "Ontwerp Omgevingsdocumenten met tekstdelen opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekOntwerpTekstdelenDocumenten",
"parameters": [
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OntwerpDocumentvrijetekstZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpRegelingen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpafbeeldingen/{bevoegdGezag}/{ontwerpbesluitIdentificatie}/{naam}": {
"get": {
"tags": [
"OntwerpRegelingen",
"Afbeeldingen"
],
"summary": "Een afbeelding uit een ontwerp document opvragen",
"operationId": "getOntwerpDocumentAfbeelding",
"parameters": [
{
"name": "bevoegdGezag",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "pv26"
},
{
"name": "ontwerpbesluitIdentificatie",
"in": "path",
"description": "De pad parameter 'ontwerpbesluitIdentificatie' is een ge-escapete versie van de proefversieIdentificatie. De escaping gebeurt met de volgende regex: [^\\w]+ wordt vervangen door _",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_example_nld_2019_06_25_1"
},
{
"name": "naam",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "afbeelding.png"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/*": {
"schema": {
"$ref": "#/components/schemas/Afbeelding"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"x-auth-type": "None"
}
},
"/ontwerpregelteksten": {
"get": {
"tags": [
"OntwerpRegelteksten"
],
"summary": "Alle ontwerpregelteksten opvragen, de regelteksten kunnen ook gesorteerd op workId opgeleverd worden (met sort=workId)!",
"operationId": "getOntwerpRegelteksten",
"parameters": [
{
"name": "ontwerpActiviteitTechnischId",
"in": "query",
"description": "OntwerpRegelteksten ophalen die deze activiteit beschrijven",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_pv26_activiteit_202000005325235_akn_nl_bill_pv26_2020_OVPU001RGL_20210115_165356_example"
},
{
"name": "ontwerpOmgevingsnormTechnischId",
"in": "query",
"description": "OntwerpRegelteksten ophalen die deze omgevingsnorm beschrijven",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_pv26_omgevingsnorm_202000005325235_akn_nl_bill_pv26_2020_OVPU001RGL_20210115_165356_example"
},
{
"name": "ontwerpOmgevingswaardeTechnischId",
"in": "query",
"description": "OntwerpRegelteksten ophalen die deze ontwerpOmgevingswaarde beschrijven",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_pv26_omgevingswaarde_202000005325235_akn_nl_bill_pv26_2020_OVPU001RGL_20210115_165356_example"
},
{
"name": "ontwerpGebiedsaanwijzingTechnischId",
"in": "query",
"description": "OntwerpRegelteksten ophalen die deze ontwerpGebiedsaanwijzing beschrijven",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_pv26_gebiedsaanwijzing_202000005325235_akn_nl_bill_pv26_2020_OVPU001RGL_20210115_165356_example"
},
{
"name": "ActiviteitIdentificatie",
"in": "query",
"description": "OntwerpRegelteksten ophalen die deze activiteit beschrijven",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_pv26_omgevingsnorm_202000005325235_akn_nl_bill_pv26_2020_OVPU001RGL_20210115_165356_example"
},
{
"name": "omgevingsnormIdentificatie",
"in": "query",
"description": "OntwerpRegelteksten ophalen die deze omgevingsnorm beschrijven",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0297.omgevingsnorm.20190043244example"
},
{
"name": "omgevingswaardeIdentificatie",
"in": "query",
"description": "OntwerpRegelteksten ophalen die deze omgevingswaarde beschrijven",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0297.omgevingswaarde.20190043244example"
},
{
"name": "gebiedsaanwijzingIdentificatie",
"in": "query",
"description": "OntwerpRegelteksten ophalen die deze gebiedsaanwijzing beschrijven",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0297.gebiedsaanwijzing.20190043244example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpRegelteksten"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpregelteksten/{technischId}": {
"get": {
"tags": [
"OntwerpRegelteksten"
],
"summary": "Een enkele van ontwerp regeltekst opvragen",
"operationId": "getOntwerpRegeltekst",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerp objecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.regeltekst.example_akn_nl_bill_pv26_2020_example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_ontwerpExpandScope"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpRegeltekst"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpregelteksten/_zoek": {
"post": {
"tags": [
"OntwerpRegelteksten"
],
"summary": "OntwerpRegelteksten opvragen die voldoen aan zoekobject-parameters, de regelteksten kunnen ook gesorteerd op workId opgeleverd worden (met sort=workId)",
"operationId": "zoekOntwerpRegelteksten",
"parameters": [
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_ontwerpExpandScope"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OntwerpRegeltekstZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpRegelteksten"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerplocaties": {
"get": {
"tags": [
"OntwerpLocaties"
],
"summary": "Alle ontwerp locaties opvragen",
"operationId": "getOntwerpLocaties",
"parameters": [
{
"name": "ontwerpRegeltekstTechnischId",
"in": "query",
"description": "Alleen ontwerp locaties opvragen die gereguleerd zijn voor de gegeven ontwerp regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.regeltekst.2019000242example_akn_nl_act_gm0037_2019_3520_ontwerp_example"
},
{
"name": "ontwerpActiviteitTechnischId",
"in": "query",
"description": "Alleen ontwerp locaties opvragen die gereguleerd zijn voor de gegeven activiteit",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "nl.imow-gm0037.activiteit.2019000242example"
}
},
{
"name": "ontwerpDivisieannotatieTechnischId",
"in": "query",
"description": "Alleen ontwerplocaties opvragen die opgenomen zijn in de gegeven ontwerpdivisie",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "nl_imow_pv26_divisie_2019000046example_akn_nl_bill_pv26_2020_example"
}
},
{
"name": "ontwerpGebiedsaanwijzingTechnischId",
"in": "query",
"description": "Alleen ontwerp locaties opvragen die gelden als werkingsgebied voor de gegeven ontwerpgebiedsaanwijzing",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "ontwerpActiviteitlocatieaanduidingIdentificatie",
"in": "query",
"description": "Alleen ontwerp locaties opvragen die gelden als werkingsgebied voor de gegeven ontwerpActiviteitlocatieaanduiding",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "ontwerpNormwaardeIdentificatie",
"in": "query",
"description": "Alleen ontwerp locaties opvragen die gelden als werkingsgebied voor de gegeven ontwerpNormwaarde",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "ontwerpOmgevingswaardeTechnischId",
"in": "query",
"description": "Alleen ontwerp locaties opvragen die gelden als werkingsgebied voor de gegeven ontwerpOmgevingswaarde",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "ontwerpOmgevingsnormTechnischId",
"in": "query",
"description": "Alleen ontwerp locaties opvragen die gelden als werkingsgebied voor de gegeven ontwerpOmgevingsnorm",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NoemerSort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpLocaties"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerplocaties/{technischId}": {
"get": {
"tags": [
"OntwerpLocaties"
],
"summary": "Een ontwerp locatie ophalen aan de hand van identificatie en ontwerpbesluitIdentificatie",
"operationId": "getOntwerpLocatie",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_ontwerp_example_akn_nl_act_gm0037_2019_3520_ontwerp_exampl"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpLocatieMetBoundingBox"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerplocaties/{technischId}/bounding-box": {
"get": {
"tags": [
"OntwerpLocaties"
],
"summary": "Een ontwerp locatie met boundingbox ophalen aan de hand van identificatie en ontwerpbesluitIdentificatie. Omvat en omvat vastgesteld zijn nooit aanwezig",
"operationId": "getOntwerpLocatieBoundingBox",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_ontwerp_example_akn_nl_act_gm0037_2019_3520_ontwerp_exampl"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpLocatieMetBoundingBox"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerplocaties/_zoek": {
"post": {
"tags": [
"OntwerpLocaties"
],
"summary": "Alle ontwerp locaties opvragen die voldoen aan de zoekparameters in het zoekObject en eventuele filters.",
"operationId": "zoekOntwerpLocaties",
"parameters": [
{
"$ref": "#/components/parameters/geldigOp"
},
{
"$ref": "#/components/parameters/inWerkingOp"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NoemerSort"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/toonAlleenWerkingsgebieden"
},
{
"$ref": "#/components/parameters/nietOpgenomenIn"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_expandScopeGeometrieIdentificaties"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OntwerpLocatieZoekObject"
},
"examples": {
"ontwerpdocumentTechnischId": {
"value": {
"zoekParameters": [
{
"parameter": "ontwerpdocument.technischId",
"zoekWaarden": [
"_akn_nl_act_gm0037_2019_3520_example_ontwerpbesluit_example"
]
}
]
}
},
"ontwerplocatieTechnischId": {
"value": {
"zoekParameters": [
{
"parameter": "ontwerplocatie.technischId",
"zoekWaarden": [
"nl_imow_gm1911_gebiedengroep_VerspreideHuizenWieringerwerffiets_akn_nl_bill_gm1911_2022_HollandsKroonOntwerpOpTijdreisplan"
]
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpLocaties"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerplocaties/technischids/_zoek": {
"post": {
"tags": [
"OntwerpLocaties"
],
"summary": "Alle technischIds van ontwerplocaties opvragen die voldoen aan de geo in het zoekobject",
"operationId": "zoekOntwerpLocatiesTechnischIds",
"parameters": [
{
"$ref": "#/components/parameters/ContentCrsHeader"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocatieIdentificatieZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpLocatieZoekgebieden"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpponsen/{technischId}": {
"get": {
"tags": [
"OntwerpPonsen"
],
"summary": "Een enkele ontwerp pons opvragen",
"operationId": "getOntwerpPons",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_ontwerp_example_akn_nl_act_gm0037_2019_3520_ontwerp_exampl"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpPons"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpponsen/_zoek": {
"post": {
"tags": [
"OntwerpPonsen"
],
"summary": "Ontwerp Ponsen opvragen die voldoen aan het geozoekgebied",
"operationId": "zoekOntwerpPonsen",
"parameters": [
{
"name": "Content-Crs",
"in": "header",
"description": "Content-Crs",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "EPSG:28992"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"requestBody": {
"description": "PonsZoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PonsZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpPonsen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpactiviteiten": {
"get": {
"tags": [
"OntwerpActiviteiten"
],
"summary": "Alle ontwerp activiteiten opvragen",
"operationId": "getOntwerpActiviteiten",
"parameters": [
{
"name": "ontwerpGerelateerdeActiviteitTechnischId",
"in": "query",
"description": "Activiteiten ophalen die gerelateerd zijn aan deze activiteit",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.activiteit.2019000242example"
},
{
"name": "ontwerpregeltekstTechnischId",
"in": "query",
"description": "Alleen juridische regels opvragen die opgenomen zijn in de gegeven regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.regeltekst.2019000242example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpActiviteiten"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpactiviteiten/{technischId}": {
"get": {
"tags": [
"OntwerpActiviteiten"
],
"summary": "Een enkele ontwerpactiviteit opvragen",
"operationId": "getOntwerpActiviteit",
"parameters": [
{
"name": "technischId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.activiteit.2019000241example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpActiviteit"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpactiviteiten/_zoek": {
"post": {
"tags": [
"OntwerpActiviteiten"
],
"summary": "Activiteiten opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekOntwerpActiviteiten",
"parameters": [
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_ontwerpExpandScope"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OntwerpActiviteitZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpActiviteiten"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpactiviteiten/{ontwerpActiviteitTechnischId}/ontwerpactiviteitlocatieaanduidingen": {
"get": {
"tags": [
"OntwerpActiviteiten"
],
"summary": "OntwerptActiviteitlocatieaanduidingen opvragen bij een activiteit",
"operationId": "getOntwerpActiviteitLocatieaanduidingen",
"parameters": [
{
"name": "ontwerpActiviteitTechnischId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.activiteit.2019000241example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpActiviteitLocatieaanduidingen"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpactiviteiten/{ontwerpActiviteitTechnischId}/ontwerpactiviteitlocatieaanduidingen/{activiteitlocatieaanduidingidentificatie}": {
"get": {
"tags": [
"OntwerpActiviteiten"
],
"summary": "Een enkele OntwerpActiviteitlocatieaanduiding opvragen",
"operationId": "getOntwerpActiviteitLocatieaanduiding",
"parameters": [
{
"name": "ontwerpActiviteitTechnischId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.activiteit.2019000241example"
},
{
"name": "activiteitlocatieaanduidingidentificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.activiteitlocatieaanduiding.2019000241example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpActiviteitLocatieaanduiding"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpactiviteitlocatieaanduidingen/_zoek": {
"post": {
"tags": [
"OntwerpActiviteiten"
],
"summary": "OntwerpActiviteitLocatieaanduidingen opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekOntwerpActiviteitLocatieaanduidingen",
"parameters": [
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/NaamSort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_ontwerpExpandScope"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OntwerpActiviteitLocatieaanduidingZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpActiviteitLocatieaanduidingen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpomgevingsnormen": {
"get": {
"tags": [
"OntwerpOmgevingsnormen"
],
"summary": "Alle ontwerpOmgevingsnormen opvragen",
"operationId": "getAllOntwerpomgevingsnormen",
"parameters": [
{
"name": "ontwerpregeltekstTechnischId",
"in": "query",
"description": "Alleen OntwerpOmgevingsnormen opvragen die gereguleerd zijn voor de gegeven ontwerp regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.regeltekst.2019000242example_akn_nl_act_gm0037_2019_3520_ontwerp_example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpOmgevingsnormen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpomgevingsnormen/{technischId}": {
"get": {
"tags": [
"OntwerpOmgevingsnormen"
],
"summary": "Een enkele ontwerpOmgevingsnorm opvragen",
"operationId": "getOntwerpomgevingsnorm",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_ontwerp_example_akn_nl_act_gm0037_2019_3520_ontwerp_exampl"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpOmgevingsnorm"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpomgevingsnormen/{technischId}/normwaarden/{normwaardeIdentificatie}": {
"get": {
"tags": [
"OntwerpOmgevingsnormen"
],
"summary": "Een enkele ontwerpNormwaarde opvragen behorend bij een ontwerpOmgevingsnorm opvragen",
"operationId": "getOntwerpOmgevingsnormNormwaarde",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_ontwerp_example_akn_nl_act_gm0037_2019_3520_ontwerp_exampl"
},
{
"name": "normwaardeIdentificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.normwaarde.2019000241example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpNormwaarde"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpomgevingsnormen/_zoek": {
"post": {
"tags": [
"OntwerpOmgevingsnormen"
],
"summary": "ontwerpOmgevingsnormen opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekOntwerpomgevingsnormen",
"parameters": [
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_ontwerpExpandScope"
}
],
"requestBody": {
"description": "OntwerpOmgevingsnormZoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OntwerpOmgevingsnormZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpOmgevingsnormen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpomgevingswaarden": {
"get": {
"tags": [
"OntwerpOmgevingswaarden"
],
"summary": "Alle ontwerpOmgevingswaarden opvragen",
"operationId": "getAllOntwerpOmgevingswaarden",
"parameters": [
{
"name": "ontwerpregeltekstTechnischId",
"in": "query",
"description": "Alleen OntwerpOmgevingsnormen opvragen die gereguleerd zijn voor de gegeven ontwerp regeltekst",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.regeltekst.2019000242example_akn_nl_act_gm0037_2019_3520_ontwerp_example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpOmgevingswaarden"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpomgevingswaarden/{technischId}": {
"get": {
"tags": [
"OntwerpOmgevingswaarden"
],
"summary": "Een enkele ontwerpOmgevingswaarde opvragen",
"operationId": "getOntwerpOmgevingswaarde",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_ontwerp_example_akn_nl_act_gm0037_2019_3520_ontwerp_exampl"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpOmgevingswaarde"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpomgevingswaarden/{technischId}/normwaarden/{normwaardeIdentificatie}": {
"get": {
"tags": [
"OntwerpOmgevingswaarden"
],
"summary": "Een enkele ontwerpNormwaarde opvragen behorend bij een ontwerpOmgevingswaarde opvragen",
"operationId": "getOntwerpOmgevingswaardeNormwaarde",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "_akn_nl_act_gm0037_2019_3520_ontwerp_example_akn_nl_act_gm0037_2019_3520_ontwerp_exampl"
},
{
"name": "normwaardeIdentificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.normwaarde.2019000241example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpNormwaarde"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpomgevingswaarden/_zoek": {
"post": {
"tags": [
"OntwerpOmgevingswaarden"
],
"summary": "OntwerpOmgevingswaarden opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekOntwerpOmgevingswaarden",
"parameters": [
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_ontwerpExpandScope"
}
],
"requestBody": {
"description": "OntwerpOmgevingswaardeZoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OntwerpOmgevingswaardeZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpOmgevingswaarden"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpdivisieannotaties": {
"get": {
"tags": [
"OntwerpDivisieannotaties"
],
"summary": "Alle ontwerpdivisieannotaties opvragen, de OntwerpDivisieannotaties kunnen ook gesorteerd op workId opgeleverd worden (met sort=workId)",
"operationId": "getOntwerpDivisieannotaties",
"parameters": [
{
"name": "gebiedsaanwijzingIdentificatie",
"in": "query",
"description": "OntwerpDivisieannotaties waar deze gebiedsaanwijzing in opgenomen is",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.gebiedsaanwijzing.2019000025example"
},
{
"name": "ontwerpGebiedsaanwijzingTechnischId",
"in": "query",
"description": "OntwerpDivisieannotaties waar deze ontwerpGebiedsaanwijzingTechnischId in opgenomen is",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpDivisieannotaties"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpdivisieannotaties/{technischId}": {
"get": {
"tags": [
"OntwerpDivisieannotaties"
],
"summary": "Een enkele OntwerpDivisieannotatie opvragen",
"operationId": "getOntwerpDivisieannotatie",
"parameters": [
{
"name": "technischId",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl_imow_gm0037_divisie_2019000001example_ontwerpbesluit_idenificatie"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpDivisieannotatie"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerpdivisieannotaties/_zoek": {
"post": {
"tags": [
"OntwerpDivisieannotaties"
],
"summary": "OntwerpDivisieannotaties opvragen die voldoen aan zoekobject-parameters,de OntwerpDivisieannotaties kunnen ook gesorteerd op workId opgeleverd worden (met sort=workId)",
"operationId": "zoekOntwerpDivisieannotaties",
"parameters": [
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
},
{
"$ref": "#/components/parameters/_expand"
},
{
"$ref": "#/components/parameters/_ontwerpExpandScope"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OntwerpDivisieannotatieZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpDivisieannotaties"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerphoofdlijnen": {
"get": {
"tags": [
"OntwerpHoofdlijnen"
],
"summary": "Alle ontwerp hoofdlijnen opvragen",
"operationId": "getOntwerpHoofdlijnen",
"parameters": [
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
},
{
"name": "gerelateerdeHoofdlijnIdentificatie",
"in": "query",
"description": "Vastgestelde Hoofdlijnen die aan deze Hoofdlijn zijn gerelateerd",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl.imow-gm0037.hoofdlijn.2019000242example"
},
{
"name": "gerelateerdeOntwerpHoofdlijnTechnischId",
"in": "query",
"description": "Vastgestelde Hoofdlijnen die aan deze Ontwerp Hoofdlijn zijn gerelateerd",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_gm0037_hoofdlijn_2019000242example_akn_nl_bill_pv26_2020_example"
},
{
"name": "ontwerpDivisieannotatieTechnischId",
"in": "query",
"description": "Hoofdlijnen ophalen die deze ontwerp divisie bevat",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
"example": "nl_imow_gm0037_divisie_2019000242example_akn_nl_bill_pv26_2020_example"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpHoofdlijnen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerphoofdlijnen/{technischId}": {
"get": {
"tags": [
"OntwerpHoofdlijnen"
],
"summary": "Een enkele ontwerp hoofdlijn opvragen",
"operationId": "getOntwerpHoofdlijn",
"parameters": [
{
"name": "technischId",
"in": "path",
"description": "Een technische identificatie voor ontwerpobjecten, samengesteld uit de IMOW-identificatie en de ontwerpbesluitIdentificatie, die gebruikt kan worden als pad parameter en in zoekopdrachten.",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
},
"example": "nl.imow-pv26.hoofdlijn.2019000046example_akn_nl_bill_pv26_2020_example"
},
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpHoofdlijn"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerphoofdlijnen/_zoek": {
"post": {
"tags": [
"OntwerpHoofdlijnen"
],
"summary": "Alle ontwerp hoofdlijnen opvragen die voldoen aan zoekobject-parameters",
"operationId": "zoekOntwerpHoofdlijnen",
"parameters": [
{
"$ref": "#/components/parameters/beschikbaarOp"
},
{
"$ref": "#/components/parameters/synchroniseerMetTileset"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/Size"
},
{
"$ref": "#/components/parameters/Sort"
}
],
"requestBody": {
"description": "Zoekobject",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OntwerpHoofdlijnZoekobject"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/OntwerpHoofdlijnen"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"412": {
"$ref": "#/components/responses/PreconditionFailed"
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/health": {
"get": {
"tags": [
"Meta"
],
"summary": "health info",
"operationId": "getHealth",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Health"
}
}
}
},
"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",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Info"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Regeling": {
"title": "Regeling",
"type": "object",
"properties": {
"heeftTijdelijkDeel": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Regeling"
}
}
},
"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"
],
"properties": {
"type": {
"$ref": "#/components/schemas/SoortRegeling"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
},
"citeerTitel": {
"title": "citeerTitel",
"minItems": 0,
"type": "string"
},
"opschrift": {
"title": "opschrift",
"type": "string"
},
"conditie": {
"title": "conditie",
"minItems": 0,
"type": "string"
},
"opvolgerVan": {
"title": "opvolgerVan",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Regeling"
}
},
"heeftBijlagen": {
"title": "heeftBijlagen",
"minItems": 1,
"type": "boolean"
},
"heeftToelichtingen": {
"title": "heeftToelichtingen",
"minItems": 1,
"type": "boolean"
},
"publicatieID": {
"type": "string"
},
"inwerkingTot": {
"title": "inwerkingTot",
"type": "string"
},
"geldigTot": {
"title": "geldigTot",
"type": "string"
},
"_links": {
"$ref": "#/components/schemas/RegelingLinks"
}
}
}
]
},
"BevoegdGezag": {
"title": "BevoegdGezag",
"required": [
"bestuurslaag",
"code",
"naam"
],
"type": "object",
"properties": {
"naam": {
"title": "naam",
"type": "string"
},
"bestuurslaag": {
"title": "bestuurslaag",
"type": "string"
},
"code": {
"title": "code",
"type": "string"
}
}
},
"Besluit": {
"title": "Besluit",
"required": [
"_links",
"besluitStatus",
"identificatie",
"publicatieID"
],
"type": "object",
"properties": {
"besluitStatus": {
"$ref": "#/components/schemas/BesluitStatus"
},
"identificatie": {
"title": "identificatie",
"type": "string"
},
"publicatieID": {
"title": "publicatie-ID",
"type": "string"
},
"aangemaaktVanuit": {
"title": "aangemaakt vanuit",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentComponent"
}
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
}
}
},
"SoortRegeling": {
"title": "soortRegeling",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
}
},
"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."
},
"Omgevingsdocument": {
"title": "Omgevingsdocument",
"required": [
"_links",
"aangeleverdDoorEen",
"identificatie",
"officieleTitel"
],
"type": "object",
"properties": {
"identificatie": {
"title": "identificatie",
"type": "string"
},
"officieleTitel": {
"title": "officieleTitel",
"type": "string"
},
"aangeleverdDoorEen": {
"$ref": "#/components/schemas/BevoegdGezag"
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
}
}
},
"BesluitStatus": {
"title": "BesluitStatus",
"type": "object",
"properties": {
"onherroepelijkVanaf": {
"title": "onherroepelijkVanaf",
"minItems": 0,
"type": "string",
"format": "date-time"
},
"geschorstVanaf": {
"title": "geschorstVanaf",
"minItems": 0,
"type": "string",
"format": "date-time"
},
"toelichtingURL": {
"title": "toelichtingURL",
"minItems": 0,
"type": "string"
}
}
},
"Identificatie": {
"title": "Identificatie",
"type": "string"
},
"HoortBijRegeling": {
"type": "object",
"properties": {
"identificatie": {
"type": "string"
},
"citeerTitel": {
"type": "string"
},
"officieleTitel": {
"type": "string"
}
}
},
"EId": {
"title": "eId",
"type": "string"
},
"WId": {
"title": "wId",
"type": "string"
},
"WaardeEenheid": {
"title": "WaardeEenheid",
"required": [
"eenheid",
"waarde"
],
"type": "object",
"properties": {
"waarde": {
"type": "number"
},
"eenheid": {
"type": "string"
}
},
"description": "Een specifieke datatype voor het vastleggen van waarden met een eenheid, zoals 5 meter, 30 decibel en andere. "
},
"Waardelijst": {
"title": "Waardelijst",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
},
"description": "Een uitbreidbare lijst met een opsomming van de mogelijke domeinwaarden van een attribuutsoort, die buiten het model in een externe waardenlijst worden beheerd. Locatie: urn:imow:Functiegroep"
},
"DocumentComponent": {
"title": "DocumentComponent",
"required": [
"_links",
"expressie",
"identificatie",
"type",
"volgordeNummer"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/WId"
},
"expressie": {
"$ref": "#/components/schemas/EId"
},
"type": {
"title": "type",
"type": "string"
},
"volgordeNummer": {
"title": "volgordeNummer",
"type": "integer"
},
"inhoud": {
"title": "inhoud",
"minItems": 0,
"type": "string"
},
"gereserveerd": {
"title": "gereserveerd",
"minItems": 0,
"type": "boolean"
},
"vervallen": {
"title": "vervallen",
"minItems": 0,
"type": "boolean"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
},
"conditieArtikel": {
"title": "conditieArtikel",
"type": "object",
"properties": {
"label": {
"title": "label",
"type": "string"
},
"nummer": {
"title": "nummer",
"type": "string"
},
"opschrift": {
"title": "opschrift",
"type": "string"
},
"inhoud": {
"title": "inhoud",
"type": "string"
}
}
},
"label": {
"title": "label",
"type": "string"
},
"nummer": {
"title": "nummer",
"type": "string"
},
"opschrift": {
"title": "opschrift",
"type": "string"
},
"_embedded": {
"required": [
"documentComponenten"
],
"type": "object",
"properties": {
"documentComponenten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentComponent"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/DocumentComponentLinks"
}
}
},
"TekststructuurDocumentComponent": {
"title": "TekststructuurDocumentComponent",
"required": [
"expressie",
"identificatie",
"type",
"volgordeNummer"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/WId"
},
"expressie": {
"$ref": "#/components/schemas/EId"
},
"type": {
"title": "type",
"type": "string"
},
"regeltekstIdentificatie": {
"title": "regeltekstIdentificatie",
"type": "string"
},
"divisieannotatieIdentificatie": {
"title": "divisieannotatieIdentificatie",
"type": "string"
},
"volgordeNummer": {
"title": "volgordeNummer",
"type": "integer"
},
"inhoud": {
"title": "inhoud",
"minItems": 0,
"type": "string"
},
"gereserveerd": {
"title": "gereserveerd",
"minItems": 0,
"type": "boolean"
},
"vervallen": {
"title": "vervallen",
"minItems": 0,
"type": "boolean"
},
"conditieArtikel": {
"title": "conditieArtikel",
"type": "object",
"properties": {
"label": {
"title": "label",
"type": "string"
},
"nummer": {
"title": "nummer",
"type": "string"
},
"opschrift": {
"title": "opschrift",
"type": "string"
},
"inhoud": {
"title": "inhoud",
"type": "string"
}
}
},
"label": {
"title": "label",
"minItems": 0,
"type": "string",
"deprecated": true
},
"labelXml": {
"title": "label als XML",
"minItems": 0,
"type": "string"
},
"nummer": {
"title": "nummer",
"minItems": 0,
"type": "string",
"deprecated": true
},
"nummerXml": {
"title": "nummer als XML",
"minItems": 0,
"type": "string"
},
"opschrift": {
"title": "opschrift",
"type": "string"
},
"_embedded": {
"required": [
"tekststructuurDocumentComponenten"
],
"type": "object",
"properties": {
"tekststructuurDocumentComponenten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TekststructuurDocumentComponent"
}
}
}
}
}
},
"Gebiedsaanwijzing": {
"title": "Gebiedsaanwijzing",
"required": [
"_links",
"gebiedsaanwijzingType",
"geregistreerdMet",
"identificatie"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
},
"gebiedsaanwijzingType": {
"title": "label",
"type": "string"
},
"label": {
"type": "string"
},
"naam": {
"type": "string"
},
"groep": {
"$ref": "#/components/schemas/Gebiedsaanwijzinggroep"
},
"hoortBij": {
"title": "hoortBijRegeling",
"type": "array",
"description": "De regeling(en) waar deze gebiedsaanwijzing op geannoteerd is. ",
"items": {
"$ref": "#/components/schemas/HoortBijRegeling"
}
},
"_embedded": {
"$ref": "#/components/schemas/embeddedLocaties"
},
"_links": {
"$ref": "#/components/schemas/GebiedsaanwijzingLinks"
}
},
"description": "Type gebied aangewezen door een juridische regel."
},
"Gebiedsaanwijzinggroep": {
"title": "Gebiedsaanwijzinggroep",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
},
"description": "Een uitbreidbare lijst met een opsomming van de mogelijke domeinwaarden van een attribuutsoort, die buiten het model in een externe waardenlijst worden beheerd."
},
"Kaart": {
"title": "Kaart",
"required": [
"_links",
"bevat",
"geregistreerdMet",
"identificatie",
"naam",
"uitsnede"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"naam": {
"title": "naam",
"type": "string"
},
"nummer": {
"title": "nummer",
"minItems": 0,
"type": "string"
},
"uitsnede": {
"$ref": "#/components/schemas/Kaartextent"
},
"bevat": {
"title": "bevat",
"type": "array",
"items": {
"$ref": "#/components/schemas/Kaartlaag"
}
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
}
}
},
"Kaartlaag": {
"title": "Kaartlaag",
"required": [
"_links",
"identificatie",
"niveau"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"naam": {
"title": "naam",
"minItems": 0,
"type": "string"
},
"niveau": {
"title": "niveau",
"type": "integer"
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
}
}
},
"Kaartextent": {
"title": "Kaartextent",
"required": [
"maxX",
"maxY",
"minX",
"minY"
],
"type": "object",
"properties": {
"minX": {
"title": "minX",
"type": "number"
},
"minY": {
"title": "minY",
"type": "number"
},
"maxX": {
"title": "maxX",
"type": "number"
},
"maxY": {
"title": "maxY",
"type": "number"
}
},
"description": "Minimale en maximale x en y waarden van de coordinaten in de kaart."
},
"Gebied": {
"title": "Gebied",
"type": "object",
"description": "Een op zichzelf staande geometrisch afgebakende 'ruimte' in de fysieke leefomgeving. De geometrische afbakening is juridisch van aard, oftewel is niet fysiek van aard en bevindt zich niet in de fysieke werkelijkheid. Anders gezegd, de afbakening is virtueel.",
"allOf": [
{
"$ref": "#/components/schemas/Locatie"
},
{
"required": [
"geometrie"
],
"properties": {
"geometrie": {
"$ref": "#/components/schemas/VlakOfMultivlak"
},
"hoogte": {
"title": "hoogte",
"minItems": 0,
"type": "array",
"description": "De hoogte waarop de geometrie ligt, in meters.",
"items": {
"$ref": "#/components/schemas/WaardeEenheid"
}
},
"bron": {
"title": "bron",
"minItems": 0,
"type": "array",
"description": "De bron die is gebruikt voor, dan wel de wijze van inwinning van de geometrie. ",
"items": {
"$ref": "#/components/schemas/Bron"
}
},
"origineelCoordinaatSysteem": {
"type": "string"
}
}
}
]
},
"Locatie": {
"title": "Locatie",
"required": [
"geregistreerdMet",
"identificatie"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"geometrieIdentificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"noemer": {
"title": "noemer",
"minItems": 0,
"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."
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
},
"omvat": {
"$ref": "#/components/schemas/Locaties"
},
"omvatGeometrieIdentificaties": {
"$ref": "#/components/schemas/GeometrieIdentificaties"
},
"locatieType": {
"$ref": "#/components/schemas/LocatieType"
},
"hoortBij": {
"title": "hoortBijRegeling",
"type": "array",
"description": "De regeling(en) waar deze locatie op geannoteerd is. ",
"items": {
"$ref": "#/components/schemas/HoortBijRegeling"
}
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
}
},
"description": "Duiding van een geografische positie.\nIndien er naar een locatie verwezen wordt vanuit een BevoegdGezag dan betreft dit een ambtsgebied."
},
"Gebiedengroep": {
"title": "Gebiedengroep",
"type": "object",
"description": "Een groep of verzameling van bij elkaar behorende gebieden. De gebieden zijn gegroepeerd voor een bepaald doel, te weten om samen één locatie vormen, welke als zodanig gebruikt kan worden. ",
"allOf": [
{
"$ref": "#/components/schemas/Locatie"
},
{
"required": [
"omvat"
],
"properties": {
"omvat": {
"title": "omvat",
"type": "array",
"description": "Een gebied van een gebiedengroep.",
"items": {
"$ref": "#/components/schemas/Gebied"
}
}
}
}
]
},
"BestuurlijkeGrenzenVerwijzing": {
"title": "BestuurlijkeGrenzenVerwijzing",
"required": [
"bestuurlijkeGrenzenID",
"domein",
"geldigOp"
],
"type": "object",
"properties": {
"domein": {
"title": "domein",
"type": "string"
},
"bestuurlijkeGrenzenID": {
"title": "bestuurlijkeGrenzenID",
"type": "string"
},
"geldigOp": {
"title": "geldigOp",
"type": "string",
"format": "date-time"
}
}
},
"Lijn": {
"title": "Lijn",
"type": "object",
"description": "Een op zichzelf staande geometrisch afgebakende lijnlocatie in de fysieke leefomgeving. De geometrische afbakening is juridisch van aard, oftewel is niet fysiek van aard en bevindt zich niet in de fysieke werkelijkheid. Anders gezegd, de afbakening is virtueel.",
"allOf": [
{
"$ref": "#/components/schemas/Locatie"
},
{
"properties": {
"geometrie": {
"title": "geometrie",
"minItems": 0,
"type": "array",
"description": "De geometrische bepaling van de lijn door middel van coördinaten.",
"items": {
"$ref": "#/components/schemas/LineStringSegment"
}
},
"hoogte": {
"title": "hoogte",
"minItems": 0,
"type": "array",
"description": "De hoogte waarop de geometrie ligt, in meters.",
"items": {
"$ref": "#/components/schemas/WaardeEenheid"
}
},
"bron": {
"title": "bron",
"minItems": 0,
"type": "array",
"description": "De bron die is gebruikt voor, dan wel de wijze van inwinning van de geometrie. ",
"items": {
"$ref": "#/components/schemas/Bron"
}
},
"origineelCoordinaatSysteem": {
"type": "string"
}
}
}
]
},
"Lijnengroep": {
"title": "Lijnengroep",
"type": "object",
"description": "Een groep of verzameling van bij elkaar behorende lijnen. De lijnen zijn gegroepeerd voor een bepaald doel, te weten om samen één locatie vormen, welke als zodanig gebruikt kan worden.",
"allOf": [
{
"$ref": "#/components/schemas/Locatie"
},
{
"required": [
"omvat"
],
"properties": {
"omvat": {
"title": "omvat",
"type": "array",
"description": "Een lijn van een lijnengroep.",
"items": {
"$ref": "#/components/schemas/Lijn"
}
}
}
}
]
},
"Ambtsgebied": {
"title": "Ambtsgebied",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Locatie"
},
{
"required": [
"bestuurlijkeGrenzenVerwijzing",
"geometrie"
],
"properties": {
"bestuurlijkeGrenzenVerwijzing": {
"$ref": "#/components/schemas/BestuurlijkeGrenzenVerwijzing"
},
"geometrie": {
"$ref": "#/components/schemas/VlakOfMultivlak"
},
"origineelCoordinaatSysteem": {
"type": "string"
}
}
}
]
},
"Punt": {
"title": "Punt",
"type": "object",
"description": "Een op zichzelf staande geometrisch afgebakende puntlocatie in de fysieke leefomgeving. De geometrische afbakening is juridisch van aard, oftewel is niet fysiek van aard en bevindt zich niet in de fysieke werkelijkheid. Anders gezegd, de afbakening is virtueel.",
"allOf": [
{
"$ref": "#/components/schemas/Locatie"
},
{
"required": [
"geometrie"
],
"properties": {
"geometrie": {
"$ref": "#/components/schemas/Point"
},
"hoogte": {
"title": "hoogte",
"minItems": 0,
"type": "array",
"description": "De hoogte waarop de geometrie ligt, in meters.",
"items": {
"$ref": "#/components/schemas/WaardeEenheid"
}
},
"bron": {
"title": "bron",
"minItems": 0,
"type": "array",
"description": "De bron die is gebruikt voor, dan wel de wijze van inwinning van de geometrie. ",
"items": {
"$ref": "#/components/schemas/Bron"
}
},
"origineelCoordinaatSysteem": {
"type": "string"
}
}
}
]
},
"Puntengroep": {
"title": "Puntengroep",
"type": "object",
"description": "Een groep of verzameling van bij elkaar behorende punten. De punten zijn gegroepeerd voor een bepaald doel, te weten om samen één locatie vormen, welke als zodanig gebruikt kan worden.",
"allOf": [
{
"$ref": "#/components/schemas/Locatie"
},
{
"required": [
"omvat"
],
"properties": {
"omvat": {
"title": "omvat",
"type": "array",
"description": "Een punt van een puntengroep.",
"items": {
"$ref": "#/components/schemas/Punt"
}
}
}
}
]
},
"Bron": {
"title": "Bron",
"required": [
"code",
"waarde"
],
"properties": {
"code": {
"type": "string"
},
"waarde": {
"type": "string"
}
},
"description": "Een limitatieve lijst met een opsomming van de mogelijke domeinwaarden van een attribuutsoort, die buiten het model in een externe waardenlijst worden beheerd. "
},
"VlakOfMultivlak": {
"title": "VlakOfMultivlak",
"description": "Een datatype die verschillende formaten als mogelijke keuze biedt: vlak of multivlak. ",
"oneOf": [
{
"$ref": "#/components/schemas/MultiSurface"
},
{
"$ref": "#/components/schemas/Surface"
}
]
},
"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"
],
"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"
},
"_links": {
"$ref": "#/components/schemas/OmgevingsvergunningLinks"
}
}
}
]
},
"SoortVergunning": {
"title": "soortVergunning",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
}
},
"Pons": {
"title": "Pons",
"required": [
"_links",
"geregistreerdMet",
"identificatie"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/PonsLinks"
}
},
"description": "Duiding van een geografische positie."
},
"Instructieregel": {
"title": "Instructieregel",
"type": "object",
"description": "De naam van het instrument waartoe de instructieregel zich richt.",
"allOf": [
{
"$ref": "#/components/schemas/JuridischeRegel"
},
{
"properties": {
"instructieregelInstrument": {
"title": "instructieregelInstrument",
"minItems": 0,
"type": "array",
"description": "Het type bestuursorgaan dat of organisatie die de taak waarover de instructieregel gaat moet uitvoeren.",
"items": {
"$ref": "#/components/schemas/Instrument"
}
},
"instructieregelTaakuitoefening": {
"title": "instructieregelTaakuitoefening",
"minItems": 0,
"type": "array",
"description": "Het type bestuursorgaan dat of organisatie die de taak waarover de instructieregel gaat moet uitvoeren.",
"items": {
"$ref": "#/components/schemas/Adressaat"
}
},
"beschrijftEenOmgevingsnorm": {
"title": "beschrijft een omgevingsnorm",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Omgevingsnorm"
}
}
}
}
]
},
"Omgevingswaarderegel": {
"title": "Omgevingswaarderegel",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/JuridischeRegel"
},
{
"properties": {
"beschrijftEenOmgevingswaarde": {
"title": "beschrijft een omgevingswaarde",
"minItems": 0,
"type": "array",
"description": "Bij een regel die een omgevingswaarde vastlegt geeft deze relatie aan om welke norm het gaat. De bijbehorende locatie(s) waar het om gaat is/zijn bij de normwaardes van de norm zelf te vinden.",
"items": {
"$ref": "#/components/schemas/Omgevingswaarde"
}
}
}
}
]
},
"RegelVoorIedereen": {
"title": "Regel voor iedereen",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/JuridischeRegel"
},
{
"properties": {
"normeertEenActiviteit": {
"title": "normeertEenActiviteit",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/ActiviteitLocatieaanduiding"
}
},
"beschrijftEenOmgevingsnorm": {
"title": "beschrijft een omgevingsnorm",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Omgevingsnorm"
}
}
}
}
]
},
"ActiviteitLocatieaanduiding": {
"title": "ActiviteitLocatieaanduiding",
"required": [
"_links",
"activiteitregelkwalificatie",
"betreftEenActiviteit",
"geregistreerdMet",
"identificatie"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"activiteitregelkwalificatie": {
"$ref": "#/components/schemas/Activiteitregelkwalificatie"
},
"betreftEenActiviteit": {
"$ref": "#/components/schemas/Activiteit"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
},
"_embedded": {
"$ref": "#/components/schemas/embeddedLocaties"
},
"_links": {
"$ref": "#/components/schemas/ActiviteitLocatieaanduidingLinks"
}
}
},
"Regeltekst": {
"title": "Regeltekst",
"required": [
"_links",
"geregistreerdMet",
"identificatie"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"thema": {
"title": "thema",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Thema"
}
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
},
"documentIdentificatie": {
"type": "string"
},
"juridischeGrondslagIdentificatie": {
"$ref": "#/components/schemas/JuridischeGrondslagIdentificaties"
},
"documentKruimelpad": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nummer": {
"type": "string"
},
"opschrift": {
"type": "string"
},
"identificatie": {
"type": "string"
}
}
}
},
"typeJuridischeRegels": {
"title": "typeJuridischeRegels",
"type": "string",
"enum": [
"regel voor iedereen",
"instructieregel",
"omgevingswaarderegel"
]
},
"instructieregelInstrument": {
"title": "instructieregelInstrument",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Instrument"
}
},
"instructieregelTaakuitoefening": {
"title": "instructieregelTaakuitoefening",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Adressaat"
}
},
"_embedded": {
"$ref": "#/components/schemas/embeddedLocaties"
},
"_links": {
"$ref": "#/components/schemas/RegeltekstLinks"
}
},
"description": "Een Regeltekst is de kleinste zelfstandige eenheid van (een of meer) bij elkaar behorende juridische regels. Deze regels horen onlosmakelijk bij elkaar en hebben gezamenlijk één werkingsgebied."
},
"embeddedLocaties": {
"type": "object",
"properties": {
"locaties": {
"type": "array",
"description": "Vastgestelde locaties opgenomen in het werkingssgebied van vastgestelde juridische regels.",
"items": {
"$ref": "#/components/schemas/Locatie"
}
},
"locatiesInOntwerpJuridischeRegel": {
"type": "array",
"description": "Vastgestelde locaties opgenomen in het werkingssgebied van ontwerp juridische regels.",
"items": {
"$ref": "#/components/schemas/Locatie"
}
}
}
},
"embeddedOntwerpLocaties": {
"properties": {
"locaties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Locatie"
}
},
"ontwerpLocaties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpLocatie"
}
}
}
},
"JuridischeRegel": {
"title": "Juridische regel",
"required": [
"_links",
"definieert",
"idealisatie",
"identificatie",
"isOpgenomenIn",
"omschrijving"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"idealisatie": {
"$ref": "#/components/schemas/Idealisatie"
},
"omschrijving": {
"title": "omschrijving",
"type": "string",
"description": "Één doorlopend stuk juridische tekst, van een artikel of een lid, die omschrijvingen van (een of meer) juridische regels bevat. "
},
"thema": {
"title": "thema",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Thema"
}
},
"definieert": {
"title": "definieert",
"type": "array",
"description": "De locatieaanduiding begrenst de juridische werking van de regel in juridische zin, te weten dat de regel alleen binnen dit werkingsgebied werkingskracht heeft. ",
"items": {
"$ref": "#/components/schemas/Locatie"
}
},
"bevat": {
"title": "bevat",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Kaart"
}
},
"beschrijftEenGebiedsaanwijzing": {
"title": "beschrijft een gebiedsaanwijzing",
"minItems": 0,
"type": "array",
"description": "Bij een regel die een gebiedsaanwijzing vastlegt geeft deze relatie aan om welk gebied en type gebied het gaat. De bijbehorende locatie(s) waar het om gaat is/zijn bij de gebiedsaanwijzing zelf te vinden.",
"items": {
"$ref": "#/components/schemas/Gebiedsaanwijzing"
}
},
"isOpgenomenIn": {
"$ref": "#/components/schemas/Regeltekst"
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
}
},
"description": "De beschrijving van een regel met juridische werkingskracht. Een regel betreft binnen de Omgevingswet veelal activiteiten, en/of normen en/of functies en/of beperkingengebieden."
},
"Thema": {
"title": "Thema",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
},
"description": "Een limitatieve lijst met een opsomming van de mogelijke domeinwaarden van een attribuutsoort, die buiten het model in een externe waardenlijst worden beheerd. Locatie: urn:imow:Thema"
},
"Adressaat": {
"title": "Adressaat",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
},
"description": "Een lijst met een opsomming van de mogelijke domeinwaarden van een attribuutsoort, die buiten het model in een externe waardenlijst worden beheerd. Locatie: urn:imow:InstructieregelTaakuitoefening"
},
"Instrument": {
"title": "Instrument",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
},
"description": "Een lijst met een opsomming van de mogelijke domeinwaarden van een attribuutsoort, die buiten het model in een externe waardenlijst worden beheerd. Locatie: urn:imow:InstructieregelInstrument"
},
"Activiteitregelkwalificatie": {
"title": "Activiteitregelkwalificatie",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
},
"description": "Een lijst met een opsomming van de mogelijke domeinwaarden van een attribuutsoort, die buiten het model in een externe waardenlijst worden beheerd. Locatie: urn:imow:Activiteitregel"
},
"Idealisatie": {
"title": "Idealisatie",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
},
"description": "Een lijst met een opsomming van de mogelijke domeinwaarden van een attribuutsoort, die buiten het model in een externe waardenlijst worden beheerd. Locatie: urn:imow:Idealisatie"
},
"Norm": {
"title": "Norm",
"required": [
"_links",
"geregistreerdMet",
"identificatie",
"naam",
"normwaarde",
"type"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"naam": {
"title": "naam",
"type": "string"
},
"normwaarde": {
"title": "normwaarde",
"type": "array",
"description": "Één van de kwantitatieve of kwalitatieve waarden van een norm. ",
"items": {
"$ref": "#/components/schemas/Normwaarde"
}
},
"eenheid": {
"title": "eenheid",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Eenheid"
}
},
"type": {
"$ref": "#/components/schemas/Typenorm"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/NormLinks"
}
},
"description": "Een omgevingswaarde of een omgevingsnorm, met een normatief karakter, die beschreven worden middels normwaarden. Een normwaarde kan kwalitatief of kwantitatief zijn."
},
"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"
},
"status": {
"title": "status",
"type": "string",
"description": "De status van een object is een aanduiding waarmee aangegeven kan worden dat de OW-informatie, in deze versie van het object, niet meer geldig is. Dit geeft bijvoorbeeld aan of deze activiteit beeindigd ('B') is.",
"enum": [
"B",
"null"
]
}
},
"description": "Één van de kwantitatieve of kwalitatieve waarden van een norm. De normwaarde geeft aan wat de specifieke kwantitatieve of kwalitatieve eisen zijn, inclusief de toewijzing ervan aan de specifieke locatie(s) waar de normwaarde voor geldt. "
},
"OntwerpRegistratiegegevens": {
"title": "OntwerpRegistratiegegevens",
"required": [
"eindRegistratie",
"status",
"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 vanaf dit moment niet meer actief. Datumtijd in ISO 8601 formaat (yyyy-mm-dd'T'hh:mm:ss.SSSSSS).",
"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 (yyyy-mm-dd'T'hh:mm:ss.SSSSSS).",
"format": "date-time",
"example": "2022-04-12T23:20:50.52Z"
},
"status": {
"title": "status",
"type": "string",
"description": "De status van een object is een aanduiding waarmee aangegeven kan worden dat de OW-informatie, in deze versie van het object, niet meer geldig is. Dit geeft bijvoorbeeld aan of deze activiteit beeindigd ('B') is.",
"enum": [
"B",
"null"
]
}
},
"description": "Een beknopt informatie object dat de tijdslijnen en versie van een ontwerp object beschrijft"
},
"Normwaarde": {
"title": "Normwaarde",
"required": [
"_links",
"geregistreerdMet"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"kwalitatieveWaarde": {
"title": "kwalitatieveWaarde",
"minItems": 0,
"type": "string",
"description": "De toewijzing van een normerende waarde aan een locatie in de vorm van een beschrijving in woorden. De beschrijving geeft tekstueel de betekenis weer van de normwaarde."
},
"kwantitatieveWaarde": {
"title": "kwantitatieveWaarde",
"minItems": 0,
"type": "number",
"description": "De numerieke waarde van een norm. "
},
"waardeInRegeltekst": {
"title": "waardeInRegeltekst",
"minItems": 0,
"type": "string"
},
"_embedded": {
"title": "_embedded",
"type": "object",
"properties": {
"locaties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Locatie"
}
}
}
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/NormwaardeLinks"
}
},
"description": "Één van de kwantitatieve of kwalitatieve waarden van een norm. De normwaarde geeft aan wat de specifieke kwantitatieve of kwalitatieve eisen zijn, inclusief de toewijzing ervan aan de specifieke locatie(s) waar de normwaarde voor geldt."
},
"Omgevingsnorm": {
"title": "Omgevingsnorm",
"type": "object",
"description": "De in een meetbare waarde uit te drukken norm (anders dan een omgevingswaarde) die het bevoegd gezag op verschillende locaties verschillende waarden wil geven die het inzichtelijk wil weergeven.",
"allOf": [
{
"$ref": "#/components/schemas/Norm"
},
{
"required": [
"groep"
],
"properties": {
"groep": {
"$ref": "#/components/schemas/Omgevingsnormgroep"
},
"hoortBij": {
"title": "hoortBijRegeling",
"type": "array",
"description": "De regeling(en) waar deze omgevingsnorm op geannoteerd is. ",
"items": {
"$ref": "#/components/schemas/HoortBijRegeling"
}
},
"_embedded": {
"$ref": "#/components/schemas/embeddedLocaties"
}
}
}
]
},
"Omgevingswaarde": {
"title": "Omgevingswaarde",
"type": "object",
"description": "Norm die de gewenste staat of kwaliteit van (een onderdeel van) de fysieke leefomgeving, de toelaatbare belasting door activiteiten en/of de toelaatbare concentratie of depositie van stoffen als beleidsdoel vastlegt. ",
"allOf": [
{
"$ref": "#/components/schemas/Norm"
},
{
"required": [
"groep"
],
"properties": {
"groep": {
"$ref": "#/components/schemas/Omgevingswaardegroep"
},
"hoortBij": {
"title": "hoortBijRegeling",
"type": "array",
"description": "De regeling(en) waar deze omgevingswaarde op geannoteerd is. ",
"items": {
"$ref": "#/components/schemas/HoortBijRegeling"
}
},
"_embedded": {
"$ref": "#/components/schemas/embeddedLocaties"
}
}
}
]
},
"Activiteit": {
"title": "Activiteit",
"required": [
"_links",
"geregistreerdMet",
"groep",
"identificatie",
"naam"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"naam": {
"title": "naam",
"type": "string",
"description": "Een (korte) omschrijving van de activiteit."
},
"groep": {
"$ref": "#/components/schemas/Activiteitengroep"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
},
"hoortBij": {
"title": "hoortBijRegeling",
"type": "array",
"description": "De regeling(en) waar deze activiteit op geannoteerd is. ",
"items": {
"$ref": "#/components/schemas/HoortBijRegeling"
}
},
"_links": {
"$ref": "#/components/schemas/ActiviteitLinks"
},
"_embedded": {
"$ref": "#/components/schemas/embeddedLocaties"
}
},
"description": "Een activiteit is ieder menselijk handelen waarbij, of ieder menselijk nalaten waardoor een verandering of effect in de fysieke leefomgeving wordt of kan worden bewerkstelligd."
},
"Activiteitengroep": {
"title": "Activiteitengroep",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
},
"description": "Een uitbreidbare lijst met een opsomming van de mogelijke domeinwaarden van een attribuutsoort, die buiten het model in een externe waardenlijst worden beheerd. Locatie: urn:imow:Activiteitengroep"
},
"Eenheid": {
"title": "Eenheid",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
},
"description": "Een uitbreidbare lijst met een opsomming van de mogelijke domeinwaarden van een attribuutsoort, die buiten het model in een externe waardenlijst worden beheerd. Locatie: urn:imow:Eenheid"
},
"Typenorm": {
"title": "Typenorm",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
},
"description": "Een uitbreidbare lijst met een opsomming van de mogelijke domeinwaarden van een attribuutsoort, die buiten het model in een externe waardenlijst worden beheerd. Locatie: urn:imow:Activiteitengroep"
},
"Omgevingsnormgroep": {
"title": "Omgevingsnormgroep",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
},
"description": "Een uitbreidbare lijst met een opsomming van de mogelijke domeinwaarden van een attribuutsoort, die buiten het model in een externe waardenlijst worden beheerd. Locatie: urn:imow:Omgevingsnormgroep"
},
"Omgevingswaardegroep": {
"title": "Omgevingswaardegroep",
"required": [
"code",
"waarde"
],
"type": "object",
"properties": {
"code": {
"title": "code",
"type": "string"
},
"waarde": {
"title": "waarde",
"type": "string"
}
},
"description": "Een uitbreidbare lijst met een opsomming van de mogelijke domeinwaarden van een attribuutsoort, die buiten het model in een externe waardenlijst worden beheerd. Locatie: urn:imow:Omgevingswaardegroep"
},
"Hoofdlijn": {
"title": "Hoofdlijn",
"required": [
"_links",
"geregistreerdMet",
"identificatie",
"naam",
"soort"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"soort": {
"title": "soort",
"type": "string"
},
"naam": {
"title": "naam",
"type": "string"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/HoofdlijnLinks"
}
},
"description": "Element dat de hoofdlijn weergeeft van het beleid voor of de kwaliteit, ontwikkeling of staat van de fysieke leefomgeving dat of die in het Tekstdeel wordt beschreven."
},
"Tekstdeel": {
"title": "Tekstdeel",
"required": [
"_links",
"identificatie",
"omschrijving"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"idealisatie": {
"$ref": "#/components/schemas/Idealisatie"
},
"omschrijving": {
"title": "omschrijving",
"type": "string"
},
"thema": {
"title": "thema",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Thema"
}
},
"bevat": {
"title": "bevat",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Hoofdlijn"
}
},
"divisieannotatieverwijzing": {
"title": "divisieannotatieverwijzing",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Divisieannotatie"
}
},
"wijstGebiedAan": {
"title": "wijst gebied aan",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Gebiedsaanwijzing"
}
},
"benoemt": {
"title": "benoemt",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Kaart"
}
},
"definieert": {
"title": "definieert",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Locatie"
}
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
}
},
"description": "Tekstdeel is de kleinste zelfstandige eenheid van (een of meer) bij elkaar horende Juridische teksten in een tekst met Vrijetekststructuur, te weten een FormeleInhoud."
},
"Divisieannotatie": {
"title": "Divisieannotatie",
"required": [
"_links",
"geregistreerdMet",
"identificatie"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
},
"documentIdentificatie": {
"type": "string"
},
"juridischeGrondslagIdentificatie": {
"$ref": "#/components/schemas/JuridischeGrondslagIdentificaties"
},
"documentKruimelpad": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nummer": {
"type": "string"
},
"opschrift": {
"type": "string"
},
"identificatie": {
"type": "string"
}
}
}
},
"themas": {
"title": "thema",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Thema"
}
},
"_embedded": {
"$ref": "#/components/schemas/embeddedLocaties"
},
"_links": {
"$ref": "#/components/schemas/DivisieannotatieLinks"
}
},
"description": "Divisieannotatie kan een Divisie of een DivisieTekst zijn, zoals beschreven in CIMOW"
},
"LineStringSegment": {
"title": "GM_LineString",
"type": "string"
},
"Point": {
"title": "GeoJSON 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"
}
}
}
},
"MultiSurface": {
"$ref": "#/components/schemas/MultiPolygon"
},
"Surface": {
"$ref": "#/components/schemas/Polygon"
},
"OntwerpRegeling": {
"title": "OntwerpRegeling",
"required": [
"_links",
"aangeleverdDoorEen",
"geregistreerdMet",
"identificatie",
"officieleTitel",
"ontwerpbesluitIdentificatie",
"technischId",
"type"
],
"type": "object",
"properties": {
"identificatie": {
"title": "identificatie",
"type": "string",
"description": "De identificatie waaronder elk object van dit type bekend is."
},
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string",
"description": "De unieke ontwerpbesluitIdentificatie waaronder elk object van dit type bekend is."
},
"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."
},
"expressionId": {
"title": "expressionId",
"type": "string",
"description": "De unieke expressionId waaronder elk object van dit type bekend is."
},
"officieleTitel": {
"title": "officieleTitel",
"type": "string",
"description": "De volledige, officiële titel van een Omgevingsdocument zoals die door het bevoegd gezag is vastgesteld."
},
"aangeleverdDoorEen": {
"$ref": "#/components/schemas/BevoegdGezag"
},
"type": {
"$ref": "#/components/schemas/SoortRegeling"
},
"citeerTitel": {
"title": "citeerTitel",
"type": "string",
"description": "De titel van de Regeling zoals deze wordt gebruikt in aanhalingen."
},
"opschrift": {
"title": "opschrift",
"type": "string",
"description": "Het opschrift van de Regeling. Deze dient overeen te komen met de officiële titel van de Regeling."
},
"publicatieID": {
"title": "publicatieID",
"type": "string",
"description": "Verwijzing naar het besluit dat ten grondslag heeft gelegen aan het ontwerpbesluit."
},
"conditie": {
"title": "conditie",
"type": "string",
"description": "De verhouding is tussen dit tijdelijk deel en de hoofdregeling."
},
"opvolgerVan": {
"title": "opvolgerVan",
"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"
}
},
"heeftRegelingsgebied": {
"$ref": "#/components/schemas/Locatie"
},
"heeftOntwerpRegelingsgebied": {
"$ref": "#/components/schemas/OntwerpLocatie"
},
"procedureverloop": {
"$ref": "#/components/schemas/Procedureverloop"
},
"heeftBijlagen": {
"title": "heeftBijlagen",
"minItems": 1,
"type": "boolean"
},
"heeftToelichtingen": {
"title": "heeftToelichtingen",
"minItems": 1,
"type": "boolean"
},
"isVervangRegeling": {
"title": "isVervangRegeling",
"minItems": 1,
"type": "boolean"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"besluitMetadata": {
"$ref": "#/components/schemas/BesluitMetadata"
},
"_links": {
"$ref": "#/components/schemas/OntwerpRegelingLinks"
}
},
"description": "Een ontwerp tekst (met eventuele afbeeldingen en andere multimedia-elementen) die juridische voorschriften van algemene strekking of beleidsregels bevat."
},
"OntwerpDocumentComponent": {
"title": "OntwerpDocumentComponent",
"required": [
"_links",
"expressie",
"geregistreerdMet",
"identificatie",
"type",
"volgordeNummer"
],
"type": "object",
"properties": {
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string"
},
"documentTechnischId": {
"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."
},
"identificatie": {
"$ref": "#/components/schemas/WId"
},
"expressie": {
"$ref": "#/components/schemas/EId"
},
"type": {
"title": "type",
"type": "string"
},
"volgordeNummer": {
"title": "volgordeNummer",
"type": "integer"
},
"label": {
"title": "label",
"minItems": 0,
"type": "string"
},
"nummer": {
"title": "nummer",
"minItems": 0,
"type": "string"
},
"opschrift": {
"title": "opschrift",
"minItems": 0,
"type": "string"
},
"inhoud": {
"title": "inhoud",
"minItems": 0,
"type": "string"
},
"gereserveerd": {
"title": "gereserveerd",
"minItems": 0,
"type": "boolean"
},
"vervallen": {
"title": "vervallen",
"minItems": 0,
"type": "boolean"
},
"bevatOntwerpInformatie": {
"title": "bevatOntwerpInformatie",
"minItems": 0,
"type": "boolean"
},
"wijzigactie": {
"type": "string",
"enum": [
"voegtoe",
"verwijder",
"nieuweContainer",
"verwijderContainer"
]
},
"_embedded": {
"type": "object",
"properties": {
"ontwerpDocumentComponenten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpDocumentComponent"
}
}
}
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/OntwerpDocumentComponentLinks"
}
}
},
"OntwerpTekststructuurDocumentComponent": {
"title": "OntwerpTekststructuurDocumentComponent",
"required": [
"expressie",
"identificatie",
"type",
"volgordeNummer"
],
"type": "object",
"properties": {
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string"
},
"documentTechnischId": {
"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."
},
"identificatie": {
"$ref": "#/components/schemas/WId"
},
"ontwerpDivisieannotatieTechnischId": {
"title": "ontwerpDivisieannotatieTechnischId",
"type": "string"
},
"beeindigdeOntwerpDivisieannotatieTechnischId": {
"title": "beeindigdeOntwerpDivisieannotatieTechnischId",
"type": "string"
},
"ontwerpRegeltekstTechnischId": {
"title": "ontwerpRegeltekstTechnischId",
"type": "string"
},
"beeindigdeOntwerpRegeltekstTechnischId": {
"title": "beeindigdeOntwerpRegeltekstTechnischId",
"type": "string"
},
"divisieannotatieIdentificatie": {
"title": "divisieannotatieIdentificatie",
"type": "string"
},
"divisieIdentificatie": {
"title": "divisieIdentificatie",
"type": "string",
"deprecated": true
},
"regeltekstIdentificatie": {
"title": "regeltekstIdentificatie",
"type": "string"
},
"expressie": {
"$ref": "#/components/schemas/EId"
},
"type": {
"title": "type",
"type": "string"
},
"volgordeNummer": {
"title": "volgordeNummer",
"type": "integer"
},
"label": {
"title": "label",
"minItems": 0,
"type": "string",
"deprecated": true
},
"labelXml": {
"title": "label als XML",
"minItems": 0,
"type": "string"
},
"nummer": {
"title": "nummer",
"minItems": 0,
"type": "string",
"deprecated": true
},
"nummerXml": {
"title": "nummer als XML",
"minItems": 0,
"type": "string"
},
"opschrift": {
"title": "opschrift",
"minItems": 0,
"type": "string"
},
"inhoud": {
"title": "inhoud",
"minItems": 0,
"type": "string"
},
"gereserveerd": {
"title": "gereserveerd",
"minItems": 0,
"type": "boolean"
},
"vervallen": {
"title": "vervallen",
"minItems": 0,
"type": "boolean"
},
"bevatOntwerpInformatie": {
"title": "bevatOntwerpInformatie",
"minItems": 0,
"type": "boolean"
},
"wijzigactie": {
"type": "string",
"enum": [
"voegtoe",
"verwijder",
"nieuweContainer",
"verwijderContainer"
]
},
"_embedded": {
"type": "object",
"properties": {
"ontwerpTekststructuurDocumentComponenten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpTekststructuurDocumentComponent"
}
}
}
}
}
},
"OntwerpGebiedsaanwijzing": {
"title": "OntwerpGebiedsaanwijzing",
"required": [
"_links",
"gebiedsaanwijzingType",
"geregistreerdMet",
"identificatie",
"ontwerpbesluitIdentificatie",
"technischId"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string"
},
"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."
},
"gebiedsaanwijzingType": {
"title": "label",
"type": "string"
},
"naam": {
"title": "naam",
"type": "string",
"description": "Een (korte) naam van de gebiedsaanwijzing. "
},
"label": {
"title": "label",
"type": "string"
},
"status": {
"title": "status",
"type": "string",
"description": "Met deze status kan aangegeven aangegeven dat een OW-object beëindigd moet worden."
},
"groep": {
"$ref": "#/components/schemas/Gebiedsaanwijzinggroep"
},
"_embedded": {
"$ref": "#/components/schemas/embeddedOntwerpLocaties"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/OntwerpGebiedsaanwijzingLinks"
}
},
"description": "Type gebied aangewezen door een juridische regel."
},
"OntwerpKaart": {
"title": "OntwerpKaart",
"required": [
"_links",
"bevat",
"geregistreerdMet",
"identificatie",
"naam",
"ontwerpbesluitIdentificatie",
"technischId",
"uitsnede"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string"
},
"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."
},
"naam": {
"title": "naam",
"type": "string"
},
"nummer": {
"title": "nummer",
"type": "string"
},
"uitsnede": {
"$ref": "#/components/schemas/Kaartextent"
},
"bevat": {
"title": "bevat",
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpKaartlaag"
}
},
"status": {
"title": "status",
"type": "string",
"description": "Met deze status kan aangegeven aangegeven dat een OW-object beëindigd moet worden."
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
}
}
},
"OntwerpKaartlaag": {
"title": "OntwerpKaartlaag",
"required": [
"_links",
"identificatie",
"niveau"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"naam": {
"title": "naam",
"type": "string"
},
"niveau": {
"title": "niveau",
"type": "integer"
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
}
}
},
"OntwerpPons": {
"title": "OntwerpPons",
"required": [
"_links",
"geregistreerdMet",
"identificatie",
"ontwerpbesluitIdentificatie",
"technischId"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string"
},
"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."
},
"status": {
"title": "status",
"type": "string",
"description": "Met deze status kan aangegeven aangegeven dat een OW-object beëindigd moet worden."
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/OntwerpPonsLinks"
}
},
"description": "Duiding van een geografische positie."
},
"OntwerpInstructieregel": {
"title": "OntwerpInstructieregel",
"type": "object",
"description": "De naam van het instrument waartoe de instructieregel zich richt.",
"allOf": [
{
"$ref": "#/components/schemas/OntwerpJuridischeRegel"
},
{
"properties": {
"instructieregelInstrument": {
"title": "instructieregelInstrument",
"minItems": 0,
"type": "array",
"description": "Het type bestuursorgaan dat of organisatie die de taak waarover de instructieregel gaat moet uitvoeren.",
"items": {
"$ref": "#/components/schemas/Instrument"
}
},
"instructieregelTaakuitoefening": {
"title": "instructieregelTaakuitoefening",
"minItems": 0,
"type": "array",
"description": "Het type bestuursorgaan dat of organisatie die de taak waarover de instructieregel gaat moet uitvoeren.",
"items": {
"$ref": "#/components/schemas/Adressaat"
}
},
"beschrijftEenOmgevingsnorm": {
"title": "beschrijft een omgevingsnorm",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpOmgevingsnorm"
}
},
"beschrijftEenOmgevingsnormVastgesteld": {
"title": "beschrijft een omgevingsnorm",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Omgevingsnorm"
}
}
}
}
]
},
"OntwerpOmgevingswaarderegel": {
"title": "Omgevingswaarderegel",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/OntwerpJuridischeRegel"
},
{
"properties": {
"beschrijftEenOmgevingswaarde": {
"title": "beschrijft een ontwerp-omgevingswaarde",
"minItems": 0,
"type": "array",
"description": "Bij een regel die een omgevingswaarde vastlegt geeft deze relatie aan om welke norm het gaat. De bijbehorende locatie(s) waar het om gaat is/zijn bij de normwaardes van de norm zelf te vinden.",
"items": {
"$ref": "#/components/schemas/OntwerpOmgevingswaarde"
}
},
"beschrijftEenOmgevingswaardeVastgesteld": {
"title": "beschrijft een vastgestelde omgevingswaarde",
"minItems": 0,
"type": "array",
"description": "Bij een regel die een omgevingswaarde vastlegt geeft deze relatie aan om welke norm het gaat. De bijbehorende locatie(s) waar het om gaat is/zijn bij de normwaardes van de norm zelf te vinden.",
"items": {
"$ref": "#/components/schemas/Omgevingswaarde"
}
}
}
}
]
},
"OntwerpRegelVoorIedereen": {
"title": "Regel voor iedereen",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/OntwerpJuridischeRegel"
},
{
"properties": {
"normeertEenActiviteit": {
"title": "normeertEenActiviteit",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpActiviteitLocatieaanduiding"
}
},
"beschrijftEenOmgevingsnorm": {
"title": "beschrijft een ontwerp omgevingsnorm",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpOmgevingsnorm"
}
},
"beschrijftEenOmgevingsnormVastgesteld": {
"title": "beschrijft een vastgestelde omgevingsnorm",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Omgevingsnorm"
}
}
}
}
]
},
"OntwerpActiviteitLocatieaanduiding": {
"title": "OntwerpActiviteitLocatieaanduiding",
"required": [
"_links",
"activiteitregelkwalificatie",
"geregistreerdMet",
"identificatie"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"activiteitregelkwalificatie": {
"$ref": "#/components/schemas/Activiteitregelkwalificatie"
},
"betreftEenActiviteit": {
"$ref": "#/components/schemas/OntwerpActiviteit"
},
"betreftEenActiviteitVastgesteld": {
"$ref": "#/components/schemas/Activiteit"
},
"kwalificeert": {
"title": "kwalificeert",
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpLocatie"
}
},
"kwalificeertVastgesteld": {
"title": "kwalificeertVastgesteld",
"type": "array",
"items": {
"$ref": "#/components/schemas/Locatie"
}
},
"_embedded": {
"$ref": "#/components/schemas/embeddedOntwerpLocaties"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/OntwerpActiviteitlocatieaanduidingLinks"
}
}
},
"OntwerpRegeltekst": {
"title": "OntwerpRegeltekst",
"required": [
"_links",
"geregistreerdMet",
"identificatie"
],
"type": "object",
"properties": {
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string"
},
"technischId": {
"title": "technischId",
"type": "string",
"description": "TechnischId beschrijving"
},
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"thema": {
"title": "thema",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Thema"
}
},
"juridischeGrondslagIdentificatie": {
"$ref": "#/components/schemas/JuridischeGrondslagIdentificaties"
},
"typeJuridischeRegels": {
"$ref": "#/components/schemas/TypeJuridischeRegels"
},
"instructieregelInstrument": {
"title": "instructieregelInstrument",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Instrument"
}
},
"instructieregelTaakuitoefening": {
"title": "instructieregelTaakuitoefening",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Adressaat"
}
},
"documentKruimelpad": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nummer": {
"type": "string"
},
"opschrift": {
"type": "string"
},
"identificatie": {
"type": "string"
}
}
}
},
"_embedded": {
"$ref": "#/components/schemas/embeddedOntwerpLocaties"
},
"gerelateerd": {
"title": "gerelateerd",
"minItems": 0,
"type": "array",
"description": "Verwijzing dat aangeeft dat er een bijzondere relatie bestaat tussen twee Regelteksten.",
"items": {
"$ref": "#/components/schemas/OntwerpRegeltekst"
}
},
"gerelateerdVastgesteld": {
"title": "gerelateerdVastgesteld",
"minItems": 0,
"type": "array",
"description": "Verwijzing dat aangeeft dat er een bijzondere relatie bestaat tussen twee Regelteksten.",
"items": {
"$ref": "#/components/schemas/Regeltekst"
}
},
"status": {
"title": "status",
"type": "string",
"description": "Met deze status kan aangegeven aangegeven dat een OW-object beëindigd moet worden."
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/OntwerpRegeltekstLinks"
},
"documentTechnischId": {
"type": "string"
}
},
"description": "Een Regeltekst is de kleinste zelfstandige eenheid van (een of meer) bij elkaar behorende juridische regels. Deze regels horen onlosmakelijk bij elkaar en hebben gezamenlijk één werkingsgebied."
},
"OntwerpJuridischeRegel": {
"title": "Ontwerp Juridische regel",
"required": [
"_links",
"idealisatie",
"identificatie",
"isOpgenomenIn",
"omschrijving"
],
"type": "object",
"properties": {
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string"
},
"technischId": {
"title": "technischId",
"type": "string",
"description": "TechnischId beschrijving"
},
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"idealisatie": {
"$ref": "#/components/schemas/Idealisatie"
},
"omschrijving": {
"title": "omschrijving",
"type": "string",
"description": "Één doorlopend stuk juridische tekst, van een artikel of een lid, die omschrijvingen van (een of meer) juridische regels bevat. "
},
"thema": {
"title": "thema",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Thema"
}
},
"definieert": {
"title": "definieert",
"type": "array",
"description": "De locatieaanduiding begrenst de juridische werking van de regel in juridische zin, te weten dat de regel alleen binnen dit werkingsgebied werkingskracht heeft. ",
"items": {
"$ref": "#/components/schemas/OntwerpLocatie"
}
},
"definieertVastgesteld": {
"title": "definieertVastgesteld",
"type": "array",
"description": "De locatieaanduiding begrenst de juridische werking van de regel in juridische zin, te weten dat de regel alleen binnen dit werkingsgebied werkingskracht heeft. ",
"items": {
"$ref": "#/components/schemas/Locatie"
}
},
"bevat": {
"title": "bevat",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpKaart"
}
},
"bevatVastgesteld": {
"title": "bevat",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Kaart"
}
},
"beschrijftEenGebiedsaanwijzing": {
"title": "beschrijft een gebiedsaanwijzing",
"minItems": 0,
"type": "array",
"description": "Bij een regel die een gebiedsaanwijzing vastlegt geeft deze relatie aan om welk gebied en type gebied het gaat. De bijbehorende locatie(s) waar het om gaat is/zijn bij de gebiedsaanwijzing zelf te vinden.",
"items": {
"$ref": "#/components/schemas/OntwerpGebiedsaanwijzing"
}
},
"beschrijftEenGebiedsaanwijzingVastgesteld": {
"title": "beschrijft een gebiedsaanwijzing",
"minItems": 0,
"type": "array",
"description": "Bij een regel die een gebiedsaanwijzing vastlegt geeft deze relatie aan om welk gebied en type gebied het gaat. De bijbehorende locatie(s) waar het om gaat is/zijn bij de gebiedsaanwijzing zelf te vinden.",
"items": {
"$ref": "#/components/schemas/Gebiedsaanwijzing"
}
},
"isOpgenomenIn": {
"$ref": "#/components/schemas/OntwerpRegeltekst"
},
"isOpgenomenInVastgesteld": {
"$ref": "#/components/schemas/Regeltekst"
},
"status": {
"title": "status",
"type": "string",
"description": "Met deze status kan aangegeven aangegeven dat een OW-object beëindigd moet worden."
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
}
},
"description": "De beschrijving van een regel met juridische werkingskracht. Een regel betreft binnen de Omgevingswet veelal activiteiten, en/of normen en/of functies en/of beperkingengebieden."
},
"OntwerpNorm": {
"title": "OntwerpNorm",
"required": [
"_links",
"geregistreerdMet",
"identificatie",
"naam",
"normwaarde",
"type"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"naam": {
"title": "naam",
"type": "string"
},
"normwaarde": {
"title": "normwaarde",
"type": "array",
"description": "Één van de kwantitatieve of kwalitatieve waarden van een norm. ",
"items": {
"$ref": "#/components/schemas/OntwerpNormwaarde"
}
},
"eenheid": {
"title": "eenheid",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Eenheid"
}
},
"type": {
"$ref": "#/components/schemas/Typenorm"
},
"status": {
"title": "status",
"type": "string",
"description": "Met deze status kan aangegeven aangegeven dat een OW-object beëindigd moet worden."
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
}
},
"description": "Een omgevingswaarde of een omgevingsnorm, met een normatief karakter, die beschreven worden middels normwaarden. Een normwaarde kan kwalitatief of kwantitatief zijn."
},
"OntwerpNormwaarde": {
"title": "OntwerpNormwaarde",
"required": [
"_links",
"geregistreerdMet",
"identificatie"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"kwalitatieveWaarde": {
"title": "kwalitatieveWaarde",
"type": "string",
"description": "De toewijzing van een normerende waarde aan een locatie in de vorm van een beschrijving in woorden. De beschrijving geeft tekstueel de betekenis weer van de normwaarde."
},
"kwantitatieveWaarde": {
"title": "kwantitatieveWaarde",
"type": "number",
"description": "De numerieke waarde van een norm. "
},
"waardeInRegeltekst": {
"title": "waardeInRegeltekst",
"type": "string"
},
"geldtVoor": {
"title": "geldt voor",
"type": "array",
"description": "De specifieke locatie(s) waarvoor een specifieke normwaarde geldt.",
"items": {
"$ref": "#/components/schemas/OntwerpLocatie"
}
},
"geldtVoorVastgesteld": {
"title": "geldt voor",
"type": "array",
"description": "De specifieke locatie(s) waarvoor een specifieke normwaarde geldt.",
"items": {
"$ref": "#/components/schemas/Locatie"
}
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
}
},
"description": "Één van de kwantitatieve of kwalitatieve waarden van een norm. De normwaarde geeft aan wat de specifieke kwantitatieve of kwalitatieve eisen zijn, inclusief de toewijzing ervan aan de specifieke locatie(s) waar de normwaarde voor geldt. "
},
"OntwerpOmgevingsnorm": {
"title": "OntwerpOmgevingsnorm",
"type": "object",
"description": "De in een meetbare waarde uit te drukken norm (anders dan een omgevingswaarde) die het bevoegd gezag op verschillende locaties verschillende waarden wil geven die het inzichtelijk wil weergeven.",
"allOf": [
{
"$ref": "#/components/schemas/OntwerpNorm"
},
{
"required": [
"groep",
"ontwerpbesluitIdentificatie",
"technischId"
],
"properties": {
"technischId": {
"title": "technischId",
"type": "string",
"description": "TechnischId beschrijving"
},
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string",
"description": "ontwerpbesluitIdentificatie beschrijving"
},
"groep": {
"$ref": "#/components/schemas/Omgevingsnormgroep"
},
"_embedded": {
"$ref": "#/components/schemas/embeddedOntwerpLocaties"
}
}
}
]
},
"OntwerpOmgevingswaarde": {
"title": "OntwerpOmgevingswaarde",
"type": "object",
"description": "Norm die de gewenste staat of kwaliteit van (een onderdeel van) de fysieke leefomgeving, de toelaatbare belasting door activiteiten en/of de toelaatbare concentratie of depositie van stoffen als beleidsdoel vastlegt. ",
"allOf": [
{
"$ref": "#/components/schemas/OntwerpNorm"
},
{
"required": [
"groep"
],
"properties": {
"technischId": {
"title": "technischId",
"type": "string",
"description": "TechnischId beschrijving"
},
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string",
"description": "ontwerpbesluitIdentificatie beschrijving"
},
"groep": {
"$ref": "#/components/schemas/Omgevingswaardegroep"
},
"_embedded": {
"$ref": "#/components/schemas/embeddedOntwerpLocaties"
}
}
}
]
},
"OntwerpActiviteit": {
"title": "OntwerpActiviteit",
"required": [
"_links",
"geregistreerdMet",
"groep",
"identificatie",
"naam"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"naam": {
"title": "naam",
"type": "string",
"description": "Een (korte) omschrijving van de activiteit."
},
"groep": {
"$ref": "#/components/schemas/Activiteitengroep"
},
"technischId": {
"title": "technischId",
"type": "string",
"description": "TechnischId beschrijving"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"status": {
"title": "status",
"type": "string",
"description": "Deze status parameter is deprecated, U wordt verwezen naar het status veld in de registratiegegevens.",
"deprecated": true
},
"_links": {
"$ref": "#/components/schemas/OntwerpActiviteitLinks"
},
"_embedded": {
"$ref": "#/components/schemas/embeddedOntwerpLocaties"
}
},
"description": "Een activiteit is ieder menselijk handelen waarbij, of ieder menselijk nalaten waardoor een verandering of effect in de fysieke leefomgeving wordt of kan worden bewerkstelligd."
},
"OntwerpHoofdlijn": {
"title": "OntwerpHoofdlijn",
"required": [
"_links",
"geregistreerdMet",
"identificatie",
"naam",
"ontwerpbesluitIdentificatie",
"soort",
"technischId"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string"
},
"technischId": {
"title": "technischId",
"type": "string",
"description": "TechnischId beschrijving"
},
"soort": {
"title": "soort",
"type": "string"
},
"naam": {
"title": "naam",
"type": "string"
},
"status": {
"title": "status",
"type": "string",
"description": "Met deze status kan aangegeven aangegeven dat een OW-object beëindigd moet worden."
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/OntwerpHoofdlijnLinks"
}
},
"description": "Element dat de ontwerp hoofdlijn weergeeft van het beleid voor of de kwaliteit, ontwikkeling of staat van de fysieke leefomgeving dat of die in het Tekstdeel wordt beschreven."
},
"OntwerpLocatie": {
"title": "OntwerpLocatie",
"required": [
"geregistreerdMet",
"identificatie"
],
"type": "object",
"properties": {
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string"
},
"technischId": {
"title": "technischId",
"type": "string",
"description": "TechnischId beschrijving"
},
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"geometrieIdentificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"noemer": {
"title": "noemer",
"minItems": 0,
"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."
},
"omvat": {
"$ref": "#/components/schemas/OntwerpLocaties"
},
"omvatGeometrieIdentificaties": {
"$ref": "#/components/schemas/GeometrieIdentificaties"
},
"omvatVastgesteld": {
"$ref": "#/components/schemas/Locaties"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
},
"locatieType": {
"$ref": "#/components/schemas/LocatieType"
}
},
"description": "Duiding van een geografische positie. Indien er naar een locatie verwezen wordt vanuit een BevoegdGezag dan betreft dit een ambtsgebied."
},
"OntwerpLocatieMetBoundingBox": {
"title": "OntwerpLocatieMetBoundingBox",
"required": [
"_links",
"geregistreerdMet",
"identificatie",
"ontwerpbesluitIdentificatie",
"technischId"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string"
},
"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."
},
"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."
},
"omvat": {
"type": "array",
"description": "Een lijst van ontwerp locaties die deze locatie omvat.",
"items": {
"$ref": "#/components/schemas/OntwerpLocatieMetBoundingBox"
}
},
"omvatVastgesteld": {
"type": "array",
"description": "Een lijst van vastgestelde locaties die deze locatie omvat.",
"items": {
"$ref": "#/components/schemas/LocatieMetBoundingBox"
}
},
"boundingBox": {
"$ref": "#/components/schemas/BoundingBox"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/SelfLinks"
}
},
"description": "Ontwerp Locatie met de boundingbox van de geometrie die bij deze locatie behoort"
},
"OntwerpDivisieannotatie": {
"title": "OntwerpDivisieannotatie",
"required": [
"_links",
"geregistreerdMet",
"identificatie",
"technischId"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"ontwerpbesluitIdentificatie": {
"title": "ontwerpbesluitIdentificatie",
"type": "string"
},
"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."
},
"heeftWerkingIn": {
"title": "heeft werking in",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Locatie"
}
},
"themas": {
"title": "thema",
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/Thema"
}
},
"status": {
"title": "status",
"type": "string",
"description": "Met deze status kan aangegeven aangegeven dat een OW-object beëindigd moet worden."
},
"geregistreerdMet": {
"$ref": "#/components/schemas/OntwerpRegistratiegegevens"
},
"_links": {
"$ref": "#/components/schemas/OntwerpDivisieannotatieLinks"
},
"documentTechnischId": {
"type": "string"
},
"juridischeGrondslagIdentificatie": {
"$ref": "#/components/schemas/JuridischeGrondslagIdentificaties"
},
"documentKruimelpad": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nummer": {
"type": "string"
},
"opschrift": {
"type": "string"
},
"identificatie": {
"type": "string"
}
}
}
},
"_embedded": {
"$ref": "#/components/schemas/embeddedOntwerpLocaties"
}
},
"description": "OntwerpDivisieannotatie kan een Divisie of een DivisieTekst zijn, zoals beschreven in CIMOW"
},
"SelfLinks": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"ActiviteitLinks": {
"required": [
"gerelateerd",
"is",
"isGereguleerdVoor",
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"beschrevenIn": {
"$ref": "#/components/schemas/HalLink"
},
"isGereguleerdVoor": {
"$ref": "#/components/schemas/HalLink"
},
"is": {
"$ref": "#/components/schemas/HalLink"
},
"gerelateerd": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"NormLinks": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"beschrevenIn": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"GebiedsaanwijzingLinks": {
"required": [
"self",
"wijstAan"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"beschrevenIn": {
"$ref": "#/components/schemas/HalLink"
},
"wijstAan": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"DivisieannotatieLinks": {
"required": [
"isVrijetekstannotatieBij",
"omschrijving",
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"benoemtKaarten": {
"$ref": "#/components/schemas/HalLink"
},
"beschrijftGebiedsaanwijzingen": {
"$ref": "#/components/schemas/HalLink"
},
"bevat": {
"$ref": "#/components/schemas/HalLink"
},
"heeftWerkingIn": {
"$ref": "#/components/schemas/HalLink"
},
"isVrijetekstannotatieBij": {
"$ref": "#/components/schemas/HalLink"
},
"omschrijving": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"RegelingLinks": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"documentstructuur": {
"$ref": "#/components/schemas/HalLink"
},
"tekststructuur": {
"$ref": "#/components/schemas/HalLink"
},
"themas": {
"$ref": "#/components/schemas/HalLink"
},
"heeftRegelingsgebied": {
"$ref": "#/components/schemas/HalLink"
},
"opvolgerVan": {
"$ref": "#/components/schemas/HalLink"
},
"tijdelijkDeelVan": {
"$ref": "#/components/schemas/HalLink"
},
"heeftBeoogdeOpvolgers": {
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/HalLink"
}
}
}
},
"OmgevingsvergunningLinks": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"heeftVergunningsgebied": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"DocumentComponentLinks": {
"required": [
"isOnderdeelVan",
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"isOnderdeelVan": {
"$ref": "#/components/schemas/HalLink"
},
"valtOnder": {
"$ref": "#/components/schemas/HalLink"
},
"regeltekst": {
"$ref": "#/components/schemas/HalLink"
},
"divisieannotatie": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"RegeltekstLinks": {
"required": [
"heeftWerkingIn",
"isRegelstructuurannotatieBij",
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"heeftWerkingIn": {
"$ref": "#/components/schemas/HalLink"
},
"isRegelstructuurannotatieBij": {
"$ref": "#/components/schemas/IsRegelstructuurannotatieBijHalLink"
},
"beschrijftActiviteiten": {
"$ref": "#/components/schemas/HalLink"
},
"beschrijftOmgevingsnormen": {
"$ref": "#/components/schemas/HalLink"
},
"beschrijftOmgevingswaarden": {
"$ref": "#/components/schemas/HalLink"
},
"bevatKaarten": {
"$ref": "#/components/schemas/HalLink"
},
"beschrijftGebiedsaanwijzingen": {
"$ref": "#/components/schemas/HalLink"
},
"heeftWerkingInExact": {
"$ref": "#/components/schemas/HalLink"
},
"heeftWerkingInIndicatief": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"HoofdlijnLinks": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"relateert": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"ActiviteitLocatieaanduidingLinks": {
"required": [
"kwalificeert",
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"kwalificeert": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"NormwaardeLinks": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"geldtVoor": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"PonsLinks": {
"required": [
"bevat",
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"bevat": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"ActiviteitLocatieaanduidingen": {
"required": [
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"activiteitlocatieaanduidingen"
],
"type": "object",
"properties": {
"activiteitlocatieaanduidingen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActiviteitLocatieaanduiding"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
},
"description": "ActiviteitLocatieaanduidingen"
},
"Afbeelding": {
"type": "string",
"description": "Een afbeelding (PNG of JPG) uit een document.",
"format": "binary"
},
"DocumentregeltekstZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/DocumentregeltekstZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Documentregeltekst-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "document.type",
"zoekWaarden": [
"/join/id/stop/regelingtype_001"
]
},
{
"parameter": "locatie.identificatie",
"zoekWaarden": [
"nl.imow-mnre1034.gebied.Nederland"
]
}
]
}
},
"OntwerpDocumentregeltekstZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OntwerpDocumentregeltekstZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke OntwerpDocumentregeltekst-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "document.type",
"zoekWaarden": [
"/join/id/stop/regelingtype_001"
]
},
{
"parameter": "ontwerplocatie.technischId",
"zoekWaarden": [
"nl_imow_pv26_gebied_2020000000068_akn_nl_bill_pv26_2020_OVPU001RGL_20210916_141900"
]
}
]
}
},
"DocumentZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/DocumentZoekParameter"
}
}
},
"description": "Zoekobject voor Document-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "document.type",
"zoekWaarden": [
"/join/id/stop/regelingtype_006"
]
},
{
"parameter": "locatie.identificatie",
"zoekWaarden": [
"nl.imow-mnre1034.gebied.Nederland"
]
}
]
}
},
"DocumentvrijetekstZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/DocumentvrijetekstZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Documentvrijetekst-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "document.type",
"zoekWaarden": [
"/join/id/stop/regelingtype_006"
]
},
{
"parameter": "locatie.identificatie",
"zoekWaarden": [
"nl.imow-mnre1034.gebied.Nederland"
]
}
]
}
},
"OntwerpDocumentvrijetekstZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OntwerpDocumentvrijetekstZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Documentvrijetekst-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "document.type",
"zoekWaarden": [
"/join/id/stop/regelingtype_006"
]
},
{
"parameter": "locatie.identificatie",
"zoekWaarden": [
"nl.imow-mnre1034.gebied.Nederland"
]
}
]
}
},
"GeoJsonZoekobject": {
"required": [
"geometrie",
"spatialOperator"
],
"type": "object",
"properties": {
"geometrie": {
"$ref": "#/components/schemas/GeoJsonGeometry"
},
"spatialOperator": {
"type": "string",
"description": "De intersects operator zoals gedefinieerd in ISO 19125-1",
"enum": [
"intersects"
]
}
},
"description": "Zoekobject om te zoeken op geometrie."
},
"Activiteiten": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"activiteiten"
],
"type": "object",
"properties": {
"activiteiten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Activiteit"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"Ponsen": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ponsen"
],
"type": "object",
"properties": {
"ponsen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Pons"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"Kaarten": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"kaarten"
],
"type": "object",
"properties": {
"kaarten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Kaart"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"Hoofdlijnen": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"hoofdlijnen"
],
"type": "object",
"properties": {
"hoofdlijnen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Hoofdlijn"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"Omgevingswaarden": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"omgevingswaarden"
],
"type": "object",
"properties": {
"omgevingswaarden": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Omgevingswaarde"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"Omgevingsnormen": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"omgevingsnormen"
],
"type": "object",
"properties": {
"omgevingsnormen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Omgevingsnorm"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"OntwerpOmgevingsnormen": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ontwerpomgevingsnormen"
],
"type": "object",
"properties": {
"ontwerpomgevingsnormen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpOmgevingsnorm"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"OntwerpOmgevingswaarden": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ontwerpomgevingswaarden"
],
"type": "object",
"properties": {
"ontwerpomgevingswaarden": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpOmgevingswaarde"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"Regelingen": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"regelingen"
],
"type": "object",
"properties": {
"regelingen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Regeling"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"Voorkomens": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"voorkomens"
],
"type": "object",
"properties": {
"voorkomens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Regeling"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"Omgevingsvergunningen": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"omgevingsvergunningen"
],
"type": "object",
"properties": {
"omgevingsvergunningen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Omgevingsvergunning"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"Omgevingsdocumenten": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"omgevingsdocumenten"
],
"type": "object",
"properties": {
"omgevingsdocumenten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Omgevingsdocument"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"DocumentComponenten": {
"required": [
"_embedded"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"documentComponenten"
],
"type": "object",
"properties": {
"documentComponenten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentComponent"
}
}
}
}
}
},
"TekststructuurDocumentComponenten": {
"required": [
"_embedded"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"tekststructuurDocumentComponenten"
],
"type": "object",
"properties": {
"tekststructuurDocumentComponenten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TekststructuurDocumentComponent"
}
}
}
}
}
},
"Regelteksten": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"regelteksten"
],
"type": "object",
"properties": {
"regelteksten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Regeltekst"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"Divisieannotaties": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"divisieannotaties"
],
"type": "object",
"properties": {
"divisieannotaties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Divisieannotatie"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"OntwerpDivisieannotaties": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ontwerpdivisieannotaties"
],
"type": "object",
"properties": {
"ontwerpdivisieannotaties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpDivisieannotatie"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"Gebiedsaanwijzingen": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"Gebiedsaanwijzingen"
],
"type": "object",
"properties": {
"gebiedsaanwijzingen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Gebiedsaanwijzing"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"OntwerpGebiedsaanwijzingen": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ontwerpGebiedsaanwijzingen"
],
"type": "object",
"properties": {
"ontwerpGebiedsaanwijzing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpGebiedsaanwijzing"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"PonsZoekobject": {
"required": [
"geo"
],
"type": "object",
"properties": {
"geo": {
"$ref": "#/components/schemas/GeoJsonZoekobject"
}
},
"description": "Zoekobject om de vastgestelde ponsgebieden op te halen die een intersectie met het zoekgebied hebben",
"example": {
"geo": {
"geometrie": {
"type": "Point",
"coordinates": [
139784,
442870
]
},
"spatialOperator": "intersects"
}
}
},
"RegeltekstZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/RegeltekstZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Regeltekst-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "documentIdentificatie",
"zoekWaarden": [
"/akn/nl/act/gm0037/2019/3520_example"
]
}
]
}
},
"OmgevingsvergunningZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OmgevingsvergunningZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Omgevingsvergunning-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "locatie.identificatie",
"zoekWaarden": [
"nl.imow-gm0297.gebied.201900001"
]
}
]
}
},
"OmgevingsvergunningZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"vergunning.typeBevoegdGezag",
"vergunning.bevoegdGezag",
"locatie.identificatie"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om Omgevingsvergunning te zoeken met een parameter."
},
"GebiedsaanwijzingZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/GebiedsaanwijzingZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Gebiedsaanwijzingen-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "locatie.identificatie",
"zoekWaarden": [
"nl.imow-mnre1034.gebied.Nederland"
]
}
]
}
},
"OntwerpGebiedsaanwijzingZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OntwerpGebiedsaanwijzingZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke OntwerpGebiedsaanwijzingen-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "locatie.identificatie",
"zoekWaarden": [
"nl.imow-mnre1034.gebied.Nederland"
]
}
]
}
},
"LocatieIdentificatieZoekobject": {
"required": [
"geo"
],
"type": "object",
"properties": {
"geo": {
"$ref": "#/components/schemas/GeoJsonZoekobject"
}
},
"description": "Zoekobject voor specifieke Locatie-bevragingen.",
"example": {
"geo": {
"geometrie": {
"type": "Point",
"coordinates": [
139784,
442870
]
},
"spatialOperator": "intersects"
}
}
},
"LocatieZoekObject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met LocatieZoekParameters.",
"items": {
"$ref": "#/components/schemas/LocatieZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Locatie bevragingen."
},
"OntwerpLocatieZoekObject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met OntwerpLocatieZoekParameters.",
"items": {
"$ref": "#/components/schemas/OntwerpLocatieZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke OntwerpLocatie bevragingen."
},
"DivisieannotatieZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/DivisieannotatieZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Divisieannotatie-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "locatie.identificatie",
"zoekWaarden": [
"nl.imow-mnre1034.gebied.Nederland"
]
}
]
}
},
"HoofdlijnZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/HoofdlijnZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Hoofdlijn-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "documentIdentificatie",
"zoekWaarden": [
"/akn/nl/act/gm0037/2019/3520_example"
]
}
]
}
},
"KaartZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/KaartZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Kaart-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "documentIdentificatie",
"zoekWaarden": [
"/akn/nl/act/gm0037/2019/3520_example"
]
}
]
}
},
"OntwerpKaartZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OntwerpKaartZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Kaart-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "ontwerpdocument.technischId",
"zoekWaarden": [
"_akn_nl_act_gm0037_2019_3520_example_ontwerpbesluit_example"
]
}
]
}
},
"ActiviteitLocatieaanduidingZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/ActiviteitLocatieaanduidingZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke ActiviteitLocatieaanduiding-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "activiteit.identificatie",
"zoekWaarden": [
"nl.imow-gm0297.activiteit.201900001-example"
]
}
]
}
},
"ActiviteitZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/ActiviteitZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Activiteit-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "regeltekst.type",
"zoekWaarden": [
"RegelVoorIedereen"
]
}
]
}
},
"OmgevingsnormZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OmgevingsnormZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Omgevingsnorm-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "locatie.identificatie",
"zoekWaarden": [
"nl.imow-gm0297.gebied.201900001"
]
}
]
}
},
"OntwerpOmgevingsnormZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OntwerpOmgevingsnormZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Omgevingsnorm-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "ontwerplocatie.technischId",
"zoekWaarden": [
"nl.imow-gm0297.gebied.201900001_akn_nl_act_gm0037_2019_3520_example"
]
}
]
}
},
"OmgevingswaardeZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OmgevingswaardeZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Omgevingswaarde-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "locatie.identificatie",
"zoekWaarden": [
"nl.imow-gm0297.gebied.201900001"
]
}
]
}
},
"OmgevingsnormZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"identificatie",
"regeltekst.type",
"regeltekst.identificatie",
"locatie.identificatie",
"juridischeregel.thema",
"tekstdeel.thema",
"document.identificatie",
"document.type",
"document.bestuurslaag",
"ontwerpdocument.technischId"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om Omgevingsnormen te zoeken met een parameter."
},
"OntwerpOmgevingsnormZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"technischId",
"ontwerpregeltekst.type",
"ontwerpregeltekst.technischId",
"ontwerplocatie.technischId",
"locatie.identificatie",
"ontwerpdocument.technischId",
"ontwerpdocument.type",
"ontwerpdocument.bestuurslaag",
"regeltekst.identificatie"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om Omgevingsnormen te zoeken met een parameter."
},
"OmgevingswaardeZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"identificatie",
"regeltekst.type",
"regeltekst.identificatie",
"locatie.identificatie",
"juridischeregel.thema",
"tekstdeel.thema",
"document.identificatie",
"document.type",
"document.bestuurslaag",
"ontwerpdocument.technischId"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om Omgevingswaarden te zoeken met een parameter."
},
"OntwerpOmgevingswaardeZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"technischId",
"ontwerpregeltekst.type",
"ontwerpregeltekst.technischId",
"ontwerplocatie.technischId",
"locatie.identificatie",
"ontwerpdocument.technischId",
"ontwerpdocument.type",
"ontwerpdocument.bestuurslaag",
"regeltekst.identificatie"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om OntwerpOmgevingswaarden te zoeken met een parameter."
},
"OntwerpOmgevingswaardeZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OntwerpOmgevingswaardeZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke OntwerpOmgevingswaarde-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "locatie.identificatie",
"zoekWaarden": [
"nl.imow-gm0297.gebied.201900001"
]
}
]
}
},
"GebiedsaanwijzingZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"identificatie",
"regeltekst.type",
"regeltekst.identificatie",
"locatie.identificatie",
"subType",
"juridischeregel.thema",
"tekstdeel.thema",
"document.identificatie",
"document.type",
"document.bestuurslaag",
"ontwerpdocument.technischId",
"divisieannotatie.identificatie"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"OntwerpGebiedsaanwijzingZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"technischId",
"ontwerpregeltekst.type",
"ontwerpregeltekst.technischId",
"locatie.identificatie",
"ontwerpLocatie.technischId",
"ontwerpdocument.technischId",
"ontwerpdocument.type",
"ontwerpdocument.bestuurslaag",
"regeltekst.identificatie",
"divisieannotatie.identificatie",
"ontwerpdivisieannotatie.technischId"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"RegeltekstZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"activiteit.identificatie",
"locatie.identificatie",
"gebiedsaanwijzing.identificatie",
"omgevingsnorm.identificatie",
"omgevingswaarde.identificatie",
"thema.code",
"regeltekst.type",
"instructieregelInstrument",
"instructieregelTaakuitoefening",
"documentIdentificatie",
"ontwerpdocument.technischId"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"DivisieannotatieZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"gebiedsaanwijzing.identificatie",
"thema.code",
"hoofdlijn.identificatie",
"locatie.identificatie",
"documentIdentificatie",
"ontwerpdocument.technischId"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"HoofdlijnZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"documentIdentificatie",
"ontwerpdocument.technischId"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"KaartZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"naam",
"nummer",
"documentIdentificatie"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"OntwerpKaartZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"naam",
"nummer",
"ontwerpdocument.technischId"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"ActiviteitLocatieaanduidingZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"activiteit.identificatie",
"regeltekst.identificatie",
"locatie.identificatie",
"juridischeregel.thema",
"document.identificatie",
"document.type",
"document.bestuurslaag",
"ontwerpdocument.technischId"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om ActiviteitLocatieaanduidingen te zoeken met een parameter."
},
"ActiviteitZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"identificatie",
"regeltekst.type",
"locatie.identificatie",
"locatie.type",
"juridischeregel.thema",
"document.identificatie",
"document.type",
"document.bestuurslaag",
"ontwerpdocument.technischId"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om Activiteiten te zoeken met een parameter."
},
"DocumentregeltekstZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"activiteit.identificatie",
"gebiedsaanwijzing.identificatie",
"locatie.identificatie",
"omgevingsnorm.identificatie",
"omgevingswaarde.identificatie",
"thema.code",
"regeltekst.type",
"document.type",
"document.typeBevoegdGezag",
"document.bevoegdGezag",
"instructieregelInstrument",
"instructieregelTaakuitoefening"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"OntwerpDocumentregeltekstZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"activiteit.identificatie",
"gebiedsaanwijzing.identificatie",
"locatie.identificatie",
"ontwerplocatie.technischId",
"omgevingsnorm.identificatie",
"omgevingswaarde.identificatie",
"thema.code",
"ontwerpregeltekst.type",
"document.type",
"document.bevoegdGezag",
"document.typeBevoegdGezag",
"document.identificatie",
"instructieregelInstrument",
"instructieregelTaakuitoefening"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"DocumentZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"gebiedsaanwijzing.identificatie",
"locatie.identificatie",
"hoofdlijn.identificatie",
"thema.code",
"document.type",
"document.typeBevoegdGezag",
"document.bevoegdGezag",
"instructieregelInstrument",
"regeltekst.type",
"omgevingswaarde.identificatie",
"omgevingsnorm.identificatie",
"activiteit.identificatie"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"DocumentvrijetekstZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"gebiedsaanwijzing.identificatie",
"locatie.identificatie",
"hoofdlijn.identificatie",
"thema.code",
"document.type",
"document.typeBevoegdGezag",
"document.bevoegdGezag"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"OntwerpDocumentvrijetekstZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"gebiedsaanwijzing.identificatie",
"locatie.identificatie",
"hoofdlijn.identificatie",
"thema.code",
"document.type",
"ontwerpdocument.technischId",
"ontwerpgebiedsaanwijzing.technischId",
"ontwerplocatie.technischId",
"ontwerphoofdlijn.technischId",
"document.typeBevoegdGezag",
"document.bevoegdGezag",
"document.identificatie"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"IsRegelstructuurannotatieBijHalLink": {
"allOf": [
{
"$ref": "#/components/schemas/HalLink"
},
{
"description": "Het (CIMOW) attribuut 'omschrijving' kan gevonden worden via de hallink naar het documentcomponent van isRegelstructuurannotatieBij."
}
]
},
"LocatieZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"document.identificatie",
"ontwerpdocument.technischId",
"locatie.identificatie"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om Locaties te zoeken met een parameter."
},
"OntwerpLocatieZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"ontwerpdocument.technischId",
"ontwerplocatie.technischId"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om OntwerpLocaties te zoeken met een parameter."
},
"HalLink": {
"required": [
"href"
],
"type": "object",
"properties": {
"href": {
"$ref": "#/components/schemas/Href"
}
},
"description": "HAL link."
},
"Health": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"UP",
"DOWN"
]
}
},
"description": "Health"
},
"Info": {
"required": [
"app"
],
"type": "object",
"properties": {
"app": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"description": {
"type": "string"
},
"stopVersion": {
"type": "string"
},
"cimowVersion": {
"type": "string"
},
"imopVersion": {
"type": "string"
}
}
}
},
"description": "Info"
},
"Locaties": {
"type": "object",
"properties": {
"_embedded": {
"required": [
"locaties"
],
"type": "object",
"properties": {
"locaties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Locatie"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
},
"description": "Locaties"
},
"GeometrieIdentificaties": {
"type": "array",
"description": "Identificaties van de geometrieen",
"items": {
"$ref": "#/components/schemas/Identificatie"
}
},
"RegelingIdentificatie": {
"title": "RegelingIdentificatie",
"type": "object",
"properties": {
"_embedded": {
"required": [
"identificatie",
"voorkomens"
],
"type": "object",
"properties": {
"regelingidentificaties": {
"type": "array",
"items": {
"type": "string"
}
},
"voorkomens": {
"$ref": "#/components/schemas/HalLink"
}
}
}
}
},
"LocatieZoekgebieden": {
"type": "object",
"properties": {
"_embedded": {
"required": [
"locaties"
],
"type": "object",
"properties": {
"locatieidentificaties": {
"type": "array",
"items": {
"type": "string"
}
},
"omgevingsplanPons": {
"type": "boolean",
"description": "Als omgevingsplanPons true is, valt het zoekgebied geheel binnen één of meerdere vastgestelde ponsen. \\\nDe zoekgeometrie valt binnen de pons(en) als alle punten van de zoekgeometrie een intersectie hebben \\ \nmet het binnenste of de rand van de pons(en), i.e. covers uit het DE-9IM.\n"
}
}
}
},
"description": "LocatieZoekgebieden"
},
"LocatieZoekgebiedenToekomstig": {
"type": "object",
"properties": {
"_embedded": {
"required": [
"locaties"
],
"type": "object",
"properties": {
"locatieidentificaties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"description": "LocatieZoekgebieden een lijst van locatie identificaties"
},
"OmgevingsplanPons": {
"type": "object",
"properties": {
"afgedektDoorPonsen": {
"type": "boolean"
}
},
"description": "OmgevingsplanPons"
},
"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": 0
}
},
"description": "Info voor paginering"
},
"Problem400": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Absolute URI dat het probleemtype identificeert.\n",
"format": "uri"
},
"title": {
"type": "string",
"description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.\n",
"example": "Bad request"
},
"status": {
"maximum": 600,
"exclusiveMaximum": true,
"minimum": 100,
"type": "integer",
"description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.\n",
"format": "int32",
"example": 400
},
"detail": {
"type": "string",
"description": "Mens-leesbare uitleg van dit specifieke probleem.\n",
"example": "De server kan het verzoek niet verwerken vanwege een clientside fout"
},
"instance": {
"type": "string",
"description": "Absolute URI dat dit specifieke probleem identificeert.\n",
"format": "uri"
}
},
"description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)."
},
"Problem404": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Absolute URI dat het probleemtype identificeert.\n",
"format": "uri"
},
"title": {
"type": "string",
"description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.\n",
"example": "Not found"
},
"status": {
"maximum": 600,
"exclusiveMaximum": true,
"minimum": 100,
"type": "integer",
"description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.\n",
"format": "int32",
"example": 404
},
"detail": {
"type": "string",
"description": "Mens-leesbare uitleg van dit specifieke probleem.\n",
"example": "De opgevraagde resource kan niet worden gevonden"
},
"instance": {
"type": "string",
"description": "Absolute URI dat dit specifieke probleem identificeert.\n",
"format": "uri"
}
},
"description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)."
},
"Problem406": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Absolute URI dat het probleemtype identificeert.\n",
"format": "uri"
},
"title": {
"type": "string",
"description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.\n",
"example": "Not Acceptable"
},
"status": {
"maximum": 600,
"exclusiveMaximum": true,
"minimum": 100,
"type": "integer",
"description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.\n",
"format": "int32",
"example": 406
},
"detail": {
"type": "string",
"description": "Mens-leesbare uitleg van dit specifieke probleem.\n",
"example": "De opgevraagde representatie is niet beschikbaar"
},
"instance": {
"type": "string",
"description": "Absolute URI dat dit specifieke probleem identificeert.\n",
"format": "uri"
}
},
"description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)."
},
"Problem412": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Absolute URI dat het probleemtype identificeert.\n",
"format": "uri"
},
"title": {
"type": "string",
"description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.\n",
"example": "Precondition failed"
},
"status": {
"maximum": 600,
"exclusiveMaximum": true,
"minimum": 100,
"type": "integer",
"description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.\n",
"format": "int32",
"example": 412
},
"detail": {
"type": "string",
"description": "Mens-leesbare uitleg van dit specifieke probleem.\n",
"example": "Het verzoek kan niet worden afgehandeld omdat een header ontbreekt"
},
"instance": {
"type": "string",
"description": "Absolute URI dat dit specifieke probleem identificeert.\n",
"format": "uri"
}
},
"description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)."
},
"Problem422": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Absolute URI dat het probleemtype identificeert.\n",
"format": "uri"
},
"title": {
"type": "string",
"description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.\n",
"example": "Unprocessable Content"
},
"status": {
"maximum": 600,
"exclusiveMaximum": true,
"minimum": 100,
"type": "integer",
"description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.\n",
"format": "int32",
"example": 422
},
"detail": {
"type": "string",
"description": "Mens-leesbare uitleg van dit specifieke probleem.\n",
"example": "De server kan het verzoek niet verwerken vanwege een contentfout"
},
"instance": {
"type": "string",
"description": "Absolute URI dat dit specifieke probleem identificeert.\n",
"format": "uri"
}
},
"description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)."
},
"Problem": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Absolute URI dat het probleemtype identificeert.\n",
"format": "uri"
},
"title": {
"type": "string",
"description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.\n"
},
"status": {
"maximum": 600,
"exclusiveMaximum": true,
"minimum": 100,
"type": "integer",
"description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.\n",
"format": "int32",
"example": 500
},
"detail": {
"type": "string",
"description": "Mens-leesbare uitleg van dit specifieke probleem.\n",
"example": "Interne server fout"
},
"instance": {
"type": "string",
"description": "Absolute URI dat dit specifieke probleem identificeert.\n",
"format": "uri"
}
},
"description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)."
},
"GeoJsonGeometry": {
"title": "GeoJSON 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"
}
]
},
"GeometryCollection": {
"title": "GeoJSON 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"
}
]
}
}
}
},
"Curve": {
"$ref": "#/components/schemas/LineString"
},
"Polygon": {
"title": "GeoJSON 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"
}
}
}
},
"MultiPolygon": {
"title": "GeoJSON 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"
}
}
}
},
"LineString": {
"title": "GeoJSON 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"
}
}
}
},
"MultiPoint": {
"title": "GeoJSON 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": "GeoJSON 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"
}
}
}
},
"Themas": {
"type": "array",
"description": "Een lijst van themas",
"items": {
"$ref": "#/components/schemas/Thema"
}
},
"BoundingBox": {
"required": [
"maxx",
"maxy",
"minx",
"miny"
],
"type": "object",
"properties": {
"minx": {
"multipleOf": 0.001,
"type": "number"
},
"maxx": {
"multipleOf": 0.001,
"type": "number"
},
"miny": {
"multipleOf": 0.001,
"type": "number"
},
"maxy": {
"multipleOf": 0.001,
"type": "number"
}
},
"description": "De boundingbox van de bij de locatie behorende geometrie"
},
"LocatieMetBoundingBox": {
"title": "LocatieMetBoundingBox",
"required": [
"geregistreerdMet",
"identificatie"
],
"type": "object",
"properties": {
"identificatie": {
"$ref": "#/components/schemas/Identificatie"
},
"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"
},
"omvat": {
"type": "array",
"description": "Een lijst van locaties die deze locatie omvat.",
"items": {
"$ref": "#/components/schemas/LocatieMetBoundingBox"
}
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
}
},
"description": "Locatie met de boundingbox van de geometrie die bij deze locatie behoort"
},
"JuridischeGrondslagIdentificaties": {
"type": "array",
"description": "Een lijst van verwijzingen naar regelteksten, oftewel artikelen en/of leden, die juridische regels bevatten over de deze activiteit. De verwijzing is in deze de identificatie van een regeltekst, in de vorm van een AKN identificatie. Het gaat om alle regels in de tijd (verleden heden, toekomst). Desgewenst kunnen tijdreisparameters aangegeven worden, om een extra filter aan te brengen.",
"items": {
"type": "string"
}
},
"Omschrijving": {
"title": "Omschrijving",
"type": "string",
"description": "De tekst behorende bij een Regeltekst of Divisie, als HTML"
},
"OntwerpRegelingLinks": {
"required": [
"documentstructuur",
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"documentstructuur": {
"$ref": "#/components/schemas/HalLink"
},
"tekststructuur": {
"$ref": "#/components/schemas/HalLink"
},
"heeftRegelingsgebied": {
"$ref": "#/components/schemas/HalLink"
},
"heeftOntwerpRegelingsgebied": {
"$ref": "#/components/schemas/HalLink"
},
"themas": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"OntwerpActiviteitlocatieaanduidingLinks": {
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"kwalificeert": {
"$ref": "#/components/schemas/HalLink"
},
"kwalificeertVastgesteld": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"OntwerpRegelingen": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ontwerpRegelingen"
],
"type": "object",
"properties": {
"ontwerpRegelingen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpRegeling"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"OntwerpDocumentComponenten": {
"required": [
"_embedded"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ontwerpDocumentComponenten"
],
"type": "object",
"properties": {
"ontwerpDocumentComponenten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpDocumentComponent"
}
}
}
}
}
},
"OntwerpTekststructuurDocumentComponenten": {
"required": [
"_embedded"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ontwerpTekststructuurDocumentComponenten"
],
"type": "object",
"properties": {
"ontwerpTekststructuurDocumentComponenten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpTekststructuurDocumentComponent"
}
}
}
}
}
},
"OntwerpPonsen": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ontwerpponsen"
],
"type": "object",
"properties": {
"ontwerpponsen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpPons"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"OntwerpKaarten": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ontwerpkaarten"
],
"type": "object",
"properties": {
"ontwerpkaarten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpKaart"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"OntwerpRegelteksten": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ontwerpRegelteksten"
],
"type": "object",
"properties": {
"ontwerpRegelteksten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpRegeltekst"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"OntwerpLocaties": {
"required": [
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ontwerpLocaties"
],
"type": "object",
"properties": {
"ontwerpLocaties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpLocatie"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
},
"description": "OntwerpLocaties"
},
"OntwerpLocatieZoekgebieden": {
"type": "object",
"properties": {
"_embedded": {
"required": [
"technischIds"
],
"type": "object",
"properties": {
"technischIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"description": "Ontwerp LocatieZoekgebieden"
},
"Procedureverloop": {
"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/Procedurestap"
}
}
},
"description": "De procedure die doorlopen is door deze ontwerpregeling."
},
"TypeJuridischeRegels": {
"title": "typeJuridischeRegels",
"type": "string",
"enum": [
"regel voor iedereen",
"instructieregel",
"omgevingswaarderegel"
]
},
"Procedurestap": {
"title": "Procedurestap",
"type": "object",
"properties": {
"soortStap": {
"$ref": "#/components/schemas/SoortStap"
},
"actor": {
"title": "actor",
"type": "string",
"description": "De uitvoerder van de stap."
},
"voltooidOp": {
"title": "voltooidOp",
"type": "string",
"description": "De datum waarop het voltooid is."
}
},
"description": ""
},
"SoortStap": {
"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)."
},
"LocatieType": {
"type": "string",
"enum": [
"Gebied",
"Lijn",
"Punt",
"Gebiedengroep",
"Lijnengroep",
"Puntengroep",
"Ambtsgebied"
]
},
"OntwerpRegeltekstZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OntwerpRegeltekstZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Regeltekst-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "ontwerpregeltekst.type",
"zoekWaarden": [
"RegelVoorIedereen"
]
}
]
}
},
"OntwerpRegeltekstZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"activiteit.identificatie",
"locatie.identificatie",
"gebiedsaanwijzing.identificatie",
"omgevingsnorm.identificatie",
"omgevingswaarde.identificatie",
"thema.code",
"instructieregelInstrument",
"instructieregelTaakuitoefening",
"ontwerpactiviteit.technischId",
"ontwerplocatie.technischId",
"ontwerpgebiedsaanwijzing.technischId",
"ontwerpomgevingsnorm.technischId",
"ontwerpomgevingswaarde.technischId",
"ontwerpregeltekst.type",
"ontwerpdocument.technischId"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"OntwerpActiviteiten": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ontwerpActiviteiten"
],
"type": "object",
"properties": {
"ontwerpActiviteiten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpActiviteit"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"OntwerpActiviteitLocatieaanduidingen": {
"required": [
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"activiteitlocatieaanduidingen"
],
"type": "object",
"properties": {
"activiteitlocatieaanduidingen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpActiviteitLocatieaanduiding"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
},
"description": "ActiviteitLocatieaanduidingen"
},
"OntwerpActiviteitZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OntwerpActiviteitZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke Activiteit-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "ontwerpregeltekst.type",
"zoekWaarden": [
"RegelVoorIedereen"
]
}
]
}
},
"OntwerpActiviteitZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"technischId",
"ontwerpregeltekst.type",
"ontwerplocatie.technischId",
"locatie.type",
"ontwerplocatie.type",
"ontwerpdocument.technischId",
"ontwerpdocument.type",
"ontwerpdocument.bestuurslaag",
"regeltekst.identificatie"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om Activiteiten te zoeken met een parameter."
},
"OntwerpActiviteitLocatieaanduidingZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OntwerpActiviteitLocatieaanduidingZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke ActiviteitLocatieaanduiding-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "ontwerpactiviteit.technischId",
"zoekWaarden": [
"nl.imow-gm0297.activiteit.201900001-example"
]
}
]
}
},
"OntwerpActiviteitLocatieaanduidingZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"ontwerpactiviteit.technischId",
"ontwerpregeltekst.technischId",
"ontwerplocatie.technischId",
"ontwerpdocument.technischId",
"ontwerpdocument.type",
"ontwerpdocument.bestuurslaag",
"regeltekst.identificatie"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om ActiviteitLocatieaanduidingen te zoeken met een parameter."
},
"OntwerpHoofdlijnen": {
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_embedded": {
"required": [
"ontwerphoofdlijnen"
],
"type": "object",
"properties": {
"ontwerphoofdlijnen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpHoofdlijn"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/HalPaginationLinks"
},
"page": {
"$ref": "#/components/schemas/Page"
}
}
},
"OntwerpHoofdlijnZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OntwerpHoofdlijnZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke OntwerpHoofdlijn-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "documentIdentificatie",
"zoekWaarden": [
"/akn/nl/act/gm0037/2019/3520_example"
]
}
]
}
},
"OntwerpHoofdlijnZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"ontwerpdocument.technischId"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"OntwerpDivisieannotatieZoekobject": {
"type": "object",
"properties": {
"zoekParameters": {
"type": "array",
"description": "Lijst met ZoekParameters.",
"items": {
"$ref": "#/components/schemas/OntwerpDivisieannotatieZoekParameter"
}
}
},
"description": "Zoekobject voor specifieke ontwerp Divisieannotatie-bevragingen.",
"example": {
"zoekParameters": [
{
"parameter": "locatie.identificatie",
"zoekWaarden": [
"nl.imow-mnre1034.gebied.Nederland"
]
}
]
}
},
"OntwerpDivisieannotatieZoekParameter": {
"required": [
"parameter",
"zoekWaarden"
],
"type": "object",
"properties": {
"parameter": {
"type": "string",
"enum": [
"thema.code",
"ontwerpdocument.technischId",
"gebiedsaanwijzing.identificatie",
"hoofdlijn.identificatie",
"locatie.identificatie",
"ontwerpgebiedsaanwijzing.technischId",
"ontwerphoofdlijn.technischId",
"ontwerplocatie.technischId"
]
},
"zoekWaarden": {
"type": "array",
"description": "Waarden waarop gezocht moet worden voor de betreffende parameter",
"items": {
"type": "string"
}
}
},
"description": "Zoekobject om te zoeken met een parameter."
},
"RegelingSuggestie": {
"type": "object",
"properties": {
"citeerTitel": {
"title": "citeerTitel",
"type": "string",
"description": "De titel van de Regeling zoals deze wordt gebruikt in aanhalingen.",
"example": "Omgevingswet"
},
"officieleTitel": {
"title": "officieleTitel",
"type": "string",
"description": "De volledige, officiële titel van een Regeling zoals die door het bevoegd gezag is vastgesteld.",
"example": "Omgevingswet"
},
"identificatie": {
"title": "identificatie",
"type": "string",
"description": "De identificatie waaronder elk object van dit type bekend is.",
"example": "/akn/nl/act/mnre1034/2020/regOW01"
},
"bevoegdGezag": {
"title": "bevoegd gezag",
"type": "string",
"description": "Het bevoegd gezag dat een bepaald omgevingsdocument aanlevert.",
"example": "mnre1034"
},
"type": {
"title": "type",
"type": "string",
"description": "Het type Regeling dat aangeleverd wordt.",
"example": "/join/id/stop/regelingtype_001"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
}
},
"description": "Een enkele suggestie"
},
"RegelingSuggestieCollectie": {
"required": [
"_embedded"
],
"type": "object",
"properties": {
"_embedded": {
"type": "object",
"properties": {
"suggesties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RegelingSuggestie"
}
}
}
}
}
},
"OmgevingsvergunningSuggestie": {
"type": "object",
"properties": {
"citeerTitel": {
"title": "citeerTitel",
"type": "string",
"description": "De titel van de Regeling zoals deze wordt gebruikt in aanhalingen. citeerTitel is deprecated. In de volgende version ipv citeerTitel officieleTitel gebruikt zou moeten worden",
"example": "Omgevingswet",
"deprecated": true
},
"officieleTitel": {
"title": "officieleTitel",
"type": "string",
"description": "De volledige, officiële titel van een Omgevingsvergunning zoals die door het bevoegd gezag is vastgesteld."
},
"identificatie": {
"title": "identificatie",
"type": "string",
"description": "De identificatie waaronder elk object van dit type bekend is.",
"example": "/akn/nl/act/mnre1034/2020/regOW01"
},
"bevoegdGezag": {
"title": "bevoegd gezag",
"type": "string",
"description": "Het bevoegd gezag dat een bepaald omgevingsdocument aanlevert.",
"example": "mnre1034"
},
"type": {
"title": "type",
"type": "string",
"description": "Het type Regeling dat aangeleverd wordt.",
"example": "/join/id/stop/regelingtype_001"
},
"geregistreerdMet": {
"$ref": "#/components/schemas/Registratiegegevens"
}
},
"description": "Een enkele suggestie"
},
"OmgevingsvergunningSuggestieCollectie": {
"required": [
"_embedded"
],
"type": "object",
"properties": {
"_embedded": {
"type": "object",
"properties": {
"suggesties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OmgevingsvergunningSuggestie"
}
}
}
}
}
},
"OntwerpRegelingSuggestie": {
"type": "object",
"properties": {
"citeerTitel": {
"title": "citeerTitel",
"type": "string",
"description": "De titel van de OntwerpRegeling zoals deze wordt gebruikt in aanhalingen.",
"example": "Omgevingswet"
},
"officieleTitel": {
"title": "officieleTitel",
"type": "string",
"description": "De volledige, officiële titel van een OntwerpRegeling zoals die door het bevoegd gezag is vastgesteld.",
"example": "Omgevingswet"
},
"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."
},
"identificatie": {
"title": "identificatie",
"type": "string",
"description": "De identificatie waaronder elk object van dit type bekend is.",
"example": "/akn/nl/act/mnre1034/2020/regOW01"
},
"bevoegdGezag": {
"title": "bevoegd gezag",
"type": "string",
"description": "Het bevoegd gezag dat een bepaald omgevingsdocument aanlevert.",
"example": "mnre1034"
},
"type": {
"title": "type",
"type": "string",
"description": "Het type Regeling dat aangeleverd wordt.",
"example": "/join/id/stop/regelingtype_001"
},
"tijdstipRegistratie": {
"title": "tijdstipRegistratie",
"type": "string",
"description": "Moment vanaf wanneer deze versie bekend 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": "Moment vanaf wanneer er een nieuwere versie dan deze versie bekend 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 enkele suggestie"
},
"OntwerpRegelingSuggestieCollectie": {
"required": [
"_embedded"
],
"type": "object",
"properties": {
"_embedded": {
"type": "object",
"properties": {
"suggesties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OntwerpRegelingSuggestie"
}
}
}
}
}
},
"HalCollectionLinks": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"$ref": "#/components/schemas/Href"
}
},
"description": "uri van de api aanroep die tot dit resultaat heeft geleid"
}
}
},
"HalPaginationLinks": {
"allOf": [
{
"$ref": "#/components/schemas/HalCollectionLinks"
},
{
"type": "object",
"properties": {
"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"
},
"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"
},
"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"
},
"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"
}
}
}
]
},
"Href": {
"type": "string",
"format": "uri",
"example": "datapunt.voorbeeldgemeente.nl/api/resourcename/123456789"
},
"OntwerpDivisieannotatieLinks": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"bevat": {
"$ref": "#/components/schemas/HalLink"
},
"heeftWerkingInVastgesteld": {
"$ref": "#/components/schemas/HalLink"
},
"isVrijetekstannotatieBij": {
"$ref": "#/components/schemas/HalLink"
},
"benoemtKaarten": {
"$ref": "#/components/schemas/HalLink"
},
"beschrijftGebiedsaanwijzingen": {
"$ref": "#/components/schemas/HalLink"
},
"heeftWerkingIn": {
"$ref": "#/components/schemas/HalLink"
},
"benoemtKaartenVastgesteld": {
"$ref": "#/components/schemas/HalLink"
},
"beschrijftGebiedsaanwijzingenVastgesteld": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"OntwerpDocumentComponentLinks": {
"required": [
"isOnderdeelVan",
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"ontwerpdivisieannotatie": {
"$ref": "#/components/schemas/HalLink"
},
"ontwerpregeltekst": {
"$ref": "#/components/schemas/HalLink"
},
"beeindigdeontwerpdivisieannotatie": {
"$ref": "#/components/schemas/HalLink"
},
"beeindigdeontwerpregeltekst": {
"$ref": "#/components/schemas/HalLink"
},
"divisieannotatie": {
"$ref": "#/components/schemas/HalLink"
},
"regeltekst": {
"$ref": "#/components/schemas/HalLink"
},
"isOnderdeelVan": {
"$ref": "#/components/schemas/HalLink"
},
"valtOnder": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"OntwerpGebiedsaanwijzingLinks": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"wijstAan": {
"$ref": "#/components/schemas/HalLink"
},
"wijstAanVastgesteld": {
"$ref": "#/components/schemas/HalLink"
},
"beschrevenIn": {
"$ref": "#/components/schemas/HalLink"
},
"aangewezenDoor": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"OntwerpRegeltekstLinks": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"beschrijftActiviteiten": {
"$ref": "#/components/schemas/HalLink"
},
"beschrijftOmgevingsnormen": {
"$ref": "#/components/schemas/HalLink"
},
"beschrijftOmgevingswaarden": {
"$ref": "#/components/schemas/HalLink"
},
"bevatKaarten": {
"$ref": "#/components/schemas/HalLink"
},
"beschrijftGebiedsaanwijzingen": {
"$ref": "#/components/schemas/HalLink"
},
"heeftWerkingIn": {
"$ref": "#/components/schemas/HalLink"
},
"isRegelstructuurannotatieBij": {
"$ref": "#/components/schemas/IsRegelstructuurannotatieBijHalLink"
},
"beschrijftActiviteitenVastgesteld": {
"$ref": "#/components/schemas/HalLink"
},
"beschrijftOmgevingsnormenVastgesteld": {
"$ref": "#/components/schemas/HalLink"
},
"beschrijftOmgevingswaardenVastgesteld": {
"$ref": "#/components/schemas/HalLink"
},
"bevatKaartenVastgesteld": {
"$ref": "#/components/schemas/HalLink"
},
"beschrijftGebiedsaanwijzingenVastgesteld": {
"$ref": "#/components/schemas/HalLink"
},
"heeftWerkingInVastgesteld": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"OntwerpHoofdlijnLinks": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"relateertVastgesteld": {
"$ref": "#/components/schemas/HalLink"
},
"relateert": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"OntwerpPonsLinks": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"bevat": {
"$ref": "#/components/schemas/HalLink"
},
"bevatVastgesteld": {
"$ref": "#/components/schemas/HalLink"
}
}
},
"OntwerpActiviteitLinks": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/HalLink"
},
"beschrevenIn": {
"$ref": "#/components/schemas/HalLink"
},
"isGereguleerdVoor": {
"$ref": "#/components/schemas/HalLink"
},
"is": {
"$ref": "#/components/schemas/HalLink"
},
"gerelateerd": {
"$ref": "#/components/schemas/HalLink"
},
"isGereguleerdVoorVastgesteld": {
"$ref": "#/components/schemas/HalLink"
},
"isVastgesteld": {
"$ref": "#/components/schemas/HalLink"
},
"gerelateerdVastgesteld": {
"$ref": "#/components/schemas/HalLink"
},
"beoogdeOpvolgerVan": {
"$ref": "#/components/schemas/HalLink"
}
},
"description": "