{ "components": { "schemas": { "StatusFilterEnum": { "type": "string", "enum": [ "actief", "beeindigd" ], "default": "actief", "example": "actief" }, "HealthResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AppHealthStatus" } }, "required": [ "status" ] }, "AppHealthResponse": { "type": "object", "properties": { "app-health": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AppHealthStatus" } }, "title": "AppHealth", "required": [ "status" ] } }, "title": "AppHealthResponse", "required": [ "app-health" ] }, "AppHealthStatus": { "type": "string", "enum": [ "UP", "DOWN" ] }, "Info": { "type": "object", "properties": { "app-info": { "type": "object", "properties": { "name": { "type": "string", "description": "Mens-leesbare naam van deze API." }, "version": { "type": "string", "description": "De versie van deze API zoals te lezen in de API spec en overeenkomende met de API-Version response header" }, "description": { "type": "string", "description": "Mens-leesbare beschrijving van deze API" }, "stopVersion": { "type": "string", "description": "Versie van de STOP/TPOD standaard waar deze API zich aan houdt" }, "cimowVersion": { "type": "string", "description": "Versie van het CIMOW informatiemodel waar deze API zich aan houdt" }, "imowVersion": { "type": "string", "description": "versie van het IMOW informatiemodel waar deze API zich aan houdt" } } } }, "required": [ "app-info" ], "description": "Informatie over deze API, bijvoorbeeld de versie van de API en de versie van de gebruikte standaarden" }, "Locatie": { "type": "object", "properties": { "identificatie": { "$ref": "#/components/schemas/Identificatie" }, "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" }, "noemer": { "type": "string", "title": "noemer" }, "status": { "type": "string", "enum": [ "B", null ], "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.\n" }, "geometrieIdentificatie": { "type": "string", "title": "Identificatie van de geometrie", "example": "4b46ca74-3840-4ce1-91b6-abf749802f6c" }, "boundingBox": { "$ref": "#/components/schemas/BoundingBox" }, "_embedded": { "type": "object", "properties": { "omvat": { "type": "array", "items": { "$ref": "#/components/schemas/Locatie" }, "description": "Locaties binnen locate groep" } } }, "_links": { "$ref": "#/components/schemas/HalCollectionLinks" } }, "title": "Locatie", "required": [ "_links", "geregistreerdMet", "identificatie" ] }, "LocatieMetSpatialOperator": { "type": "object", "properties": { "identificatie": { "$ref": "#/components/schemas/Identificatie" }, "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" }, "noemer": { "type": "string", "title": "noemer" }, "spatialOperator": { "$ref": "#/components/schemas/SpatialRelation" }, "_links": { "$ref": "#/components/schemas/HalCollectionLinks" } }, "title": "Locatie", "required": [ "_links", "geregistreerdMet", "identificatie" ] }, "SpatialRelation": { "type": "string", "enum": [ "intersects", "within" ], "description": "Een metagegeven dat aangeeft wat de relatie is tussen het opgegeven zoekgebied (de geometrie in het request van de API) en de gevonden Locaties, zoals geredeneerd vanuit de Locatie (de resource in de response van de API)." }, "PrimaireLocatie": { "type": "object", "properties": { "identificatie": { "$ref": "#/components/schemas/Identificatie" }, "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" }, "noemer": { "type": "string", "title": "noemer" }, "spatialOperator": { "$ref": "#/components/schemas/SpatialRelation" }, "_links": { "$ref": "#/components/schemas/HalCollectionLinks" } }, "title": "PrimaireLocatie", "required": [ "_links", "geregistreerdMet", "identificatie" ] }, "ActiviteitLocatie": { "type": "object", "properties": { "identificatie": { "$ref": "#/components/schemas/Identificatie" }, "geregistreerdMet": { "$ref": "#/components/schemas/Registratiegegevens" }, "juridischeRegelIdentificatie": { "$ref": "#/components/schemas/Identificatie" } }, "title": "Locatie", "required": [ "geregistreerdMet", "identificatie", "juridischeRegelIdentificatie" ], "description": "De Locatie van de ActiviteitVersie, afgeleid via de ActiviteitLocatieaanduiding van de Juridische Regel. De tijdslijnen opgenomen in deze relatie zijn de tijdslijnen van de Juridische Regel, voorzover deze binnen de tijdslijnen van deze ActiviteitVersie vallen.\n" }, "GeaggregeerdeLocatieInfo": { "type": "object", "properties": { "identificatie": { "$ref": "#/components/schemas/Identificatie" }, "geregistreerdMet": { "$ref": "#/components/schemas/ActiviteitRegistratiegegevensVanLocatie" } }, "title": "GeaggregeerdeLocatieInfo", "required": [ "geregistreerdMet", "identificatie" ], "description": "De Locatie van de ActiviteitVersie, afgeleid via de ActiviteitLocatieaanduiding van de Juridische Regel. De tijdslijnen opgenomen in deze relatie zijn de tijdslijnen van de Juridische Regel, voorzover deze binnen de tijdslijnen van deze ActiviteitVersie vallen.\n" }, "ActiviteitMetGeaggregeerdeLocatieInfo": { "type": "object", "properties": { "identificatie": { "$ref": "#/components/schemas/Identificatie" }, "naam": { "type": "string", "example": "Vellen van een houtopstand" }, "groep": { "type": "object", "properties": { "code": { "type": "string" }, "waarde": { "type": "string" } }, "required": [ "code", "waarde" ] }, "oin": { "type": "string", "description": "Extra gegeven (niet van een activiteit). Het OrganisatieIdentificatieNummer van het bevoegd gezag van deze activiteit op het moment van opvragen. Het OIN is ongeversioneerd, en Ozon garandeert niet dat dit juist is op het moment van opvragen.\n", "example": "00000001807288111000", "deprecated": true }, "bevoegdGezag": { "$ref": "#/components/schemas/BevoegdGezag" }, "is": { "$ref": "#/components/schemas/Identificatie" }, "gerelateerd": { "type": "array", "items": { "$ref": "#/components/schemas/Identificatie" } }, "_links": { "$ref": "#/components/schemas/ActiviteitHalCollectionLinks" }, "geregistreerdMet": { "$ref": "#/components/schemas/ActiviteitRegistratiegegevens" }, "laatsteWijzigingOp": { "type": "string", "format": "date", "example": "2020-05-08" }, "isGereguleerdVoor": { "type": "array", "items": { "$ref": "#/components/schemas/GeaggregeerdeLocatieInfo" }, "description": "Deze specifieke activiteit is gereguleerd voor deze specifieke locatie(s). Deze locaties zijn afgeleide gegevens, afgeleid van ActiviteitLocatieaanduidingen (zie CIMOW). Om de specifiek geldige versie van de locatie te verkrijgen kan een aparte (tijdreis)vraag gedaan worden op de locatie-resource.\n" } }, "title": "Activiteit met geaggregeerde locatie informatie", "required": [ "_links", "geregistreerdMet", "groep", "identificatie", "laatsteWijzigingOp", "naam" ], "description": "De versie van een Activiteit zoals bedoeld in CIMOW, met een minimum aan activiteit locaties in isGereguleerdVoor. Een versie is een voorkomen van de activiteit in een periode waarin deze ongewijzigd is gebleven.\n" }, "BevoegdGezag": { "type": "object", "properties": { "naam": { "type": "string", "title": "naam" }, "bestuurslaag": { "type": "string", "title": "bestuurslaag", "enum": [ "gemeente", "provincie", "waterschap", "ministerie" ] }, "code": { "type": "string", "title": "code", "description": "De code van het bevoegd gezag dat deze activiteit indiende, bestaand uit twee letters en twee tot en met vier cijfers.\n", "example": "pv24" } }, "required": [ "bestuurslaag", "code", "naam" ], "description": "Extra gegeven (niet van een activiteit). Dit wordt afgeleid van het omgevingsdocument ten tijde van muteren van de activiteit (geen rekening houdend met een bv. gemeentelijke herindeling).\n" }, "ActiviteitenMetGeaggregeerdeLocatieInfo": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "activiteiten": { "type": "array", "items": { "$ref": "#/components/schemas/ActiviteitMetGeaggregeerdeLocatieInfo" } } }, "required": [ "activiteiten" ] }, "_links": { "$ref": "#/components/schemas/HalPaginationLinks" }, "page": { "$ref": "#/components/schemas/Page" } }, "required": [ "_embedded", "_links", "page" ] }, "LocatiesMetSpatialOperator": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "locaties": { "type": "array", "items": { "$ref": "#/components/schemas/LocatieMetSpatialOperator" } } }, "required": [ "locaties" ] }, "_links": { "$ref": "#/components/schemas/HalPaginationLinks" }, "page": { "$ref": "#/components/schemas/Page" } }, "required": [ "_links", "page" ] }, "PrimaireLocaties": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "primairelocaties": { "type": "array", "items": { "$ref": "#/components/schemas/PrimaireLocatie" } } }, "required": [ "primairelocaties" ] }, "_links": { "$ref": "#/components/schemas/HalPaginationLinks" }, "page": { "$ref": "#/components/schemas/Page" } }, "required": [ "_links", "page" ] }, "GeometrieIdentificaties": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "geometrieIdentificaties": { "type": "array", "items": { "type": "string" } } }, "required": [ "geometrieIdentificaties" ] } }, "description": "Geometrie identificaties" }, "Registratiegegevens": { "type": "object", "properties": { "versie": { "type": "integer" }, "beginInwerking": { "type": "string", "format": "date", "example": "2020-05-08" }, "beginGeldigheid": { "type": "string", "format": "date", "example": "2020-05-05" }, "eindGeldigheid": { "type": "string", "format": "date", "example": "2020-07-05" }, "isPrimair": { "type": "boolean", "description": "Geeft aan of een locatie \"primair\" is, wat betekent dat er naar wordt verwezen door een OW-object anders dan Locatie zelf.\n", "example": true }, "tijdstipRegistratie": { "type": "string", "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{6}", "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 (yyyy-mm-dd'T'hh:mm:ss.SSSSSS).\n", "example": "2020-05-08T10:00:01.987654" }, "eindRegistratie": { "type": "string", "pattern": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{6}", "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 (yyyy-mm-dd'T'hh:mm:ss.SSSSSS).\n", "example": "2020-05-08T10:00:01.987654" }, "status": { "type": "string", "enum": [ "B", null ], "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.\n" }, "subType": { "type": "string", "title": "subType" } }, "title": "Registratiegegevens", "required": [ "beginGeldigheid", "beginInwerking", "tijdstipRegistratie" ], "description": "Een informatieobject dat de tijdslijnen en versie van een geversioneerd object beschrijft, conform NEN3610:2021, alsmede het veld 'beginInwerking', dat DSO-specifiek is. Voor locaties wordt hierbij de door Ozon afgeleide versionering aangehouden die rekening houdt met indirecte mutaties, zoals een gewijzigde samengestelde geometrie van een locatiegroep (vanwege wijzigingen in de geometrie van een onderliggend item) of wijzigingen in de primair/secundair status van een locatie.\n" }, "ActiviteitRegistratiegegevens": { "type": "object", "properties": { "versie": { "type": "integer", "example": 1 }, "status": { "type": "string", "enum": [ "B" ], "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. \nDit geeft bijvoorbeeld aan of deze activiteit beëindigd ('B') is. Het ontbreken van de status betekent dat de versie van het object niet is beëindigd.\n" }, "beginGeldigheid": { "type": "string", "format": "date", "example": "2020-05-05" }, "eindGeldigheid": { "type": "string", "format": "date", "example": "2020-07-05" } }, "title": "Minimum activiteit Registratiegegevens van activiteit", "required": [ "beginGeldigheid", "versie" ], "description": "De registratiegegevens bevatten de tijdslijnen van dit object conform NEN3610:2021.\n" }, "ActiviteitRegistratiegegevensVanLocatie": { "type": "object", "properties": { "beginGeldigheid": { "type": "string", "format": "date", "example": "2020-05-05" }, "eindGeldigheid": { "type": "string", "format": "date", "example": "2020-07-05" } }, "title": "Minimum activiteit Registratiegegevens van locatie", "required": [ "beginGeldigheid" ], "description": "De registratiegegevens bevatten de tijdslijnen van dit object conform NEN3610:2021.\n" }, "BoundingBox": { "type": "object", "properties": { "minX": { "type": "number", "multipleOf": 0.001 }, "maxX": { "type": "number", "multipleOf": 0.001 }, "minY": { "type": "number", "multipleOf": 0.001 }, "maxY": { "type": "number", "multipleOf": 0.001 } }, "required": [ "maxX", "maxY", "minX", "minY" ], "description": "De bounding box van de bij de locatie behorende geometrie. Indien de locatie een groep is, is de bounding box het resultaat van alle onderliggende bounding boxes gecombineerd." }, "Identificatie": { "type": "string", "title": "Identificatie", "description": "De unieke identificatie waaronder elk object van dit type bekend is." }, "Point": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "type": "array", "items": { "type": "number", "multipleOf": 0.001 }, "minItems": 2 }, "bbox": { "type": "array", "items": { "type": "number", "multipleOf": 0.001 }, "minItems": 4 } }, "title": "GeoJSON Point", "required": [ "coordinates", "type" ] }, "GeoJsonZoekobject": { "type": "object", "properties": { "geometrie": { "$ref": "#/components/schemas/GeoJsonGeometry" }, "spatialOperator": { "type": "string", "enum": [ "intersects", "interior-intersects" ], "description": "Een subset van de ruimtelijke operatoren zoals gedefinieerd in ISO 19125-1:\n\n- `intersects`: retourneert alle geometrieën die de zoekgeometrie snijden (inclusief overlap, volledig binnen de zoekgeometrie liggen en raken)\n- `interior-intersects`: retourneert alle geometrieën waarvan het binnengebied de zoekgeometrie snijdt (er is sprake van overlap of de geometrie ligt geheel of gedeeltelijk binnen de zoekgeometrie; situaties waarbij alleen de grenzen elkaar raken zijn uitgesloten)\n", "default": "intersects" } }, "description": "Zoekobject om te zoeken op geometrie." }, "JuridischeBron": { "type": "object", "properties": { "documentIdentificatie": { "type": "string", "description": "Een verwijzing naar de regeling waarin de juridische bron te vinden is. De verwijzing is in deze de identificatie van een omgevingsdocument (een zogenaamde AKN identificatie)", "example": "/akn/nl/act/gm0106/2019/reg456RGL-20201125-112022" }, "regelteksten": { "type": "array", "items": { "$ref": "#/components/schemas/Regeltekst" }, "description": "Een lijst van verwijzingen naar regelteksten waarin de eerste versie van de activiteit benoemt wordt. De verwijzing is in deze de identificatie van een regeltekst (een zogenaamde IMOW identificatie)." } }, "title": "Juridische bron", "required": [ "documentIdentificatie", "regelteksten" ], "description": "De juridische bron van een activiteit is altijd de regeling waar de definitie van de activiteit in is benoemd. De juridische bron kan als een begripsbepaling opgenomen zijn bij de begripsbepalingen of in de lopende tekst van een regeltekst." }, "Regelteksten": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "regelteksten": { "type": "array", "items": { "$ref": "#/components/schemas/Regeltekst" } } }, "required": [ "regelteksten" ] }, "_links": { "$ref": "#/components/schemas/HalPaginationLinks" }, "page": { "$ref": "#/components/schemas/Page" } }, "required": [ "_embedded", "_links", "page" ] }, "Regeltekst": { "type": "object", "properties": { "identificatie": { "$ref": "#/components/schemas/Identificatie" }, "wId": { "type": "string", "title": "wId", "description": "Het WorkID (conform FRBR) van het corresponderende artikel in IMOP" }, "omschrijving": { "type": "string", "title": "omschrijving", "description": "De letterlijke tekst waarmee de Regeltekst is omschreven, in een artikel of een lid. Een Regeltekst is altijd één doorlopend stuk juridische tekst, welke juridische regels bevat." }, "label": { "type": "string", "title": "label", "description": "Het label (bijvoorbeeld 'Artikel') van het bijbehorende documentcomponent.", "deprecated": true }, "nummer": { "type": "string", "title": "nummer", "description": "Het nummer (bijvoorbeeld '1.1') van het bijbehorende documentcomponent.", "deprecated": true }, "labelXml": { "type": "string", "title": "labelXml", "description": "Het label van het bijbehorende documentcomponent in xml formaat." }, "nummerXml": { "type": "string", "title": "nummerXml", "description": "Het nummer van het bijbehorende documentcomponent in xml formaat." }, "opschrift": { "type": "string", "title": "opschrift", "description": "Het opschrift van het bijbehorende documentcomponent." }, "documentIdentificatie": { "type": "string" }, "procedurestatus": { "$ref": "#/components/schemas/Procedurestatus" } }, "title": "Regeltekst", "required": [ "documentIdentificatie", "identificatie", "omschrijving", "procedurestatus", "wId" ], "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." }, "LocatieZoekobject": { "type": "object", "properties": { "geo": { "$ref": "#/components/schemas/GeoJsonZoekobject" }, "locatieIdentificaties": { "type": "array", "items": { "type": "string" } } }, "required": [ "geo" ], "description": "Zoekobject voor specifieke locatie-bevragingen. \nHet locatiezoekobject bevat ofwel 1. alleen een geo bestaande uit een geometrie en een spatialOperator, ofwel 2. een geo en een lijst locatie-identificaties.\n1. Wanneer het locatiezoekobject alleen GeoJSON bevat met de spatialOperator intersects, dan retourneert de zoekopdracht alle locaties die intersecten met de geometrie. Wanneer gevonden locaties daarnaast binnen het zoekgebied vallen, bevat de respons de spatialOperator 'within'. 2. Wanneer het locatiezoekobject zowel GeoJSON als locatie-identificaties bevat, dan retourneert de zoekopdracht alleen de locaties waarvan de identificatie voorkomt in de gegeven lijst met identificaties, die ook gevonden zijn op of binnen de gegeven geometrie.\n", "example": { "geo": { "geometrie": { "type": "Point", "coordinates": [ 188193, 503793 ] }, "spatialOperator": "intersects" }, "locatieIdentificaties": [ "nl.imow-gm0000.gebied.test" ] } }, "LocatieIdentificatiesEnGeoZoekobject": { "type": "object", "properties": { "geo": { "$ref": "#/components/schemas/GeoJsonZoekobject" }, "locatieIdentificaties": { "type": "array", "items": { "type": "string" } } }, "required": [ "geo", "locatieIdentificaties" ], "description": "Zoekobject voor bevragingen op basis van geometrieen en locatie identificaties. Resultaten moeten zich zowel binnen de gegeven geometrie bevinden, als overeenkomen met de één van de opgegeven locatie identificaties.\n", "example": { "geo": { "geometrie": { "type": "Point", "coordinates": [ 188193, 503793 ] }, "spatialOperator": "intersects" }, "locatieIdentificaties": [ "nl.imow-gm0000.gebied.test" ] } }, "LocatieIdentificatiesOfGeoZoekobject": { "type": "object", "properties": { "geo": { "$ref": "#/components/schemas/GeoJsonZoekobject" }, "locatieIdentificaties": { "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "description": "Zoekobject voor bevragingen op basis van geometrie of een of meerdere locatie identificaties. Requests die geen van beide of een geometrie én locatie identificaties bevatten worden afgekeurd.\n", "example": { "geo": { "geometrie": { "type": "Point", "coordinates": [ 188193, 503793 ] }, "spatialOperator": "intersects" }, "locatieIdentificaties": [ "nl.imow-gm0000.gebied.test" ] } }, "PrimaireLocatieZoekobject": { "type": "object", "properties": { "geo": { "$ref": "#/components/schemas/GeoJsonZoekobject" }, "locatieIdentificaties": { "type": "array", "items": { "type": "string" } } }, "required": [ "geo" ], "description": "Zoekobject voor primairelocatie-bevragingen ten behoeve van het bevragen van Vector Tiles. Het primaireLocatieZoekobject bevat alleen geo en een lijst van primaire locatie-identificaties. Wanneer met het PrimaireLocatieZoekobject wordt gezocht retourneert de zoekopdracht de locaties waarvan de identificatie voorkomt in de opgegeven lijst met identificaties, die ook gevonden zijn op of binnen de opgegeven geometrie.\n", "example": { "geo": { "geometrie": { "type": "Point", "coordinates": [ 188193, 503793 ] }, "spatialOperator": "intersects" }, "locatieIdentificaties": [ "nl.imow-gm0000.gebied.test" ] } }, "LocatieIdentificatieZoekobject": { "type": "object", "properties": { "geo": { "$ref": "#/components/schemas/GeoJsonZoekobject" } }, "required": [ "geo" ], "description": "Zoekobject voor specifieke Locatie-bevragingen.", "example": { "geo": { "geometrie": { "type": "Point", "coordinates": [ 139784, 442870 ] }, "spatialOperator": "intersects" } } }, "Procedurestatus": { "type": "string", "enum": [ "vastgesteld", "ontwerp" ], "description": "De status in de procedure; vastgesteld of ontwerp" }, "Page": { "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 } }, "required": [ "number", "size", "totalElements", "totalPages" ], "description": "Info voor paginering" }, "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" } } }, "ActiviteitHalCollectionLinks": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "$ref": "#/components/schemas/Href" } }, "description": "uri van de api aanroep die tot dit resultaat heeft geleid" }, "heeftJuridischeBron": { "type": "object", "properties": { "href": { "$ref": "#/components/schemas/Href" } }, "description": "uri voor het opvragen van de juridische bron" }, "heeftRegeltekst": { "type": "object", "properties": { "href": { "$ref": "#/components/schemas/Href" } }, "description": "uri voor het opvragen van de regeltekst" } } }, "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": "https://datapunt.voorbeeldgemeente.nl/api/resourcename/123456789" }, "Problem": { "type": "object", "properties": { "type": { "type": "string", "format": "uri", "description": "Absolute URI dat het probleemtype identificeert.", "default": "about:blank" }, "title": { "type": "string", "description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars." }, "status": { "exclusiveMaximum": true, "type": "integer", "maximum": 600, "minimum": 100, "format": "int32", "description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.", "example": 500 }, "detail": { "type": "string", "description": "Mens-leesbare uitleg van dit specifieke probleem.", "example": "Interne server fout" }, "instance": { "type": "string", "format": "uri", "description": "Absolute URI dat dit specifieke probleem identificeert." } }, "description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API''s (RFC 7807)." }, "Problem400": { "type": "object", "properties": { "type": { "type": "string", "format": "uri", "description": "Absolute URI dat het probleemtype identificeert.\n" }, "title": { "type": "string", "description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.\n", "example": "Bad request" }, "status": { "exclusiveMaximum": true, "type": "integer", "maximum": 600, "minimum": 100, "format": "int32", "description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.\n", "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", "format": "uri", "description": "Absolute URI dat dit specifieke probleem identificeert.\n" } }, "description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)." }, "Problem404": { "type": "object", "properties": { "type": { "type": "string", "format": "uri", "description": "Absolute URI dat het probleemtype identificeert.\n" }, "title": { "type": "string", "description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.\n", "example": "Not found" }, "status": { "exclusiveMaximum": true, "type": "integer", "maximum": 600, "minimum": 100, "format": "int32", "description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.\n", "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", "format": "uri", "description": "Absolute URI dat dit specifieke probleem identificeert.\n" } }, "description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)." }, "Problem406": { "type": "object", "properties": { "type": { "type": "string", "format": "uri", "description": "Absolute URI dat het probleemtype identificeert.\n" }, "title": { "type": "string", "description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.\n", "example": "Not Acceptable" }, "status": { "exclusiveMaximum": true, "type": "integer", "maximum": 600, "minimum": 100, "format": "int32", "description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.\n", "example": 406 }, "detail": { "type": "string", "description": "Mens-leesbare uitleg van dit specifieke probleem.\n", "example": "Acceptable representations: [application/hal+json, application/problem+json]." }, "instance": { "type": "string", "format": "uri", "description": "Absolute URI dat dit specifieke probleem identificeert.\n" } }, "description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)." }, "Problem412": { "type": "object", "properties": { "type": { "type": "string", "format": "uri", "description": "Absolute URI dat het probleemtype identificeert.\n" }, "title": { "type": "string", "description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.\n", "example": "Precondition failed" }, "status": { "exclusiveMaximum": true, "type": "integer", "maximum": 600, "minimum": 100, "format": "int32", "description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.\n", "example": 412 }, "detail": { "type": "string", "description": "Mens-leesbare uitleg van dit specifieke probleem.\n", "example": "Dit verzoek vereist een Content-CRS header." }, "instance": { "type": "string", "format": "uri", "description": "Absolute URI dat dit specifieke probleem identificeert.\n" } }, "description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)." }, "Problem422": { "type": "object", "properties": { "type": { "type": "string", "format": "uri", "description": "Absolute URI dat het probleemtype identificeert.\n" }, "title": { "type": "string", "description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.\n", "example": "Not found" }, "status": { "exclusiveMaximum": true, "type": "integer", "maximum": 600, "minimum": 100, "format": "int32", "description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.\n", "example": 422 }, "detail": { "type": "string", "description": "Mens-leesbare uitleg van dit specifieke probleem.\n", "example": "Het request kan niet worden verwerkt vanwege een invalide geometrie of foute CRS code." }, "instance": { "type": "string", "format": "uri", "description": "Absolute URI dat dit specifieke probleem identificeert.\n" } }, "description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)." }, "Problem500": { "type": "object", "properties": { "type": { "type": "string", "format": "uri", "description": "Absolute URI dat het probleemtype identificeert.\n" }, "title": { "type": "string", "description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.\n", "example": "Not found" }, "status": { "exclusiveMaximum": true, "type": "integer", "maximum": 600, "minimum": 100, "format": "int32", "description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.\n", "example": 500 }, "detail": { "type": "string", "description": "Mens-leesbare uitleg van dit specifieke probleem.\n", "example": "Er is een technische fout opgetreden" }, "instance": { "type": "string", "format": "uri", "description": "Absolute URI dat dit specifieke probleem identificeert.\n" } }, "description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)." }, "GeoJsonGeometry": { "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" } ], "title": "GeoJSON Geometry", "description": "Geometrie in GeoJSON formaat (RFC 7946).", "externalDocs": { "description": "RFC 7946 - The GeoJSON Format", "url": "https://tools.ietf.org/html/rfc7946" } }, "GeometryCollection": { "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" } ] } } }, "title": "GeoJSON GeometryCollection", "required": [ "geometries", "type" ] }, "Polygon": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Polygon" ] }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "multipleOf": 0.001 }, "minItems": 2 }, "minItems": 4 } }, "bbox": { "type": "array", "items": { "type": "number", "multipleOf": 0.001 }, "minItems": 4 } }, "title": "GeoJSON Polygon", "required": [ "coordinates", "type" ] }, "MultiPolygon": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MultiPolygon" ] }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "multipleOf": 0.001 }, "minItems": 2 }, "minItems": 4 } } }, "bbox": { "type": "array", "items": { "type": "number", "multipleOf": 0.001 }, "minItems": 4 } }, "title": "GeoJSON MultiPolygon", "required": [ "coordinates", "type" ] }, "LineString": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "LineString" ] }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "number", "multipleOf": 0.001 }, "minItems": 2 }, "minItems": 2 }, "bbox": { "type": "array", "items": { "type": "number", "multipleOf": 0.001 }, "minItems": 4 } }, "title": "GeoJSON LineString", "required": [ "coordinates", "type" ] }, "MultiPoint": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MultiPoint" ] }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "number", "multipleOf": 0.001 }, "minItems": 2 } }, "bbox": { "type": "array", "items": { "type": "number", "multipleOf": 0.001 }, "minItems": 4 } }, "title": "GeoJSON MultiPoint", "required": [ "coordinates", "type" ] }, "MultiLineString": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MultiLineString" ] }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "multipleOf": 0.001 }, "minItems": 2 }, "minItems": 2 } }, "bbox": { "type": "array", "items": { "type": "number", "multipleOf": 0.001 }, "minItems": 4 } }, "title": "GeoJSON MultiLineString", "required": [ "coordinates", "type" ] }, "LocatieZoekgebieden": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "locatieidentificaties": { "type": "array", "items": { "type": "string" } } }, "required": [ "locaties" ] } }, "description": "LocatieZoekgebieden" } }, "responses": { "NotFound": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem404" } } } }, "BadRequest": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem400" } } } }, "NotAcceptable": { "description": "Not acceptable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem406" } } } }, "PreconditionFailed": { "description": "Precondition failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem412" } } } }, "Unprocessable": { "description": "Unprocessable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem422" } } } }, "ServerError": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem500" } } } } }, "parameters": { "geldigOp": { "name": "geldigOp", "in": "query", "description": "Een tijdreisparameter langs de geldigheids-tijdsas. Deze tijdreis toont de versie van het object die op de opgegeven datum materieel geldig is. Wanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'. Een gecombineerde tijdreisvraag langs 'geldigOp' en 'inWerkingOp' geeft de versie van het object die op de opgegeven datum juridisch geldig is. De tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-09" } }, "inWerkingOp": { "name": "inWerkingOp", "in": "query", "description": "Een tijdreisparameter langs de juridische-werking-tijdsas. Deze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. Wanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'. Een gecombineerde tijdreisvraag langs 'geldigOp' en 'inWerkingOp' geeft de versie van het object die op de opgegeven datum juridisch geldig is. De tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2020-05-08" } }, "beschikbaarOp": { "name": "beschikbaarOp", "in": "query", "description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. Deze tijdreis toont de versie van het object die beschikbaar is op de opgegeven datumtijd in de Europe/Amsterdam tijdszone. Wanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'nu', d.w.z. de huidige datumtijd in de Europe/Amsterdam tijdszone. De tijdreisparameter wordt doorgegeven aan onderliggende hal-links.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time", "example": "2022-07-07T11:34:01Z" } }, "synchroniseerMetTileset": { "name": "synchroniseerMetTileset", "in": "query", "description": "Voer een tijdreis uit langs de beschikbaarheids-as naar het moment dat de huidige tileset aangevraagd werd. Hiermee garandeer je dat de data die je opvraagt correspondeert met het kaartbeeld dat in de huidige tileset weergegeven wordt. Er kan een tijdreis uitgevoerd worden naar het moment van aanvragen van een van beide tilesets:\n - normaal: tijdreis naar het aanvraagmoment van de tileset bij de actueel geldige gegevens; wanneer geen tijdreis gedaan wordt langs de geldigheids- of beschikbaarheidsas dien je 'normaal' te gebruiken;\n - volledig: tijdreis naar het aanvraagmoment van de tileset bij alle gegevens, ook historische, toekomstige, en niet meer geldige gegevens; wanneer een tijdreis gedaan wordt langs de geldigheids- of beschikbaarheidsas dien je 'volledig' te gebruiken.\nCombineren van deze parameter met een expliciete tijdreis langs de beschikbaarOp tijdsas is niet mogelijk. Wanneer beide parameters meegegeven worden, dan krijgt de expliciete beschikbaarOp-parameter voorrang boven deze parameter.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "enum": [ "normaal", "volledig" ] } }, "ContentCrsHeader": { "name": "Content-Crs", "in": "header", "description": "Content-Crs", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "EPSG:28992" ], "default": "EPSG:28992", "example": "EPSG:28992" } }, "Page": { "name": "page", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "minimum": 0, "format": "int32", "example": 0 } }, "Size": { "name": "size", "in": "query", "description": "De pagesize moet minimaal een waarde van 1 hebben en maximaal een waarde van 200.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "format": "int32", "default": 20, "example": 20 } }, "Sort": { "name": "sort", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "desc" } }, "StatusFilter": { "name": "status", "in": "query", "description": "Geef aan om actieve, beëindigde of alle activiteitversies te ontvangen, bij geen keuze (null) wordt de standaardselectie 'actief' gehanteerd.\n", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StatusFilterEnum" } } } }, "examples": { "locatieZoekobjectVoorbeeld": { "summary": "Zoekobject voor locatie", "value": { "geo": { "geometrie": { "type": "Point", "coordinates": [ 188193, 503793 ] }, "spatialOperator": "intersects" }, "locatieIdentificaties": [ "nl.imow-gm0000.gebied.test" ] } }, "primaireLocatieZoekobjectVoorbeeld": { "summary": "Zoekobject voor primairelocatie", "value": { "geo": { "geometrie": { "type": "Polygon", "coordinates": [ [ [ 136859, 423253 ], [ 136880, 423811 ], [ 138214, 423627 ], [ 138186, 423627 ], [ 136859, 423253 ] ] ] } }, "locatieIdentificaties": [ "nl.imow-gm0000.gebied.test", "nl.imow-gm0000.gebiedengroep.test" ] } }, "locatieIdentificatiesEnGeoZoekobjectVoorbeeld": { "summary": "Zoekobject voor zoeken op combinatie van geometrie en locatie identificaties", "value": { "geo": { "geometrie": { "type": "Polygon", "coordinates": [ [ [ 136859, 423253 ], [ 136880, 423811 ], [ 138214, 423627 ], [ 138186, 423627 ], [ 136859, 423253 ] ] ] } }, "locatieIdentificaties": [ "nl.imow-gm0000.gebied.test", "nl.imow-gm0000.gebiedengroep.test" ] } }, "activiteitIdentificatieZoekVoorbeeld": { "summary": "Zoekobject voor activiteitIdentificatie", "value": { "spatialOperator": "intersects", "geometrie": { "type": "Polygon", "coordinates": [ [ [ 120581.444, 487991.742 ], [ 121745.144, 487991.742 ], [ 121745.144, 489095.64 ], [ 120581.444, 489095.64 ], [ 120581.444, 487991.742 ] ] ] } } } }, "headers": { "X-Total-Count": { "description": "Totaal aantal objecten.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "X-Pagination-Count": { "description": "Totaal aantal pagina's.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 3 }, "example": 3 }, "X-Pagination-Page": { "description": "Huidige pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 1 }, "example": 1 }, "X-Pagination-Limit": { "description": "Objecten per pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 3 }, "example": 3 }, "API-Version": { "description": "De versie van de API", "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.0" }, "example": "1.0.0" } } }, "info": { "title": "Omgevingsdocumenten Toepasbaar", "description": "De Omgevingsdocumenten Toepasbaar API ontsluit juridische activiteiten in onderlinge samenhang, aangevuld met bijbehorende informatie zoals locaties. Dit ten behoeve van gebruik voor in het bijzonder Toepasbare Regels (DSO-LV) en de functionele structuur. Deze samenhang tussen de juridische activiteiten vormt de basis voor deze functionele structuur.\nOp de Ontwikkel, Test, Acceptatie en Pre-productieomgeving worden ook omgevingsdocumenten toegevoegd en verwijderd door beheerders voor testdoeleinden binnen en buiten de voorziening.\u003cbr/\u003e\nDe Omgevingsdocumenten Toepasbaar 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.\n", "contact": { "name": "Kadaster DSO - Team Ozon", "url": "https://developer.omgevingswet.overheid.nl/services/contact/", "email": "beheerdso@kadaster.nl" }, "version": "7.7.5" }, "openapi": "3.1.0", "paths": { "/activiteitengeaggregeerd/levenscyclus": { "get": { "tags": [ "Activiteiten" ], "summary": "Activiteiten opvragen met geaggregeerde locatie info.\n", "description": "Onder de activiteitversie worden de ontdubbelde locatieversies opgenomen die binnen de levensduur van die activiteitversie actief waren.\nBij gebruik van de parameter 'gemuteerdSinds' worden alleen activiteiten teruggegeven die sinds die datum (begin van de dag) ontstaan, gewijzigd, of beëindigd zijn; van die activiteiten worden alleen de versies teruggegeven waarop ten minste een mutatie is gedaan op of na deze datum. Bij gebruik van de parameter 'beschikbaarOp' worden alleen activiteiten teruggegeven die zijn ontstaan, gewijzigd, of beëindigd voor die datum (begin van de dag). Van die activiteiten worden alleen de versies teruggegeven die voor deze datum beschikbaar waren.\n", "operationId": "getActiviteitenMetGeaggregeerdeLocatieInfoLevenscyclus", "parameters": [ { "$ref": "#/components/parameters/StatusFilter" }, { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/Size" }, { "$ref": "#/components/parameters/Sort" }, { "name": "gemuteerdSinds", "in": "query", "description": "Deze parameter geeft een filtermogelijkheid om alleen activiteiten terug te gegeven die op of na deze datum gemuteerd (d.w.z. opgevoerd, gewijzigd, of beëindigd) zijn, en daarvan alle versies vanaf dat moment. Datum in ISO 8601 formaat (yyyy-mm-dd).\n", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "format": "date" }, "example": "2019-01-01" }, { "$ref": "#/components/parameters/beschikbaarOp" } ], "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "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" }, "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ActiviteitenMetGeaggregeerdeLocatieInfo" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/locaties/{identificatie}": { "get": { "tags": [ "Locaties" ], "summary": "Een enkele locatie opvragen", "operationId": "getLocatie", "parameters": [ { "$ref": "#/components/parameters/geldigOp" }, { "$ref": "#/components/parameters/inWerkingOp" }, { "$ref": "#/components/parameters/beschikbaarOp" }, { "$ref": "#/components/parameters/synchroniseerMetTileset" }, { "name": "locatieSelectie", "in": "query", "description": "Standaard worden alle locaties uitgeleverd zoals geregistreerd. Met deze parameter kunnen locaties uitgeleverd worden met een andere dan de standaardselectie:\n - `samengesteld`: Locatiegroepen krijgen een geometrie-identificatie, welke verwijst naar een geometrie \n die een samenstelling is van alle onderliggende geometrieën.\n Onderliggende locaties in `omvat` attribuut worden niet uitgeleverd.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "enum": [ "samengesteld" ] } }, { "name": "identificatie", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "nl.imow-gm0037.gebied.2019000001example" } ], "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "Locatie", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Locatie" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "description": "Er is geen locatie met deze identificatie.", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem404" } } } }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/activiteitengeaggregeerd/{identificatie}/levenscyclus": { "get": { "tags": [ "Activiteiten" ], "summary": "Een specifieke activiteit ophalen op basis van de identificatie\n", "description": "Bij elke activiteitversie worden alle locatieversies opgenomen die binnen de levensduur van die activiteitversie actief waren.\nDe relatie tussen activiteit en locatie wordt afgeleid via de juridische regel die de relatie vastlegt; de activiteit en locatie hebben een relatie met elkaar in de periode dat de juridische regel juridisch geldig is, en naar zowel de activiteit als de locatie verwijst. De identificatie van de juridische regel die de relatie vastlegt, is opgenomen in de relatie.\nBij gebruik van de parameter 'gemuteerdSinds' worden alleen activiteiten teruggegeven die sinds die datum (begin van de dag) ontstaan, gewijzigd, of beëindigd zijn; van die activiteiten worden alleen de versies teruggegeven waarop ten minste een mutatie is gedaan op of na deze datum. Bij gebruik van de parameter 'beschikbaarOp' worden alleen activiteiten teruggegeven die zijn ontstaan, gewijzigd, of beëindigd voor die datum (begin van de dag). Van die activiteiten worden alleen de versies teruggegeven die voor deze datum beschikbaar waren.\n", "operationId": "getActiviteitMetGeaggregeerdeLocatieInfoLevencsyclus", "parameters": [ { "$ref": "#/components/parameters/StatusFilter" }, { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/Size" }, { "$ref": "#/components/parameters/Sort" }, { "name": "identificatie", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "nl.imow-gm0037.activiteit.2019000242example" }, { "name": "gemuteerdSinds", "in": "query", "description": "Deze parameter geeft een filtermogelijkheid om alleen activiteiten terug te gegeven die op of na deze datum gemuteerd (d.w.z. opgevoerd, gewijzigd, of beëindigd) zijn, en daarvan alle versies vanaf dat moment. Datum in ISO 8601 formaat (yyyy-mm-dd).\n", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "format": "date" }, "example": "2019-01-01" }, { "$ref": "#/components/parameters/beschikbaarOp" } ], "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "OK", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ActiviteitenMetGeaggregeerdeLocatieInfo" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "description": "Er is geen activiteit met deze identificatie.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem404" } } } }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/activiteiten/{identificatie}/juridischebron": { "get": { "tags": [ "Activiteiten" ], "summary": "De juridische bron van een activiteit opvragen. De juridische bron is het artikel/lid of de artikelen/leden waar de activiteit als eerste genoemd wordt.\n", "operationId": "getActiviteitJuridischeBron", "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.2019000242example" } ], "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "OK", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/JuridischeBron" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "description": "Er is geen activiteit met deze identificatie.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem404" } } } }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/activiteiten/{identificatie}/regelteksten": { "get": { "tags": [ "Activiteiten" ], "summary": "De regelteksten van een activiteit opvragen. De regeltekten van een activiteit zijn alle regelteksten waarin de activiteit genoemd wordt op het moment van de tijdreisvraag.\n", "operationId": "getActiviteitRegelteksten", "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" }, { "name": "identificatie", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "nl.imow-gm0037.activiteit.2019000242example" } ], "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "OK", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Regelteksten" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "description": "Er is geen activiteit met deze identificatie.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem404" } } } }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/activiteitidentificaties/_zoek": { "post": { "tags": [ "Activiteiten" ], "summary": "Activiteit identificaties opvragen die voldoen aan zoekobject-parameters.", "description": "Activiteit identificaties worden teruggegeven die voldoen aan de zoekobject-parameters.\n", "operationId": "zoekActiviteitIdentificaties", "parameters": [ { "$ref": "#/components/parameters/geldigOp" }, { "$ref": "#/components/parameters/inWerkingOp" }, { "$ref": "#/components/parameters/beschikbaarOp" }, { "$ref": "#/components/parameters/synchroniseerMetTileset" }, { "$ref": "#/components/parameters/ContentCrsHeader" } ], "requestBody": { "description": "zoekobject", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoJsonZoekobject" }, "examples": { "activiteitIdentificatieZoekVoorbeeld": { "$ref": "#/components/examples/activiteitIdentificatieZoekVoorbeeld" } } } }, "required": true }, "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "ActiviteitIdentificaties", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "422": { "$ref": "#/components/responses/Unprocessable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/locaties/_zoek": { "post": { "tags": [ "Locaties" ], "summary": "Locaties opvragen die voldoen aan zoekobject-parameters.", "description": "Locaties worden teruggegeven die voldoen aan de zoekobject-parameters. Sinds versie 7.0.4 worden ook locaties die niet gerelateerd zijn aan activiteiten teruggegeven.\nZie LocatieZoekobject voor meer informatie.\n", "operationId": "zoekLocaties", "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/ContentCrsHeader" } ], "requestBody": { "description": "LocatieZoekobject", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocatieZoekobject" }, "examples": { "locatieZoekobjectVoorbeeld": { "$ref": "#/components/examples/locatieZoekobjectVoorbeeld" } } } }, "required": true }, "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "Locaties", "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" }, "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/LocatiesMetSpatialOperator" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "422": { "$ref": "#/components/responses/Unprocessable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/locatieidentificaties/_zoek": { "post": { "tags": [ "Locaties" ], "summary": "Alle locatieIdentificaties opvragen die voldoen aan de geo in het zoekobject", "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/LocatieIdentificatiesOfGeoZoekobject" } } }, "required": true }, "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "OK", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/LocatieZoekgebieden" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "422": { "$ref": "#/components/responses/Unprocessable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/primairelocaties/_zoek": { "post": { "tags": [ "Locaties" ], "summary": "Primaire locaties opvragen die voldoen aan zoekobject-parameters ten behoeve van Vector Tile bevraging.", "description": "'Primaire locaties' zijn locaties waarnaar andere OW-objecten (b.v. juridische activiteiten, gebiedsaanwijzingen) direct verwijzen. Locaties binnen een locatiegroep (gebiedengroep/lijnengroep/puntengroep) zijn 'primair' alleen als ook een ander OW-object daarnaar verwijst. Als een locatie (gebied/lijn/punt) alleen een onderdeel van een locatiegroep is, dan is deze locatie 'secundair'.\nVoor locatiegroepen wordt een samengestelde geometrie aangemaakt. Deze heeft ook eigen geometrie-identificatie. \nDit endpoint levert gebieden/lijnen/punten/ambtsgebieden die overeenkomen met de zoekopdracht. Voor de gegeven locatie-identificaties en geometrie worden teruggegeven alle primaire locaties die overeenkomen met een van de identificaties EN intersecten met de geometrie.\nZie PrimaireLocatieZoekobject voor meer informatie.\n", "operationId": "zoekPrimaireLocaties", "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/ContentCrsHeader" } ], "requestBody": { "description": "PrimaireLocatieZoekobject", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrimaireLocatieZoekobject" }, "examples": { "primaireLocatieZoekobjectVoorbeeld": { "$ref": "#/components/examples/primaireLocatieZoekobjectVoorbeeld" } } } }, "required": true }, "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "Primaire Locaties", "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" }, "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/PrimaireLocaties" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "422": { "$ref": "#/components/responses/Unprocessable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/geometrieidentificaties/_zoek": { "post": { "tags": [ "GeometrieIdentificaties" ], "summary": "geometrieidentificaties opvragen die voldoen aan zoekobject-parameters ten behoeve van Vector Tile bevraging.", "description": "Dit endpoint levert geometrieidentificaties van gebieden/lijnen/punten/ambtsgebieden die overeenkomen met de zoekopdracht.", "operationId": "zoekGeometrieIdentificaties", "parameters": [ { "$ref": "#/components/parameters/geldigOp" }, { "$ref": "#/components/parameters/inWerkingOp" }, { "$ref": "#/components/parameters/beschikbaarOp" }, { "$ref": "#/components/parameters/synchroniseerMetTileset" }, { "$ref": "#/components/parameters/ContentCrsHeader" } ], "requestBody": { "description": "LocatieIdentificatiesEnGeoZoekobject", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocatieIdentificatiesEnGeoZoekobject" }, "examples": { "locatieIdentificatiesEnGeoZoekobjectVoorbeeld": { "$ref": "#/components/examples/locatieIdentificatiesEnGeoZoekobjectVoorbeeld" } } } }, "required": true }, "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "Locatie hashes", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/GeometrieIdentificaties" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "422": { "$ref": "#/components/responses/Unprocessable" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/health": { "get": { "tags": [ "Meta" ], "summary": "Dit endpoint levert health informatie uit, maar volgt niet de DSO API-strategie en is daarom deprecated met /app-health als vervanger.", "operationId": "getHealth", "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "OK", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } } }, "deprecated": true } }, "/app-health": { "get": { "tags": [ "Meta" ], "summary": "app-health info", "operationId": "getAppHealth", "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "OK", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppHealthResponse" }, "example": { "app-health": { "status": "UP" } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppHealthResponse" }, "example": { "app-health": { "status": "DOWN" } } } } } } } }, "/app-info": { "get": { "tags": [ "Meta" ], "summary": "applicatie info", "operationId": "getInfo", "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "Info", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Info" } } } } } } }, "/openapi.yaml": { "get": { "tags": [ "Meta" ], "summary": "De OpenAPI specificatie in YAML-formaat", "description": "Vraag de OpenAPI specificatie op in YAML formaat.", "operationId": "getOpenApiYaml", "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "OK", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/yaml": { "schema": { "type": "object", "title": "OpenApiSchemaYaml", "description": "Het YAML schema van de OpenAPI specificatie." } } } } } } }, "/openapi.json": { "get": { "tags": [ "Meta" ], "summary": "De OpenAPI specificatie in JSON-formaat", "description": "Vraag de OpenAPI specificatie op in JSON formaat.", "operationId": "getOpenApiJson", "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "200": { "description": "OK", "headers": { "API-Version": { "$ref": "#/components/headers/API-Version" } }, "content": { "application/json": { "schema": { "type": "object", "title": "OpenApiSchemaJson", "description": "Het JSON schema van de OpenAPI specificatie." } } } } } } } }, "servers": [ { "url": "/publiek/omgevingsdocumenten/api/toepasbaaropvragen/v7", "description": "basePath" } ], "tags": [ { "name": "Activiteiten", "description": "Activiteiten bevat activiteit uitspraken die in omgevingsdocumenten staan." }, { "name": "Locaties", "description": "Locaties van Omgevingsdocumentobjecten." }, { "name": "GeometrieIdentificaties", "description": "GeometrieIdentificaties behorende bij locaties van Omgevingsdocumentobjecten." }, { "name": "Meta", "description": "Operaties die niet domeinspecifiek zijn, maar over de applicatie gaan." } ] }