{ "openapi": "3.0.0", "info": { "title": "IMBAG API - van de LVBAG", "description": "Dit is de [BAG API](https://zakelijk.kadaster.nl/-/bag-api) Individuele Bevragingen van de Landelijke Voorziening Basisregistratie Adressen en Gebouwen (LVBAG).\n\nMeer informatie over de Basisregistratie Adressen en Gebouwen is te vinden op de website van het [Ministerie van Binnenlandse Zaken en Koninkrijksrelaties](https://www.geobasisregistraties.nl/basisregistraties/adressen-en-gebouwen) en [Kadaster](https://zakelijk.kadaster.nl/bag).\n\nDe BAG API levert informatie conform de [BAG Catalogus 2018](https://www.geobasisregistraties.nl/documenten/publicatie/2018/03/12/catalogus-2018) en het informatiemodel IMBAG 2.0.\nDe API specificatie volgt de [Nederlandse API-Strategie](https://docs.geostandaarden.nl/api/API-Strategie) specificatie versie van 20200204 en is opgesteld in [OpenAPI Specificatie](https://www.forumstandaardisatie.nl/standaard/openapi-specification) (OAS) v3.\n\nHet standaard mediatype HAL (`application/hal+json`) wordt gebruikt. Dit is een mediatype voor het weergeven van resources en hun relaties via hyperlinks.\n\nDeze API is vooral gericht op individuele bevragingen (op basis van de identificerende gegevens van een object).\nOm gebruik te kunnen maken van de BAG API is een API key nodig, deze kan verkregen worden door het [aanvraagformulier](https://formulieren.kadaster.nl/aanvraag_bag_api_individuele_bevragingen_productie) in te vullen.\n\nVoor vragen, neem contact op met de LVBAG beheerder o.v.v. BAG API 2.0. We zijn aan het kijken naar een geschikt medium hiervoor, mede ook om de API iteratief te kunnen opstellen of doorontwikkelen samen met de community. Als de API iets (nog) niet kan, wat u wel graag wilt, neem dan contact op.", "termsOfService": "https://zakelijk.kadaster.nl/algemene-voorwaarden", "contact": { "name": "Kadaster - Beheerder LVBAG", "url": "https://zakelijk.kadaster.nl/bag" }, "license": { "name": "European Union Public License, version 1.2 (EUPL-1.2)", "url": "https://eupl.eu/1.2/nl/" }, "version": "2.9.2" }, "servers": [ { "url": "https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2", "description": "LVBAG - PRODUCTIE" } ], "security": [ { "apiKeyBAG": [] } ], "tags": [ { "name": "Adresseerbaar object", "description": "Dit endpoint levert één of meer (voorkomens van) adresseerbare objecten met embedded resources en links." }, { "name": "Adres", "description": "Deze services leveren één of meer huidige adressen, met embedded resources en links. Huidig betekent dat het adres actueel is en geen eind status heeft. Voor een toelichting zie de [Praktijkhandleiding BAG](https://imbag.github.io/praktijkhandleiding/artikelen/wat-is-het-verschil-tussen-actieve-voorkomens-actuele-voorkomens-en-huidige-voorkomens)." }, { "name": "Adres uitgebreid", "description": "Deze service levert uitgebreide informatie van één of meer huidige adressen, met embedded resources en links. Huidig betekent dat het adres actueel is en geen eind status heeft. Voor een toelichting zie de [Praktijkhandleiding BAG](https://imbag.github.io/praktijkhandleiding/artikelen/wat-is-het-verschil-tussen-actieve-voorkomens-actuele-voorkomens-en-huidige-voorkomens)." }, { "name": "Algemene informatie", "description": "Het endpoint voor algemene informatie levert informatie op van de API." }, { "name": "Bronhouder", "description": "Dit endpoint levert één of meer bronhouder(s)." }, { "name": "Ligplaats", "description": "Dit endpoint levert één of meer (voorkomens van) ligplaats(en), met embedded resources en links." }, { "name": "Nummeraanduiding", "description": "Dit endpoint levert één of meer (voorkomens van) nummeraanduiding(en), met embedded resources en links." }, { "name": "Openbare ruimte", "description": "Dit endpoint levert één of meer (voorkomens van) openbare ruimte(n), met embedded resources en links." }, { "name": "Pand", "description": "Dit endpoint levert één of meer (voorkomens van) pand(en), met embedded resources en links." }, { "name": "Standplaats", "description": "Dit endpoint levert één of meer (voorkomens van) standplaats(en), met embedded resources en links." }, { "name": "Verblijfsobject", "description": "Dit endpoint levert één of meer (voorkomens van) verblijfsobject(en), met embedded resources en links." }, { "name": "Woonplaats", "description": "Dit endpoint levert één of meer (voorkomens van) woonplaats(en), met embedded resources en links." } ], "paths": { "/adresseerbareobjecten": { "get": { "tags": [ "Adresseerbaar object" ], "summary": "Bevragen van één of meer adresseerbare objecten op basis van een nummeraanduiding identificatie.", "description": "Zoek actuele adresseerbare objecten (verblijfsobjecten, standplaatsen of ligplaatsen):\n\n1. met een nummeraanduiding identificatie.\n\n2. binnen een geometrische contour (rechthoek) in combinatie met status geconstateerd, oppervlakte, gebruiksdoel en/of type.\n\n3. met een lijst van pandidentificaties.\n\n\nParameter huidig kan worden toegepast, zie [functionele specificatie huidig](https://github.com/lvbag/BAG-API/blob/master/Features/huidig.feature).\n\nDe geldigOp en beschikbaarOp parameters kunnen gebruikt worden voor \ntijdreis vragen, zie \n[functionele specificatie tijdreizen](https://github.com/lvbag/BAG-API/blob/master/Features/tijdreizen.feature). \n\nAls expand=heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan (of een combinatie daarvan) of als expand=true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd, zie\n[functionele specificatie expand](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature).\n\nVoor paginering, zie: [functionele specificatie paginering](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).\n", "operationId": "zoekAdresseerbareObjecten", "parameters": [ { "name": "nummeraanduidingIdentificatie", "in": "query", "description": "De identificatie van een nummeraanduiding uit de BAG.", "required": false, "style": "form", "explode": true, "schema": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, { "name": "huidig", "in": "query", "description": "Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false, "default": false } }, { "name": "geldigOp", "in": "query", "description": "Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD`\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2019-11-23" } }, { "name": "beschikbaarOp", "in": "query", "description": "Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd \n`YYYY-MM-DDThh:mm:ss.sss'. Hierin kunnen de seconden ':ss' en milliseconden \n'.sss' of alleen de milliseconden conform ISO 8601 specificatie worden \nweggelaten, in dat geval krijgen deze automatisch de waarde ':00' \nrespectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 \ncijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'.\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "expand", "in": "query", "description": "Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Crs", "in": "header", "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, { "name": "Content-Crs", "in": "header", "description": "CRS van de meegegeven geometrie.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, { "name": "page", "in": "query", "description": "Pagina nummer", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Aantal resultaten per pagina", "required": false, "style": "form", "explode": true, "schema": { "maximum": 100, "minimum": 10, "type": "integer", "default": 20 } }, { "name": "bbox", "in": "query", "description": "Rechthoek (bounding box) waarbinnen het object dat je zoekt valt.\nVoor een definitie van bbox, zie [OGC API Features specificatie - bbox definitie](https://docs.opengeospatial.org/is/17-069r3/17-069r3.html#ats_core_fc-bbox-definition).\nMet de content-crs header wordt aangegeven in welk CRS de coördinaten van de bbox zijn. \nCoördinaten worden als volgt opgegeven: linksonder x, linksonder y, rechtsboven x, rechtsboven y.\nDe oppervlakte van de bounding box mag maximaal 250.000 vierkante meter zijn.\n", "required": false, "style": "form", "explode": false, "schema": { "maxItems": 4, "minItems": 4, "type": "array", "example": [ 196733.51, 439931.89, 196833.51, 440031.89 ], "items": { "type": "number" } } }, { "name": "geconstateerd", "in": "query", "description": "Geeft aan of naar geconstateerde objecten moet worden gezocht.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "oppervlakte", "in": "query", "description": "Geef de minimale en maximale oppervlakte op waarbinnen je wilt zoeken (in m2).\nAlleen verblijfsobjecten hebben een oppervlakte en kunnen met deze parameter worden gevonden.\nLigplaatsen en standplaatsen hebben geen oppervlakte en kunnen met deze parameter niet worden gevonden.\nDe oppervlakte van een verblijfsobject is een natuurlijk getal tussen 1 (minimaal) en 999999 (maximaal).\nHet is niet toegestaan voor min een grotere waarde op te geven dan voor max.\nIs min \u003e max dan treedt een foutmelding op.\nBv: oppervlakte[min]=100\u0026oppervlakte[max]=200\n", "required": false, "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "min": { "maximum": 999999, "minimum": 1, "type": "integer", "description": "Zoek naar waarden groter of gelijk aan de opgegeven waarde." }, "max": { "maximum": 999999, "minimum": 1, "type": "integer", "description": "Zoek naar waarden kleiner dan de opgegeven waarde." } }, "description": "\"Zoek binnen een bereik van de opgegeven minimumwaarde tot maximumwaarde. \nDe opgegeven minimumwaarde moet lager zijn dan de opgegeven maximumwaarde.\"\n" } }, { "name": "gebruiksdoelen", "in": "query", "description": "De gebruiksdoelen van het verblijfsobject zoals in de vergunning is opgenomen of bij constatering is vastgesteld.\nAls een verblijfsobject één van de gebruiksdoelen in deze lijst heeft, dan wordt het verblijfsobject in het zoekresultaat meegenomen.\n", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "type": "array", "items": { "title": "Gebruiksdoel", "type": "string", "description": "Een categorisering waarmee het gebruiksdoel van een object kan worden verbijzonderd.", "enum": [ "woonfunctie", "bijeenkomstfunctie", "celfunctie", "gezondheidszorgfunctie", "industriefunctie", "kantoorfunctie", "logiesfunctie", "onderwijsfunctie", "sportfunctie", "winkelfunctie", "overige gebruiksfunctie" ] } } }, { "name": "type", "in": "query", "description": "Geeft aan of het adresseerbaar object een ligplaats, standplaats of verblijfsobject is.", "required": false, "style": "form", "explode": true, "schema": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, { "name": "pandIdentificaties", "in": "query", "description": "Een lijst met identificaties van panden uit de BAG.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "type": "array", "items": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" } } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging zoekAdresseerbaarObject geslaagd. Ondanks dat er in de example een voorbeeld van alle mogelijke adresseerbare objecten (ligplaats, standplaats of verblijfspobject) staat, wordt er altijd slechts één van deze objecten geretourneerd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "X-Pagination-Page": { "description": "Huidige pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 3 }, "example": 3 }, "X-Pagination-Limit": { "description": "Aantal resultaten per pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 20 }, "example": 20 }, "Content-Crs": { "description": "CRS van de geometrie verstrekt door de server aan de client.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "adresseerbareObjecten": { "type": "array", "items": { "title": "AdresseerbaarObjectIO", "type": "object", "properties": { "_links": { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } }, "ligplaats": { "allOf": [ { "allOf": [ { "title": "LigplaatsIO", "required": [ "ligplaats" ], "properties": { "ligplaats": { "title": "Ligplaats", "description": "Een Ligplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen plaats in het water al dan niet aangevuld met een op de oever \naanwezig terrein of een gedeelte daarvan, die bestemd is voor het permanent \nafmeren van een voor woon-, bedrijfsmatige of recreatieve doeleinden \ngeschikt drijvend object.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een ligplaats, waarin de \nbetreffende ligplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een ligplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Ligplaats", "example": "NL.IMBAG.Ligplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een \nopname, mutatie of een verwijdering van gegevens ten aanzien van een \nobject heeft plaatsgevonden.\n", "format": "date", "example": "2011-12-30" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "AVGEL30122011-07" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkLigplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanLigplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekLigplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanLigplaats": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een ligplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van ligplaats\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Ligplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] }, "standplaats": { "allOf": [ { "allOf": [ { "title": "StandplaatsIO", "required": [ "standplaats" ], "properties": { "standplaats": { "title": "Standplaats", "description": "Een Standplaats is een door het bevoegde gemeentelijke orgaan als\nzodanig aangewezen terrein of gedeelte daarvan dat bestemd is voor\nhet permanent plaatsen van een niet direct en niet duurzaam met de\naarde verbonden en voor woon-, bedrijfsmatige, of recreatieve\ndoeleinden geschikte ruimte.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een standplaats, waarin \nde betreffende standplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een standplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "StandplaatsIdentificatie", "pattern": "^[0-9]{4}03[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een standplaats.", "example": "0797030000056834" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Standplaats", "example": "NL.IMBAG.Standplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-10-05" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "AVGEL05102011-09" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkStandplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanStandplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekStandplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanStandplaats": { "title": "StandplaatsIdentificatie", "pattern": "^[0-9]{4}03[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een standplaats.", "example": "0797030000056834" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een standplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van standplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Standplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] }, "verblijfsobject": { "allOf": [ { "allOf": [ { "title": "VerblijfsobjectIO", "required": [ "verblijfsobject" ], "properties": { "verblijfsobject": { "title": "Verblijfsobject", "description": "Een Verblijfsobject is de kleinste binnen een of meer panden gelegen\nen voor woon-, bedrijfsmatige, of recreatieve doeleinden geschikte\neenheid van gebruik die ontsloten wordt via een eigen afsluitbare\ntoegang vanaf de openbare weg, een erf of een gedeelde\nverkeersruimte, onderwerp kan zijn van goederenrechtelijke\nrechtshandelingen en in functioneel opzicht zelfstandig is.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**geometrie**: De minimaal tweedimensionale geometrische representatie van \neen verblijfsobject.\n\n**status**: De fase van de levenscyclus van een verblijfsobject, waarin het \nbetreffende verblijfsobject zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "gebruiksdoelen", "geconstateerd", "geometrie", "identificatie", "maaktDeelUitVan", "oppervlakte", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "VerblijfsobjectIdentificatie", "pattern": "^[0-9]{4}01[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een verblijfsobject.", "example": "0226010000038820" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Verblijfsobject", "example": "NL.IMBAG.Verblijfsobject" }, "geometrie": { "title": "PuntOfVlak", "type": "object", "properties": { "punt": { "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "minItems": 2, "type": "array", "items": { "type": "number" } } } }, "vlak": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] } }, "description": "Een samengesteld geometriegegevenstype waarbij wordt afgedwongen dat voor de geometrie een \nkeuze gemaakt moet worden tussen een punt of een vlak.\n" }, "gebruiksdoelen": { "minItems": 1, "type": "array", "items": { "title": "Gebruiksdoel", "type": "string", "description": "Een categorisering waarmee het gebruiksdoel van een object kan worden verbijzonderd.", "enum": [ "woonfunctie", "bijeenkomstfunctie", "celfunctie", "gezondheidszorgfunctie", "industriefunctie", "kantoorfunctie", "logiesfunctie", "onderwijsfunctie", "sportfunctie", "winkelfunctie", "overige gebruiksfunctie" ] } }, "oppervlakte": { "title": "oppervlakte", "pattern": "^[1-9][0-9]{0,5}$", "type": "integer", "description": "De gebruiksoppervlakte van een verblijfsobject in gehele vierkante meters.", "example": 205 }, "status": { "title": "StatusVerblijfsobject", "type": "string", "description": "Een aanduiding van alle waarden die de status van een verblijfsobject kan aannemen.", "enum": [ "Verblijfsobject gevormd", "Niet gerealiseerd verblijfsobject", "Verblijfsobject in gebruik (niet ingemeten)", "Verblijfsobject in gebruik", "Verbouwing verblijfsobject", "Verblijfsobject ingetrokken", "Verblijfsobject buiten gebruik", "Verblijfsobject ten onrechte opgevoerd" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.\n", "format": "date", "example": "2019-11-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "19SZ2048" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "maaktDeelUitVan": { "minItems": 1, "type": "array", "description": "Een verblijfsobject maakt onderdeel uit van een pand.\n\nDeze property bevat de identificaties van de panden waar het verblijfsobject onderdeel van uitmaakt.\n", "items": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" } } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkVerblijfsobjectInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanVerblijfsobject", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekVerblijfsobject", "type": "string", "enum": [ "geometrie", "gebruiksdoel", "oppervlakte", "status", "maakt deel uit van", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanVerblijfsobject": { "title": "VerblijfsobjectIdentificatie", "pattern": "^[0-9]{4}01[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een verblijfsobject.", "example": "0226010000038820" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een verblijfsobject waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van verblijfsobject.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een verblijfsobject en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } }, { "properties": { "maaktDeelUitVan": { "minItems": 1, "type": "array", "description": "De panden (1 of meer) waarvan dit verblijfsobject deel uit maakt. Van deze panden: hiervan het voorkomen van pand die gevonden worden op basis van dezelfde tijdreisparameters als waarmee het verblijfsobject voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } }, { "properties": { "maaktDeelUitVan": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "PandIO", "required": [ "pand" ], "type": "object", "properties": { "pand": { "title": "Pand", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "oorspronkelijkBouwjaar", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Pand", "example": "NL.IMBAG.Pand" }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "oorspronkelijkBouwjaar": { "title": "Oorspronkelijk bouwjaar", "maxLength": 4, "pattern": "^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$", "type": "string", "description": "De aanduiding van het jaar waarin een pand oorspronkelijk als bouwkundig \ngereed is of zal worden opgeleverd.\n", "example": "1991" }, "status": { "title": "StatusPand", "type": "string", "description": "Een codering van de verschillende waarden die de status van een pand kan aannemen.\n", "enum": [ "Bouwvergunning verleend", "Niet gerealiseerd pand", "Bouw gestart", "Pand in gebruik (niet ingemeten)", "Pand in gebruik", "Verbouwing pand", "Sloopvergunning verleend", "Pand gesloopt", "Pand buiten gebruik", "Pand ten onrechte opgevoerd" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2009-05-12" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "09.BW.0273" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-\nconstructief zelfstandige eenheid die direct en duurzaam met de aarde is \nverbonden en betreedbaar en afsluitbaar is.\n\n**geometrie**: De minimaal tweedimensionale geometrische representatie van \nhet bovenaanzicht van de omtrekken van een pand.\n\n**status**: De fase van de levenscyclus van een pand, waarin het betreffende \npand zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve werkelijkheid, \nzoals beschreven met de eigenschappen van dit object waarover gegevens \ngeregistreerd worden, waarbij de gegevens gedurende een bepaalde periode \ngelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkPandInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanPand", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekPand", "type": "string", "enum": [ "geometrie", "oorspronkelijk bouwjaar", "status" ] }, "identificatieVanPand": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een pand waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van pand.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-constructief zelfstandige eenheid die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar is. Inclusief aanduiding of deze in onderzoek is" }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] } }, "description": "Een adresseerbaar object kan een ligplaats, standplaats of verblijfsobject zijn, er wordt van onderstaande properties dus altijd maar één ingevuld." } } } }, "_links": { "title": "HalPaginationLinks", "example": { "first": { "href": "/resourcenaam?page=1", "title": "Eerste pagina" }, "previous": { "href": "/resourcenaam?page=3", "title": "Vorige pagina" }, "next": { "href": "/resourcenaam?page=5", "title": "Volgende pagina" }, "last": { "href": "/resourcenaam?page=15", "title": "Laatste pagina" } }, "allOf": [ { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } }, { "type": "object", "properties": { "first": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "previous": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "next": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "last": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } ] } } } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "412": { "description": "Precondition failed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 412, "title": "Niet voldaan aan vooraf gestelde voorwaarde", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", "detail": "The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "preconditionFailed" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/adresseerbareobjecten/{adresseerbaarObjectIdentificatie}": { "get": { "tags": [ "Adresseerbaar object" ], "summary": "Bevragen van één adresseerbaar object met een adresseerbaar \nobject identificatie.\n", "description": "Bevragen van één adresseerbaar object (ligplaats, standplaats of \nverblijfsobject) met de identificatie van een adresseerbaar object.\n\nParameter huidig kan worden toegepast, zie [functionele specificatie huidig](https://github.com/lvbag/BAG-API/blob/master/Features/huidig.feature).\n\nDe geldigOp en beschikbaarOp parameters kunnen gebruikt worden voor \ntijdreis vragen, zie \n[functionele specificatie tijdreizen](https://github.com/lvbag/BAG-API/blob/master/Features/tijdreizen.feature). \n\nAls expand=heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan \n(of een combinatie daarvan) of als expand=true, dan worden de \ngevraagde of alle gerelateerde resources als geneste resource geleverd, zie\n[functionele specificatie expand](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature).\n", "operationId": "bevragenAdresseerbaarObject", "parameters": [ { "name": "adresseerbaarObjectIdentificatie", "in": "path", "description": "De identificatie van een adresseerbaar object (ligplaats, standplaats \nof verblijfsobject) uit de BAG.\n", "required": true, "style": "simple", "explode": false, "schema": { "title": "AdresseerbaarobjectIdentificatie", "pattern": "^[0-9]{4}(01|02|03)[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) \nuit de BAG.\n", "example": "0226010000038820" } }, { "name": "geldigOp", "in": "query", "description": "Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD`\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2019-11-23" } }, { "name": "beschikbaarOp", "in": "query", "description": "Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd \n`YYYY-MM-DDThh:mm:ss.sss'. Hierin kunnen de seconden ':ss' en milliseconden \n'.sss' of alleen de milliseconden conform ISO 8601 specificatie worden \nweggelaten, in dat geval krijgen deze automatisch de waarde ':00' \nrespectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 \ncijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'.\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "expand", "in": "query", "description": "Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Crs", "in": "header", "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, { "name": "huidig", "in": "query", "description": "Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false, "default": false } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging bevragenAdresseerbaarObject geslaagd geslaagd. Ondanks dat er in de example een voorbeeld van alle mogelijke adresseerbare objecten (ligplaats, standplaats of verblijfspobject) staat, wordt er altijd slechts één van deze objecten geretourneerd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "title": "AdresseerbaarObjectIO", "type": "object", "properties": { "_links": { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } }, "ligplaats": { "allOf": [ { "allOf": [ { "title": "LigplaatsIO", "required": [ "ligplaats" ], "properties": { "ligplaats": { "title": "Ligplaats", "description": "Een Ligplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen plaats in het water al dan niet aangevuld met een op de oever \naanwezig terrein of een gedeelte daarvan, die bestemd is voor het permanent \nafmeren van een voor woon-, bedrijfsmatige of recreatieve doeleinden \ngeschikt drijvend object.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een ligplaats, waarin de \nbetreffende ligplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een ligplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Ligplaats", "example": "NL.IMBAG.Ligplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een \nopname, mutatie of een verwijdering van gegevens ten aanzien van een \nobject heeft plaatsgevonden.\n", "format": "date", "example": "2011-12-30" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "AVGEL30122011-07" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkLigplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanLigplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekLigplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanLigplaats": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een ligplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van ligplaats\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Ligplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] }, "standplaats": { "allOf": [ { "allOf": [ { "title": "StandplaatsIO", "required": [ "standplaats" ], "properties": { "standplaats": { "title": "Standplaats", "description": "Een Standplaats is een door het bevoegde gemeentelijke orgaan als\nzodanig aangewezen terrein of gedeelte daarvan dat bestemd is voor\nhet permanent plaatsen van een niet direct en niet duurzaam met de\naarde verbonden en voor woon-, bedrijfsmatige, of recreatieve\ndoeleinden geschikte ruimte.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een standplaats, waarin \nde betreffende standplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een standplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "StandplaatsIdentificatie", "pattern": "^[0-9]{4}03[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een standplaats.", "example": "0797030000056834" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Standplaats", "example": "NL.IMBAG.Standplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-10-05" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "AVGEL05102011-09" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkStandplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanStandplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekStandplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanStandplaats": { "title": "StandplaatsIdentificatie", "pattern": "^[0-9]{4}03[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een standplaats.", "example": "0797030000056834" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een standplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van standplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Standplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] }, "verblijfsobject": { "allOf": [ { "allOf": [ { "title": "VerblijfsobjectIO", "required": [ "verblijfsobject" ], "properties": { "verblijfsobject": { "title": "Verblijfsobject", "description": "Een Verblijfsobject is de kleinste binnen een of meer panden gelegen\nen voor woon-, bedrijfsmatige, of recreatieve doeleinden geschikte\neenheid van gebruik die ontsloten wordt via een eigen afsluitbare\ntoegang vanaf de openbare weg, een erf of een gedeelde\nverkeersruimte, onderwerp kan zijn van goederenrechtelijke\nrechtshandelingen en in functioneel opzicht zelfstandig is.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**geometrie**: De minimaal tweedimensionale geometrische representatie van \neen verblijfsobject.\n\n**status**: De fase van de levenscyclus van een verblijfsobject, waarin het \nbetreffende verblijfsobject zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "gebruiksdoelen", "geconstateerd", "geometrie", "identificatie", "maaktDeelUitVan", "oppervlakte", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "VerblijfsobjectIdentificatie", "pattern": "^[0-9]{4}01[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een verblijfsobject.", "example": "0226010000038820" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Verblijfsobject", "example": "NL.IMBAG.Verblijfsobject" }, "geometrie": { "title": "PuntOfVlak", "type": "object", "properties": { "punt": { "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "minItems": 2, "type": "array", "items": { "type": "number" } } } }, "vlak": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] } }, "description": "Een samengesteld geometriegegevenstype waarbij wordt afgedwongen dat voor de geometrie een \nkeuze gemaakt moet worden tussen een punt of een vlak.\n" }, "gebruiksdoelen": { "minItems": 1, "type": "array", "items": { "title": "Gebruiksdoel", "type": "string", "description": "Een categorisering waarmee het gebruiksdoel van een object kan worden verbijzonderd.", "enum": [ "woonfunctie", "bijeenkomstfunctie", "celfunctie", "gezondheidszorgfunctie", "industriefunctie", "kantoorfunctie", "logiesfunctie", "onderwijsfunctie", "sportfunctie", "winkelfunctie", "overige gebruiksfunctie" ] } }, "oppervlakte": { "title": "oppervlakte", "pattern": "^[1-9][0-9]{0,5}$", "type": "integer", "description": "De gebruiksoppervlakte van een verblijfsobject in gehele vierkante meters.", "example": 205 }, "status": { "title": "StatusVerblijfsobject", "type": "string", "description": "Een aanduiding van alle waarden die de status van een verblijfsobject kan aannemen.", "enum": [ "Verblijfsobject gevormd", "Niet gerealiseerd verblijfsobject", "Verblijfsobject in gebruik (niet ingemeten)", "Verblijfsobject in gebruik", "Verbouwing verblijfsobject", "Verblijfsobject ingetrokken", "Verblijfsobject buiten gebruik", "Verblijfsobject ten onrechte opgevoerd" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.\n", "format": "date", "example": "2019-11-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "19SZ2048" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "maaktDeelUitVan": { "minItems": 1, "type": "array", "description": "Een verblijfsobject maakt onderdeel uit van een pand.\n\nDeze property bevat de identificaties van de panden waar het verblijfsobject onderdeel van uitmaakt.\n", "items": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" } } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkVerblijfsobjectInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanVerblijfsobject", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekVerblijfsobject", "type": "string", "enum": [ "geometrie", "gebruiksdoel", "oppervlakte", "status", "maakt deel uit van", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanVerblijfsobject": { "title": "VerblijfsobjectIdentificatie", "pattern": "^[0-9]{4}01[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een verblijfsobject.", "example": "0226010000038820" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een verblijfsobject waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van verblijfsobject.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een verblijfsobject en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } }, { "properties": { "maaktDeelUitVan": { "minItems": 1, "type": "array", "description": "De panden (1 of meer) waarvan dit verblijfsobject deel uit maakt. Van deze panden: hiervan het voorkomen van pand die gevonden worden op basis van dezelfde tijdreisparameters als waarmee het verblijfsobject voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } }, { "properties": { "maaktDeelUitVan": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "PandIO", "required": [ "pand" ], "type": "object", "properties": { "pand": { "title": "Pand", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "oorspronkelijkBouwjaar", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Pand", "example": "NL.IMBAG.Pand" }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "oorspronkelijkBouwjaar": { "title": "Oorspronkelijk bouwjaar", "maxLength": 4, "pattern": "^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$", "type": "string", "description": "De aanduiding van het jaar waarin een pand oorspronkelijk als bouwkundig \ngereed is of zal worden opgeleverd.\n", "example": "1991" }, "status": { "title": "StatusPand", "type": "string", "description": "Een codering van de verschillende waarden die de status van een pand kan aannemen.\n", "enum": [ "Bouwvergunning verleend", "Niet gerealiseerd pand", "Bouw gestart", "Pand in gebruik (niet ingemeten)", "Pand in gebruik", "Verbouwing pand", "Sloopvergunning verleend", "Pand gesloopt", "Pand buiten gebruik", "Pand ten onrechte opgevoerd" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2009-05-12" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "09.BW.0273" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-\nconstructief zelfstandige eenheid die direct en duurzaam met de aarde is \nverbonden en betreedbaar en afsluitbaar is.\n\n**geometrie**: De minimaal tweedimensionale geometrische representatie van \nhet bovenaanzicht van de omtrekken van een pand.\n\n**status**: De fase van de levenscyclus van een pand, waarin het betreffende \npand zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve werkelijkheid, \nzoals beschreven met de eigenschappen van dit object waarover gegevens \ngeregistreerd worden, waarbij de gegevens gedurende een bepaalde periode \ngelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkPandInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanPand", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekPand", "type": "string", "enum": [ "geometrie", "oorspronkelijk bouwjaar", "status" ] }, "identificatieVanPand": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een pand waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van pand.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-constructief zelfstandige eenheid die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar is. Inclusief aanduiding of deze in onderzoek is" }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] } }, "description": "Een adresseerbaar object kan een ligplaats, standplaats of verblijfsobject zijn, er wordt van onderstaande properties dus altijd maar één ingevuld." } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "404": { "description": "Not found.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 404, "title": "Opgevraagde resource bestaat niet.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", "detail": "The server has not found anything matching the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notFound" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "412": { "description": "Precondition failed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 412, "title": "Niet voldaan aan vooraf gestelde voorwaarde", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", "detail": "The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "preconditionFailed" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/adresseerbareobjecten/{adresseerbaarObjectIdentificatie}/lvc": { "get": { "tags": [ "Adresseerbaar object" ], "summary": "Bevragen van de levenscyclus van een adresseerbaar object met een adresseerbaar object identificatie.", "description": "Bevragen van de levenscyclus van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) met de identificatie van een adresseerbaar object. Met de geheleLvc parameter kan worden aangegeven of de gehele levenscyclus (inclusief voorkomens die uit de geldige levenscyclus zijn verwijderd) of alleen de actieve levenscyclus (alleen de voorkomens die onderdeel zijn van de geldige levenscyclus) gewenst zijn. ", "operationId": "bevragenAdresseerbaarObjectLvc", "parameters": [ { "name": "adresseerbaarObjectIdentificatie", "in": "path", "description": "De identificatie van een adresseerbaar object (ligplaats, standplaats \nof verblijfsobject) uit de BAG.\n", "required": true, "style": "simple", "explode": false, "schema": { "title": "AdresseerbaarobjectIdentificatie", "pattern": "^[0-9]{4}(01|02|03)[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) \nuit de BAG.\n", "example": "0226010000038820" } }, { "name": "geheleLvc", "in": "query", "description": "Filtert naast geldige voorkomens ook de voorkomens die uit de geldige levenscyclus van het object zijn verwijderd.\nAls deze parameter wordt weggelaten worden alleen geldige voorkomens geretourneerd (default is false).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true, "default": false } }, { "name": "Accept-Crs", "in": "header", "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging bevragenAdresseerbaarObjectLvc geslaagd. Ondanks dat er in de example een voorbeeld van alle mogelijke adresseerbare objecten (ligplaats, standplaats of verblijfspobject) staat, wordt er altijd slechts één van deze objecten geretourneerd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "voorkomens": { "minItems": 1, "type": "array", "items": { "title": "AdresseerbaarObjectIO", "type": "object", "properties": { "_links": { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } }, "ligplaats": { "allOf": [ { "allOf": [ { "title": "LigplaatsIO", "required": [ "ligplaats" ], "properties": { "ligplaats": { "title": "Ligplaats", "description": "Een Ligplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen plaats in het water al dan niet aangevuld met een op de oever \naanwezig terrein of een gedeelte daarvan, die bestemd is voor het permanent \nafmeren van een voor woon-, bedrijfsmatige of recreatieve doeleinden \ngeschikt drijvend object.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een ligplaats, waarin de \nbetreffende ligplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een ligplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Ligplaats", "example": "NL.IMBAG.Ligplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een \nopname, mutatie of een verwijdering van gegevens ten aanzien van een \nobject heeft plaatsgevonden.\n", "format": "date", "example": "2011-12-30" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "AVGEL30122011-07" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkLigplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanLigplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekLigplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanLigplaats": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een ligplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van ligplaats\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Ligplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] }, "standplaats": { "allOf": [ { "allOf": [ { "title": "StandplaatsIO", "required": [ "standplaats" ], "properties": { "standplaats": { "title": "Standplaats", "description": "Een Standplaats is een door het bevoegde gemeentelijke orgaan als\nzodanig aangewezen terrein of gedeelte daarvan dat bestemd is voor\nhet permanent plaatsen van een niet direct en niet duurzaam met de\naarde verbonden en voor woon-, bedrijfsmatige, of recreatieve\ndoeleinden geschikte ruimte.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een standplaats, waarin \nde betreffende standplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een standplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "StandplaatsIdentificatie", "pattern": "^[0-9]{4}03[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een standplaats.", "example": "0797030000056834" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Standplaats", "example": "NL.IMBAG.Standplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-10-05" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "AVGEL05102011-09" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkStandplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanStandplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekStandplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanStandplaats": { "title": "StandplaatsIdentificatie", "pattern": "^[0-9]{4}03[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een standplaats.", "example": "0797030000056834" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een standplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van standplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Standplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] }, "verblijfsobject": { "allOf": [ { "allOf": [ { "title": "VerblijfsobjectIO", "required": [ "verblijfsobject" ], "properties": { "verblijfsobject": { "title": "Verblijfsobject", "description": "Een Verblijfsobject is de kleinste binnen een of meer panden gelegen\nen voor woon-, bedrijfsmatige, of recreatieve doeleinden geschikte\neenheid van gebruik die ontsloten wordt via een eigen afsluitbare\ntoegang vanaf de openbare weg, een erf of een gedeelde\nverkeersruimte, onderwerp kan zijn van goederenrechtelijke\nrechtshandelingen en in functioneel opzicht zelfstandig is.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**geometrie**: De minimaal tweedimensionale geometrische representatie van \neen verblijfsobject.\n\n**status**: De fase van de levenscyclus van een verblijfsobject, waarin het \nbetreffende verblijfsobject zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "gebruiksdoelen", "geconstateerd", "geometrie", "identificatie", "maaktDeelUitVan", "oppervlakte", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "VerblijfsobjectIdentificatie", "pattern": "^[0-9]{4}01[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een verblijfsobject.", "example": "0226010000038820" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Verblijfsobject", "example": "NL.IMBAG.Verblijfsobject" }, "geometrie": { "title": "PuntOfVlak", "type": "object", "properties": { "punt": { "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "minItems": 2, "type": "array", "items": { "type": "number" } } } }, "vlak": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] } }, "description": "Een samengesteld geometriegegevenstype waarbij wordt afgedwongen dat voor de geometrie een \nkeuze gemaakt moet worden tussen een punt of een vlak.\n" }, "gebruiksdoelen": { "minItems": 1, "type": "array", "items": { "title": "Gebruiksdoel", "type": "string", "description": "Een categorisering waarmee het gebruiksdoel van een object kan worden verbijzonderd.", "enum": [ "woonfunctie", "bijeenkomstfunctie", "celfunctie", "gezondheidszorgfunctie", "industriefunctie", "kantoorfunctie", "logiesfunctie", "onderwijsfunctie", "sportfunctie", "winkelfunctie", "overige gebruiksfunctie" ] } }, "oppervlakte": { "title": "oppervlakte", "pattern": "^[1-9][0-9]{0,5}$", "type": "integer", "description": "De gebruiksoppervlakte van een verblijfsobject in gehele vierkante meters.", "example": 205 }, "status": { "title": "StatusVerblijfsobject", "type": "string", "description": "Een aanduiding van alle waarden die de status van een verblijfsobject kan aannemen.", "enum": [ "Verblijfsobject gevormd", "Niet gerealiseerd verblijfsobject", "Verblijfsobject in gebruik (niet ingemeten)", "Verblijfsobject in gebruik", "Verbouwing verblijfsobject", "Verblijfsobject ingetrokken", "Verblijfsobject buiten gebruik", "Verblijfsobject ten onrechte opgevoerd" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.\n", "format": "date", "example": "2019-11-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "19SZ2048" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "maaktDeelUitVan": { "minItems": 1, "type": "array", "description": "Een verblijfsobject maakt onderdeel uit van een pand.\n\nDeze property bevat de identificaties van de panden waar het verblijfsobject onderdeel van uitmaakt.\n", "items": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" } } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkVerblijfsobjectInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanVerblijfsobject", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekVerblijfsobject", "type": "string", "enum": [ "geometrie", "gebruiksdoel", "oppervlakte", "status", "maakt deel uit van", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanVerblijfsobject": { "title": "VerblijfsobjectIdentificatie", "pattern": "^[0-9]{4}01[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een verblijfsobject.", "example": "0226010000038820" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een verblijfsobject waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van verblijfsobject.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een verblijfsobject en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } }, { "properties": { "maaktDeelUitVan": { "minItems": 1, "type": "array", "description": "De panden (1 of meer) waarvan dit verblijfsobject deel uit maakt. Van deze panden: hiervan het voorkomen van pand die gevonden worden op basis van dezelfde tijdreisparameters als waarmee het verblijfsobject voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } }, { "properties": { "maaktDeelUitVan": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "PandIO", "required": [ "pand" ], "type": "object", "properties": { "pand": { "title": "Pand", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "oorspronkelijkBouwjaar", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Pand", "example": "NL.IMBAG.Pand" }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "oorspronkelijkBouwjaar": { "title": "Oorspronkelijk bouwjaar", "maxLength": 4, "pattern": "^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$", "type": "string", "description": "De aanduiding van het jaar waarin een pand oorspronkelijk als bouwkundig \ngereed is of zal worden opgeleverd.\n", "example": "1991" }, "status": { "title": "StatusPand", "type": "string", "description": "Een codering van de verschillende waarden die de status van een pand kan aannemen.\n", "enum": [ "Bouwvergunning verleend", "Niet gerealiseerd pand", "Bouw gestart", "Pand in gebruik (niet ingemeten)", "Pand in gebruik", "Verbouwing pand", "Sloopvergunning verleend", "Pand gesloopt", "Pand buiten gebruik", "Pand ten onrechte opgevoerd" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2009-05-12" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "09.BW.0273" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-\nconstructief zelfstandige eenheid die direct en duurzaam met de aarde is \nverbonden en betreedbaar en afsluitbaar is.\n\n**geometrie**: De minimaal tweedimensionale geometrische representatie van \nhet bovenaanzicht van de omtrekken van een pand.\n\n**status**: De fase van de levenscyclus van een pand, waarin het betreffende \npand zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve werkelijkheid, \nzoals beschreven met de eigenschappen van dit object waarover gegevens \ngeregistreerd worden, waarbij de gegevens gedurende een bepaalde periode \ngelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkPandInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanPand", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekPand", "type": "string", "enum": [ "geometrie", "oorspronkelijk bouwjaar", "status" ] }, "identificatieVanPand": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een pand waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van pand.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-constructief zelfstandige eenheid die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar is. Inclusief aanduiding of deze in onderzoek is" }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] } }, "description": "Een adresseerbaar object kan een ligplaats, standplaats of verblijfsobject zijn, er wordt van onderstaande properties dus altijd maar één ingevuld." } } } }, "_links": { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "404": { "description": "Not found.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 404, "title": "Opgevraagde resource bestaat niet.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", "detail": "The server has not found anything matching the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notFound" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "412": { "description": "Precondition failed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 412, "title": "Niet voldaan aan vooraf gestelde voorwaarde", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", "detail": "The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "preconditionFailed" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/adressen": { "get": { "tags": [ "Adres" ], "summary": "Bevragen van huidige adressen met een (combinatie van) zoek parameters.", "description": "De volgende bevragingen worden ondersteund:\n\n1. Bevragen van één of meer huidige adressen met postcode, huisnummer en optioneel huisnummertoevoeging en huisletter.\n Parameter exacteMatch kan worden toegepast.\n\n2. Bevragen van één of meer huidige adressen met de identificatie van een adresseerbaar object.\n\n3. Bevragen van één of meer huidige adressen met woonplaats naam, openbare ruimte naam, huisnummer en optioneel huisnummertoevoeging en/of huisletter.\n Parameter exacteMatch kan worden toegepast.\n\n4. Bevragen van één of meer huidige adressen met de identificatie van een pand.\n Expand wordt niet ondersteund.\n\n5. Zoek huidige adressen met een zoekterm.\n\n6. Bevragen van één of meer huidige adressen met de identificatie van een openbare ruimte.\n Expand wordt niet ondersteund.\n\n\nBij de bovenstaande bevragingen kunnen eveneens de volgende parameters worden gebruikt (tenzij anders vermeld):\n\nAls expand=nummeraanduiding, openbareRuimte, woonplaats, adresseerbaarObject, panden (of een combinatie daarvan) of als expand=true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd, zie\n[functionele specificatie expand](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature).\n\nVoor paginering, zie: [functionele specificatie paginering](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).\n\nAls inclusiefEindStatus=true, dan worden ook actuele adressen met een eind status geleverd, zie [functionele specificatie inclusiefEindstatus](https://github.com/lvbag/BAG-API/blob/master/Features/inclusief-eind-status.feature).\n", "operationId": "bevraagAdressen", "parameters": [ { "name": "zoekresultaatIdentificatie", "in": "query", "description": "De identificatie van een gekozen zoekresultaat uit de \nzoekResultatenHalCollectie verkregen bij een GET /adressen/zoek.\n", "required": false, "style": "form", "explode": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "postcode", "in": "query", "description": "Postcode behorende bij een nummeraanduiding.", "required": false, "style": "form", "explode": true, "schema": { "pattern": "^[1-9]{1}[0-9]{3}[ ]{0,1}[a-zA-Z]{2}$", "type": "string" }, "examples": { "zonderSpatie": { "value": "6922KZ" }, "metSpatie": { "value": "6922 KZ" } } }, { "name": "huisnummer", "in": "query", "description": "Huisnummer behorende bij een nummeraanduiding.", "required": false, "style": "form", "explode": true, "schema": { "maximum": 99999, "minimum": 1, "type": "integer", "example": 1 } }, { "name": "huisnummertoevoeging", "in": "query", "description": "Huisnummertoevoeging behorende bij een nummeraanduiding.", "required": false, "style": "form", "explode": true, "schema": { "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "example": "bis" } }, { "name": "huisletter", "in": "query", "description": "Huisletter behorende bij een nummeraanduiding.", "required": false, "style": "form", "explode": true, "schema": { "pattern": "^[a-zA-Z]{1}$", "type": "string", "example": "A" } }, { "name": "exacteMatch", "in": "query", "description": "Een indicatie of de resultaten van een zoekoperatie exact overeen \nmoeten komen met de zoekcriteria, zie \n[functionele specificatie exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true, "default": false } }, { "name": "adresseerbaarObjectIdentificatie", "in": "query", "description": "Identificatie van een adresseerbaar object uit de BAG.", "required": false, "style": "form", "explode": true, "schema": { "title": "AdresseerbaarobjectIdentificatie", "pattern": "^[0-9]{4}(01|02|03)[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) \nuit de BAG.\n", "example": "0226010000038820" } }, { "name": "woonplaatsNaam", "in": "query", "description": "Naam van een woonplaats.", "required": false, "style": "form", "explode": true, "schema": { "maxLength": 80, "minLength": 1, "type": "string", "example": "Duiven" } }, { "name": "openbareRuimteNaam", "in": "query", "description": "Naam van een openbare ruimte.", "required": false, "style": "form", "explode": true, "schema": { "maxLength": 80, "minLength": 1, "type": "string", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" } }, { "name": "pandIdentificatie", "in": "query", "description": "De identificatie van een pand uit de BAG.", "required": false, "style": "form", "explode": true, "schema": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" } }, { "name": "expand", "in": "query", "description": "Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Pagina nummer", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Aantal resultaten per pagina", "required": false, "style": "form", "explode": true, "schema": { "maximum": 100, "minimum": 10, "type": "integer", "default": 20 } }, { "name": "q", "in": "query", "description": "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, \nhuisnummertoevoeging.\n", "required": false, "style": "form", "explode": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "inclusiefEindStatus", "in": "query", "description": "Een indicatie of ook actuele voorkomens met een eind status geleverd moeten worden.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true, "default": false } }, { "name": "openbareRuimteIdentificatie", "in": "query", "description": "De identificatie van een openbare ruimte uit de BAG.", "required": false, "style": "form", "explode": true, "schema": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "bevraagAdressen geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "X-Pagination-Page": { "description": "Huidige pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 3 }, "example": 3 }, "X-Pagination-Limit": { "description": "Aantal resultaten per pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 20 }, "example": 20 }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "type": "object", "properties": { "_links": { "title": "HalPaginationLinks", "example": { "first": { "href": "/resourcenaam?page=1", "title": "Eerste pagina" }, "previous": { "href": "/resourcenaam?page=3", "title": "Vorige pagina" }, "next": { "href": "/resourcenaam?page=5", "title": "Volgende pagina" }, "last": { "href": "/resourcenaam?page=15", "title": "Laatste pagina" } }, "allOf": [ { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } }, { "type": "object", "properties": { "first": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "previous": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "next": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "last": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } ] }, "_embedded": { "type": "object", "properties": { "adressen": { "type": "array", "items": { "allOf": [ { "allOf": [ { "allOf": [ { "required": [ "huisnummer", "kortNaam", "nummeraanduidingIdentificatie", "openbareRuimteIdentificatie", "openbareRuimteNaam", "woonplaatsIdentificatie", "woonplaatsNaam" ], "type": "object", "properties": { "openbareRuimteNaam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe \nstrekkend formeel gemeentelijk besluit.\nHet betreft hier de straatnaam.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "korteNaam": { "title": "korteNaam", "maxLength": 24, "minLength": 1, "type": "string", "description": "De officiële openbare ruimte naam als deze niet langer is dan 24 tekens of de volgens de NEN5825 verkorte naam van maximaal 24 tekens.", "example": "Ln vd l D-Westervoort" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "woonplaatsNaam": { "title": "woonplaats naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.", "example": "Duiven" }, "nummeraanduidingIdentificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "openbareRuimteIdentificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "woonplaatsIdentificatie": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "adresseerbaarObjectIdentificatie": { "title": "AdresseerbaarobjectIdentificatie", "pattern": "^[0-9]{4}(01|02|03)[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) \nuit de BAG.\n", "example": "0226010000038820" }, "pandIdentificaties": { "type": "array", "description": "Identificatie(s) van het pand of de panden waar het verblijfsobject deel van uit maakt.", "items": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" } }, "indicatieNevenadres": { "type": "boolean", "description": "Indicatie dat dit adres een nevenadres is van een adresseerbaar object. Het adres is een hoofdadres als deze indicatie niet wordt meegeleverd." }, "adresregel5": { "type": "string", "description": "Adresregel 5 zoals beschreven in NEN 5825:2002 paragraaf 7.2.\nBevat: \n- straatnaam en indien aanwezig huisnummer en huisnummertoevoeging, \n waarbij huisnummertoevoeging een huisletter, huisnummertoevoeging of een combinatie van beide kan bevatten of\n- straatnaam en woonboot- of woonwagenverwijziging of\n- de aanduiding \"Postbus\" en het postbusnummer of\n- de aanduiding \"Antwoordnummer\" en het antwoordnummer of\n- de aanduiding \"PostApart\" en het PostApartnummer\n", "example": "Ln vd l D-Westervoort 1" }, "adresregel6": { "type": "string", "description": "Adresregel 6 zoals beschreven in NEN 5825:2002 paragraaf 7.2.\nBevat:\n postcode en woonplaats\n", "example": "6922 KZ DUIVEN" } }, "description": "Door het bevoegde gemeentelijke orgaan aan een verblijfsobject, een \nstandplaats of een ligplaats toegekende benaming, bestaande uit een \ncombinatie van de naam van een openbare ruimte, het huisnummer, een \neventuele huisletter en huisnummertoevoeging van de nummeraanduiding \nen de naam van de woonplaats.\n" }, { "properties": { "geconstateerd": { "type": "object", "properties": { "woonplaats": { "type": "boolean" }, "openbareRuimte": { "type": "boolean" }, "nummeraanduiding": { "type": "boolean" } }, "description": "Wanneer hier een property is opgenomen met de waarde true, dan is de aan het adres gerelateerde gelijknamige resource geconstateerd. Geconstateerd is een aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake was van een regulier brondocument voor deze opname." }, "inonderzoek": { "type": "object", "properties": { "openbareRuimteNaam": { "type": "boolean" }, "korteNaam": { "type": "boolean" }, "huisnummer": { "type": "boolean" }, "huisletter": { "type": "boolean" }, "huisnummertoevoeging": { "type": "boolean" }, "postcode": { "type": "boolean" }, "woonplaatsNaam": { "type": "boolean" }, "openbareRuimteLigtIn": { "type": "boolean", "description": "\"Als de nummeraanduidingLigtIn false is (deze is niet in onderzoek) en de openbareRuimteLigtIn is true (deze is wel in onderzoek) maar is gerelateerd aan een andere woonplaats dan de nummeraanduiding, \ndan wordt de boolean hier niet gezet. Deze is dan niet relevant omdat dan de woonplaats wordt gebruikt die gerelateerd is aan de nummeraanduiding.\"\n" }, "openbareRuimteStatus": { "type": "boolean" }, "nummeraanduidingLigtIn": { "type": "boolean" }, "nummeraanduidingligtAan": { "type": "boolean" }, "nummeraanduidingStatus": { "type": "boolean" }, "toelichting": { "type": "array", "items": { "type": "string", "example": "Woonplaatsnaam is mogelijk onjuist geschreven." } }, "adresregel5": { "type": "boolean" }, "adresregel6": { "type": "boolean" } }, "description": "Wanneer hier een property is opgenomen met de waarde true, dan is de waarde van het gelijknamige property in de resource in onderzoek. De juistheid van dit gegeven wordt op dit moment onderzocht. Onder property toelichting wordt toegelicht wat er mogelijk onjuist is aan het betreffende gegeven." } } } ] }, { "properties": { "_links": { "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "openbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "nummeraanduiding": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "woonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "adresseerbaarObject": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "panden": { "type": "array", "description": "Het/de aan het adres gerelateerde pand(en).", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } ] }, { "properties": { "_embedded": { "type": "object", "properties": { "openbareRuimte": { "allOf": [ { "title": "OpenbareRuimteIO (incl. in onderzoek)", "required": [ "openbareRuimte" ], "type": "object", "properties": { "openbareRuimte": { "title": "OpenbareRuimte", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "korteNaam", "ligtIn", "naam", "status", "type", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Openbareruimte", "example": "NL.IMBAG.Openbareruimte" }, "naam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe strekkend \nformeel gemeentelijk besluit.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "type": { "title": "TypeOpenbareRuimte", "type": "string", "description": "Een codering van de verschillende waarden die de typering van een openbare \nruimte kan aannemen.\n", "enum": [ "Weg", "Water", "Spoorbaan", "Terrein", "Kunstwerk", "Landschappelijk gebied", "Administratief gebied" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "korteNaam": { "title": "korteNaam", "maxLength": 24, "minLength": 1, "type": "string", "description": "De officiële openbare ruimte naam als deze niet langer is dan 24 tekens of \nde volgens de NEN5825 verkorte naam van maximaal 24 tekens.\n", "example": "Ln vd l D-Westervoort" }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-08-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "11INT00398" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" } }, "description": "Een Openbare ruimte is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorziene buitenruimte die binnen één woonplaats \nis gelegen.\n\n**type**: De aard van de als zodanig benoemde openbare ruimte.\n\n**status**: De fase van de levenscyclus van een openbare ruimte, waarin de \nbetreffende openbare ruimte zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een openbare ruimte ligt in een woonplaats.\nDeze property bevat de identificatie van de woonplaats waar de openbare\nruimte in ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkOpenbareRuimteInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanOpenbareRuimte", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekOpenbareRuimte", "type": "string", "enum": [ "naam", "type", "status", "gerelateerde woonplaats" ] }, "identificatieVanOpenbareRuimte": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een openbare ruimte waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van openbare ruimte.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Openbare ruimte, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "nummeraanduiding": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "woonplaats": { "allOf": [ { "title": "WoonplaatsIO (incl. inonderzoek informatie)", "required": [ "woonplaats" ], "type": "object", "properties": { "woonplaats": { "title": "Woonplaats", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "naam", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Woonplaats", "example": "NL.IMBAG.Woonplaats" }, "naam": { "title": "naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.", "example": "Duiven" }, "status": { "title": "StatusWoonplaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen.", "enum": [ "Woonplaats aangewezen", "Woonplaats ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2009-02-09" }, "documentnummer": { "title": "documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "09.0898" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Woonplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorzien gedeelte van het grondgebied van de \ngemeente.\n\n**status**: De fase van de levenscyclus van een woonplaats, waarin de \nbetreffende woonplaats zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkWoonplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanWoonplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekWoonplaats", "type": "string", "enum": [ "naam", "geometrie", "status" ] }, "identificatieVanWoonplaats": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is. \n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'. \n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een woonplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van woonplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Woonplaats, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn (als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "bronhouders": { "minItems": 1, "type": "array", "description": "De gemeente(n) waar de woonplaats onderdeel van uitmaakt.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } ] }, "adresseerbaarObject": { "title": "AdresseerbaarObjectIO", "type": "object", "properties": { "_links": { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } }, "ligplaats": { "allOf": [ { "allOf": [ { "title": "LigplaatsIO", "required": [ "ligplaats" ], "properties": { "ligplaats": { "title": "Ligplaats", "description": "Een Ligplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen plaats in het water al dan niet aangevuld met een op de oever \naanwezig terrein of een gedeelte daarvan, die bestemd is voor het permanent \nafmeren van een voor woon-, bedrijfsmatige of recreatieve doeleinden \ngeschikt drijvend object.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een ligplaats, waarin de \nbetreffende ligplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een ligplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Ligplaats", "example": "NL.IMBAG.Ligplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een \nopname, mutatie of een verwijdering van gegevens ten aanzien van een \nobject heeft plaatsgevonden.\n", "format": "date", "example": "2011-12-30" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "AVGEL30122011-07" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkLigplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanLigplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekLigplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanLigplaats": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een ligplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van ligplaats\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Ligplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] }, "standplaats": { "allOf": [ { "allOf": [ { "title": "StandplaatsIO", "required": [ "standplaats" ], "properties": { "standplaats": { "title": "Standplaats", "description": "Een Standplaats is een door het bevoegde gemeentelijke orgaan als\nzodanig aangewezen terrein of gedeelte daarvan dat bestemd is voor\nhet permanent plaatsen van een niet direct en niet duurzaam met de\naarde verbonden en voor woon-, bedrijfsmatige, of recreatieve\ndoeleinden geschikte ruimte.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een standplaats, waarin \nde betreffende standplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een standplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "StandplaatsIdentificatie", "pattern": "^[0-9]{4}03[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een standplaats.", "example": "0797030000056834" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Standplaats", "example": "NL.IMBAG.Standplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-10-05" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "AVGEL05102011-09" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkStandplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanStandplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekStandplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanStandplaats": { "title": "StandplaatsIdentificatie", "pattern": "^[0-9]{4}03[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een standplaats.", "example": "0797030000056834" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een standplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van standplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Standplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] }, "verblijfsobject": { "allOf": [ { "allOf": [ { "title": "VerblijfsobjectIO", "required": [ "verblijfsobject" ], "properties": { "verblijfsobject": { "title": "Verblijfsobject", "description": "Een Verblijfsobject is de kleinste binnen een of meer panden gelegen\nen voor woon-, bedrijfsmatige, of recreatieve doeleinden geschikte\neenheid van gebruik die ontsloten wordt via een eigen afsluitbare\ntoegang vanaf de openbare weg, een erf of een gedeelde\nverkeersruimte, onderwerp kan zijn van goederenrechtelijke\nrechtshandelingen en in functioneel opzicht zelfstandig is.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**geometrie**: De minimaal tweedimensionale geometrische representatie van \neen verblijfsobject.\n\n**status**: De fase van de levenscyclus van een verblijfsobject, waarin het \nbetreffende verblijfsobject zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "gebruiksdoelen", "geconstateerd", "geometrie", "identificatie", "maaktDeelUitVan", "oppervlakte", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "VerblijfsobjectIdentificatie", "pattern": "^[0-9]{4}01[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een verblijfsobject.", "example": "0226010000038820" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Verblijfsobject", "example": "NL.IMBAG.Verblijfsobject" }, "geometrie": { "title": "PuntOfVlak", "type": "object", "properties": { "punt": { "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "minItems": 2, "type": "array", "items": { "type": "number" } } } }, "vlak": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] } }, "description": "Een samengesteld geometriegegevenstype waarbij wordt afgedwongen dat voor de geometrie een \nkeuze gemaakt moet worden tussen een punt of een vlak.\n" }, "gebruiksdoelen": { "minItems": 1, "type": "array", "items": { "title": "Gebruiksdoel", "type": "string", "description": "Een categorisering waarmee het gebruiksdoel van een object kan worden verbijzonderd.", "enum": [ "woonfunctie", "bijeenkomstfunctie", "celfunctie", "gezondheidszorgfunctie", "industriefunctie", "kantoorfunctie", "logiesfunctie", "onderwijsfunctie", "sportfunctie", "winkelfunctie", "overige gebruiksfunctie" ] } }, "oppervlakte": { "title": "oppervlakte", "pattern": "^[1-9][0-9]{0,5}$", "type": "integer", "description": "De gebruiksoppervlakte van een verblijfsobject in gehele vierkante meters.", "example": 205 }, "status": { "title": "StatusVerblijfsobject", "type": "string", "description": "Een aanduiding van alle waarden die de status van een verblijfsobject kan aannemen.", "enum": [ "Verblijfsobject gevormd", "Niet gerealiseerd verblijfsobject", "Verblijfsobject in gebruik (niet ingemeten)", "Verblijfsobject in gebruik", "Verbouwing verblijfsobject", "Verblijfsobject ingetrokken", "Verblijfsobject buiten gebruik", "Verblijfsobject ten onrechte opgevoerd" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.\n", "format": "date", "example": "2019-11-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "19SZ2048" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "maaktDeelUitVan": { "minItems": 1, "type": "array", "description": "Een verblijfsobject maakt onderdeel uit van een pand.\n\nDeze property bevat de identificaties van de panden waar het verblijfsobject onderdeel van uitmaakt.\n", "items": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" } } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkVerblijfsobjectInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanVerblijfsobject", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekVerblijfsobject", "type": "string", "enum": [ "geometrie", "gebruiksdoel", "oppervlakte", "status", "maakt deel uit van", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanVerblijfsobject": { "title": "VerblijfsobjectIdentificatie", "pattern": "^[0-9]{4}01[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een verblijfsobject.", "example": "0226010000038820" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een verblijfsobject waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van verblijfsobject.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een verblijfsobject en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } }, { "properties": { "maaktDeelUitVan": { "minItems": 1, "type": "array", "description": "De panden (1 of meer) waarvan dit verblijfsobject deel uit maakt. Van deze panden: hiervan het voorkomen van pand die gevonden worden op basis van dezelfde tijdreisparameters als waarmee het verblijfsobject voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } }, { "properties": { "maaktDeelUitVan": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "PandIO", "required": [ "pand" ], "type": "object", "properties": { "pand": { "title": "Pand", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "oorspronkelijkBouwjaar", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Pand", "example": "NL.IMBAG.Pand" }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "oorspronkelijkBouwjaar": { "title": "Oorspronkelijk bouwjaar", "maxLength": 4, "pattern": "^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$", "type": "string", "description": "De aanduiding van het jaar waarin een pand oorspronkelijk als bouwkundig \ngereed is of zal worden opgeleverd.\n", "example": "1991" }, "status": { "title": "StatusPand", "type": "string", "description": "Een codering van de verschillende waarden die de status van een pand kan aannemen.\n", "enum": [ "Bouwvergunning verleend", "Niet gerealiseerd pand", "Bouw gestart", "Pand in gebruik (niet ingemeten)", "Pand in gebruik", "Verbouwing pand", "Sloopvergunning verleend", "Pand gesloopt", "Pand buiten gebruik", "Pand ten onrechte opgevoerd" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2009-05-12" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "09.BW.0273" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-\nconstructief zelfstandige eenheid die direct en duurzaam met de aarde is \nverbonden en betreedbaar en afsluitbaar is.\n\n**geometrie**: De minimaal tweedimensionale geometrische representatie van \nhet bovenaanzicht van de omtrekken van een pand.\n\n**status**: De fase van de levenscyclus van een pand, waarin het betreffende \npand zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve werkelijkheid, \nzoals beschreven met de eigenschappen van dit object waarover gegevens \ngeregistreerd worden, waarbij de gegevens gedurende een bepaalde periode \ngelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkPandInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanPand", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekPand", "type": "string", "enum": [ "geometrie", "oorspronkelijk bouwjaar", "status" ] }, "identificatieVanPand": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een pand waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van pand.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-constructief zelfstandige eenheid die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar is. Inclusief aanduiding of deze in onderzoek is" }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] } }, "description": "Een adresseerbaar object kan een ligplaats, standplaats of verblijfsobject zijn, er wordt van onderstaande properties dus altijd maar één ingevuld." }, "panden": { "type": "array", "items": { "allOf": [ { "title": "PandIO", "required": [ "pand" ], "type": "object", "properties": { "pand": { "title": "Pand", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "oorspronkelijkBouwjaar", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Pand", "example": "NL.IMBAG.Pand" }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "oorspronkelijkBouwjaar": { "title": "Oorspronkelijk bouwjaar", "maxLength": 4, "pattern": "^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$", "type": "string", "description": "De aanduiding van het jaar waarin een pand oorspronkelijk als bouwkundig \ngereed is of zal worden opgeleverd.\n", "example": "1991" }, "status": { "title": "StatusPand", "type": "string", "description": "Een codering van de verschillende waarden die de status van een pand kan aannemen.\n", "enum": [ "Bouwvergunning verleend", "Niet gerealiseerd pand", "Bouw gestart", "Pand in gebruik (niet ingemeten)", "Pand in gebruik", "Verbouwing pand", "Sloopvergunning verleend", "Pand gesloopt", "Pand buiten gebruik", "Pand ten onrechte opgevoerd" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2009-05-12" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "09.BW.0273" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-\nconstructief zelfstandige eenheid die direct en duurzaam met de aarde is \nverbonden en betreedbaar en afsluitbaar is.\n\n**geometrie**: De minimaal tweedimensionale geometrische representatie van \nhet bovenaanzicht van de omtrekken van een pand.\n\n**status**: De fase van de levenscyclus van een pand, waarin het betreffende \npand zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve werkelijkheid, \nzoals beschreven met de eigenschappen van dit object waarover gegevens \ngeregistreerd worden, waarbij de gegevens gedurende een bepaalde periode \ngelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkPandInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanPand", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekPand", "type": "string", "enum": [ "geometrie", "oorspronkelijk bouwjaar", "status" ] }, "identificatieVanPand": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een pand waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van pand.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-constructief zelfstandige eenheid die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar is. Inclusief aanduiding of deze in onderzoek is" }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } } } ] } } } } } } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "412": { "description": "Precondition failed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 412, "title": "Niet voldaan aan vooraf gestelde voorwaarde", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", "detail": "The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "preconditionFailed" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/adressen/zoek": { "get": { "tags": [ "Adres" ], "summary": "Zoeken van huidige adressen", "description": "Zoeken van huidige adressen met postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging. \nEen adres kan worden gevonden door de zoekresultaatidentificatie uit het antwoord als parameter mee te geven in get /adressen.\n\nVoor paginering, zie: [functionele specificatie paginering](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).\n", "operationId": "zoek", "parameters": [ { "name": "zoek", "in": "query", "description": "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, \nhuisnummertoevoeging.\n", "required": true, "style": "form", "explode": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "page", "in": "query", "description": "Pagina nummer", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Aantal resultaten per pagina", "required": false, "style": "form", "explode": true, "schema": { "maximum": 100, "minimum": 10, "type": "integer", "default": 20 } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Zoek adres geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "X-Pagination-Page": { "description": "Huidige pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 3 }, "example": 3 }, "X-Pagination-Limit": { "description": "Aantal resultaten per pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 20 }, "example": 20 }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "type": "object", "properties": { "_links": { "title": "HalPaginationLinks", "example": { "first": { "href": "/resourcenaam?page=1", "title": "Eerste pagina" }, "previous": { "href": "/resourcenaam?page=3", "title": "Vorige pagina" }, "next": { "href": "/resourcenaam?page=5", "title": "Volgende pagina" }, "last": { "href": "/resourcenaam?page=15", "title": "Laatste pagina" } }, "allOf": [ { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } }, { "type": "object", "properties": { "first": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "previous": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "next": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "last": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } ] }, "_embedded": { "type": "object", "properties": { "zoekresultaten": { "type": "array", "items": { "deprecated": true, "allOf": [ { "required": [ "identificatie" ], "type": "object", "properties": { "omschrijving": { "type": "string", "description": "Omschrijving van het zoekresultaat" }, "identificatie": { "type": "string", "description": "Identificatie van het zoekresultaat" } }, "description": "Resultaat van een zoekoperatie dat je kunt gebruiken om een adres te vinden met /adressen", "deprecated": true }, { "properties": { "_links": { "type": "object", "properties": { "adres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } }, "deprecated": true } } } ] } } }, "deprecated": true } }, "description": "Resultaten als lijst", "deprecated": true } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "deprecated": true, "security": [ { "apiKeyBAG": [] } ] } }, "/adressen/{nummeraanduidingIdentificatie}": { "get": { "tags": [ "Adres" ], "summary": "Bevragen van een huidig adres met de identificatie van een nummeraanduiding.", "description": "Bevragen van een huidig adres met de identificatie van een nummeraanduiding.\n\nAls expand=nummeraanduiding, openbareRuimte, woonplaats, adresseerbaarObject, panden (of een combinatie daarvan) of als expand=true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd, zie\n[functionele specificatie expand](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature).\n\nAls inclusiefEindStatus=true, dan worden ook actuele adressen met een eind status geleverd, zie [functionele specificatie inclusiefEindstatus](https://github.com/lvbag/BAG-API/blob/master/Features/inclusief-eind-status.feature).\n", "operationId": "bevraagAdressenMetNumId", "parameters": [ { "name": "nummeraanduidingIdentificatie", "in": "path", "description": "De identificatie van een nummeraanduiding uit de BAG.", "required": true, "style": "simple", "explode": false, "schema": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, { "name": "expand", "in": "query", "description": "Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "inclusiefEindStatus", "in": "query", "description": "Een indicatie of ook actuele voorkomens met een eind status geleverd moeten worden.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true, "default": false } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "bevraagAdressenMetNumId geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "X-Pagination-Page": { "description": "Huidige pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 3 }, "example": 3 }, "X-Pagination-Limit": { "description": "Aantal resultaten per pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 20 }, "example": 20 }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "allOf": [ { "allOf": [ { "allOf": [ { "required": [ "huisnummer", "kortNaam", "nummeraanduidingIdentificatie", "openbareRuimteIdentificatie", "openbareRuimteNaam", "woonplaatsIdentificatie", "woonplaatsNaam" ], "type": "object", "properties": { "openbareRuimteNaam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe \nstrekkend formeel gemeentelijk besluit.\nHet betreft hier de straatnaam.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "korteNaam": { "title": "korteNaam", "maxLength": 24, "minLength": 1, "type": "string", "description": "De officiële openbare ruimte naam als deze niet langer is dan 24 tekens of de volgens de NEN5825 verkorte naam van maximaal 24 tekens.", "example": "Ln vd l D-Westervoort" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "woonplaatsNaam": { "title": "woonplaats naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.", "example": "Duiven" }, "nummeraanduidingIdentificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "openbareRuimteIdentificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "woonplaatsIdentificatie": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "adresseerbaarObjectIdentificatie": { "title": "AdresseerbaarobjectIdentificatie", "pattern": "^[0-9]{4}(01|02|03)[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) \nuit de BAG.\n", "example": "0226010000038820" }, "pandIdentificaties": { "type": "array", "description": "Identificatie(s) van het pand of de panden waar het verblijfsobject deel van uit maakt.", "items": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" } }, "indicatieNevenadres": { "type": "boolean", "description": "Indicatie dat dit adres een nevenadres is van een adresseerbaar object. Het adres is een hoofdadres als deze indicatie niet wordt meegeleverd." }, "adresregel5": { "type": "string", "description": "Adresregel 5 zoals beschreven in NEN 5825:2002 paragraaf 7.2.\nBevat: \n- straatnaam en indien aanwezig huisnummer en huisnummertoevoeging, \n waarbij huisnummertoevoeging een huisletter, huisnummertoevoeging of een combinatie van beide kan bevatten of\n- straatnaam en woonboot- of woonwagenverwijziging of\n- de aanduiding \"Postbus\" en het postbusnummer of\n- de aanduiding \"Antwoordnummer\" en het antwoordnummer of\n- de aanduiding \"PostApart\" en het PostApartnummer\n", "example": "Ln vd l D-Westervoort 1" }, "adresregel6": { "type": "string", "description": "Adresregel 6 zoals beschreven in NEN 5825:2002 paragraaf 7.2.\nBevat:\n postcode en woonplaats\n", "example": "6922 KZ DUIVEN" } }, "description": "Door het bevoegde gemeentelijke orgaan aan een verblijfsobject, een \nstandplaats of een ligplaats toegekende benaming, bestaande uit een \ncombinatie van de naam van een openbare ruimte, het huisnummer, een \neventuele huisletter en huisnummertoevoeging van de nummeraanduiding \nen de naam van de woonplaats.\n" }, { "properties": { "geconstateerd": { "type": "object", "properties": { "woonplaats": { "type": "boolean" }, "openbareRuimte": { "type": "boolean" }, "nummeraanduiding": { "type": "boolean" } }, "description": "Wanneer hier een property is opgenomen met de waarde true, dan is de aan het adres gerelateerde gelijknamige resource geconstateerd. Geconstateerd is een aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake was van een regulier brondocument voor deze opname." }, "inonderzoek": { "type": "object", "properties": { "openbareRuimteNaam": { "type": "boolean" }, "korteNaam": { "type": "boolean" }, "huisnummer": { "type": "boolean" }, "huisletter": { "type": "boolean" }, "huisnummertoevoeging": { "type": "boolean" }, "postcode": { "type": "boolean" }, "woonplaatsNaam": { "type": "boolean" }, "openbareRuimteLigtIn": { "type": "boolean", "description": "\"Als de nummeraanduidingLigtIn false is (deze is niet in onderzoek) en de openbareRuimteLigtIn is true (deze is wel in onderzoek) maar is gerelateerd aan een andere woonplaats dan de nummeraanduiding, \ndan wordt de boolean hier niet gezet. Deze is dan niet relevant omdat dan de woonplaats wordt gebruikt die gerelateerd is aan de nummeraanduiding.\"\n" }, "openbareRuimteStatus": { "type": "boolean" }, "nummeraanduidingLigtIn": { "type": "boolean" }, "nummeraanduidingligtAan": { "type": "boolean" }, "nummeraanduidingStatus": { "type": "boolean" }, "toelichting": { "type": "array", "items": { "type": "string", "example": "Woonplaatsnaam is mogelijk onjuist geschreven." } }, "adresregel5": { "type": "boolean" }, "adresregel6": { "type": "boolean" } }, "description": "Wanneer hier een property is opgenomen met de waarde true, dan is de waarde van het gelijknamige property in de resource in onderzoek. De juistheid van dit gegeven wordt op dit moment onderzocht. Onder property toelichting wordt toegelicht wat er mogelijk onjuist is aan het betreffende gegeven." } } } ] }, { "properties": { "_links": { "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "openbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "nummeraanduiding": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "woonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "adresseerbaarObject": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "panden": { "type": "array", "description": "Het/de aan het adres gerelateerde pand(en).", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } ] }, { "properties": { "_embedded": { "type": "object", "properties": { "openbareRuimte": { "allOf": [ { "title": "OpenbareRuimteIO (incl. in onderzoek)", "required": [ "openbareRuimte" ], "type": "object", "properties": { "openbareRuimte": { "title": "OpenbareRuimte", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "korteNaam", "ligtIn", "naam", "status", "type", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Openbareruimte", "example": "NL.IMBAG.Openbareruimte" }, "naam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe strekkend \nformeel gemeentelijk besluit.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "type": { "title": "TypeOpenbareRuimte", "type": "string", "description": "Een codering van de verschillende waarden die de typering van een openbare \nruimte kan aannemen.\n", "enum": [ "Weg", "Water", "Spoorbaan", "Terrein", "Kunstwerk", "Landschappelijk gebied", "Administratief gebied" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "korteNaam": { "title": "korteNaam", "maxLength": 24, "minLength": 1, "type": "string", "description": "De officiële openbare ruimte naam als deze niet langer is dan 24 tekens of \nde volgens de NEN5825 verkorte naam van maximaal 24 tekens.\n", "example": "Ln vd l D-Westervoort" }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-08-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "11INT00398" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" } }, "description": "Een Openbare ruimte is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorziene buitenruimte die binnen één woonplaats \nis gelegen.\n\n**type**: De aard van de als zodanig benoemde openbare ruimte.\n\n**status**: De fase van de levenscyclus van een openbare ruimte, waarin de \nbetreffende openbare ruimte zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een openbare ruimte ligt in een woonplaats.\nDeze property bevat de identificatie van de woonplaats waar de openbare\nruimte in ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkOpenbareRuimteInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanOpenbareRuimte", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekOpenbareRuimte", "type": "string", "enum": [ "naam", "type", "status", "gerelateerde woonplaats" ] }, "identificatieVanOpenbareRuimte": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een openbare ruimte waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van openbare ruimte.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Openbare ruimte, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "nummeraanduiding": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "woonplaats": { "allOf": [ { "title": "WoonplaatsIO (incl. inonderzoek informatie)", "required": [ "woonplaats" ], "type": "object", "properties": { "woonplaats": { "title": "Woonplaats", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "naam", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Woonplaats", "example": "NL.IMBAG.Woonplaats" }, "naam": { "title": "naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.", "example": "Duiven" }, "status": { "title": "StatusWoonplaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen.", "enum": [ "Woonplaats aangewezen", "Woonplaats ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2009-02-09" }, "documentnummer": { "title": "documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "09.0898" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Woonplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorzien gedeelte van het grondgebied van de \ngemeente.\n\n**status**: De fase van de levenscyclus van een woonplaats, waarin de \nbetreffende woonplaats zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkWoonplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanWoonplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekWoonplaats", "type": "string", "enum": [ "naam", "geometrie", "status" ] }, "identificatieVanWoonplaats": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is. \n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'. \n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een woonplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van woonplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Woonplaats, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn (als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "bronhouders": { "minItems": 1, "type": "array", "description": "De gemeente(n) waar de woonplaats onderdeel van uitmaakt.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } ] }, "adresseerbaarObject": { "title": "AdresseerbaarObjectIO", "type": "object", "properties": { "_links": { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } }, "ligplaats": { "allOf": [ { "allOf": [ { "title": "LigplaatsIO", "required": [ "ligplaats" ], "properties": { "ligplaats": { "title": "Ligplaats", "description": "Een Ligplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen plaats in het water al dan niet aangevuld met een op de oever \naanwezig terrein of een gedeelte daarvan, die bestemd is voor het permanent \nafmeren van een voor woon-, bedrijfsmatige of recreatieve doeleinden \ngeschikt drijvend object.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een ligplaats, waarin de \nbetreffende ligplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een ligplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Ligplaats", "example": "NL.IMBAG.Ligplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een \nopname, mutatie of een verwijdering van gegevens ten aanzien van een \nobject heeft plaatsgevonden.\n", "format": "date", "example": "2011-12-30" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "AVGEL30122011-07" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkLigplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanLigplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekLigplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanLigplaats": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een ligplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van ligplaats\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Ligplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] }, "standplaats": { "allOf": [ { "allOf": [ { "title": "StandplaatsIO", "required": [ "standplaats" ], "properties": { "standplaats": { "title": "Standplaats", "description": "Een Standplaats is een door het bevoegde gemeentelijke orgaan als\nzodanig aangewezen terrein of gedeelte daarvan dat bestemd is voor\nhet permanent plaatsen van een niet direct en niet duurzaam met de\naarde verbonden en voor woon-, bedrijfsmatige, of recreatieve\ndoeleinden geschikte ruimte.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een standplaats, waarin \nde betreffende standplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een standplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "StandplaatsIdentificatie", "pattern": "^[0-9]{4}03[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een standplaats.", "example": "0797030000056834" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Standplaats", "example": "NL.IMBAG.Standplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-10-05" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "AVGEL05102011-09" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkStandplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanStandplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekStandplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanStandplaats": { "title": "StandplaatsIdentificatie", "pattern": "^[0-9]{4}03[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een standplaats.", "example": "0797030000056834" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een standplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van standplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Standplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] }, "verblijfsobject": { "allOf": [ { "allOf": [ { "title": "VerblijfsobjectIO", "required": [ "verblijfsobject" ], "properties": { "verblijfsobject": { "title": "Verblijfsobject", "description": "Een Verblijfsobject is de kleinste binnen een of meer panden gelegen\nen voor woon-, bedrijfsmatige, of recreatieve doeleinden geschikte\neenheid van gebruik die ontsloten wordt via een eigen afsluitbare\ntoegang vanaf de openbare weg, een erf of een gedeelde\nverkeersruimte, onderwerp kan zijn van goederenrechtelijke\nrechtshandelingen en in functioneel opzicht zelfstandig is.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**geometrie**: De minimaal tweedimensionale geometrische representatie van \neen verblijfsobject.\n\n**status**: De fase van de levenscyclus van een verblijfsobject, waarin het \nbetreffende verblijfsobject zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "gebruiksdoelen", "geconstateerd", "geometrie", "identificatie", "maaktDeelUitVan", "oppervlakte", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "VerblijfsobjectIdentificatie", "pattern": "^[0-9]{4}01[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een verblijfsobject.", "example": "0226010000038820" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Verblijfsobject", "example": "NL.IMBAG.Verblijfsobject" }, "geometrie": { "title": "PuntOfVlak", "type": "object", "properties": { "punt": { "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "minItems": 2, "type": "array", "items": { "type": "number" } } } }, "vlak": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] } }, "description": "Een samengesteld geometriegegevenstype waarbij wordt afgedwongen dat voor de geometrie een \nkeuze gemaakt moet worden tussen een punt of een vlak.\n" }, "gebruiksdoelen": { "minItems": 1, "type": "array", "items": { "title": "Gebruiksdoel", "type": "string", "description": "Een categorisering waarmee het gebruiksdoel van een object kan worden verbijzonderd.", "enum": [ "woonfunctie", "bijeenkomstfunctie", "celfunctie", "gezondheidszorgfunctie", "industriefunctie", "kantoorfunctie", "logiesfunctie", "onderwijsfunctie", "sportfunctie", "winkelfunctie", "overige gebruiksfunctie" ] } }, "oppervlakte": { "title": "oppervlakte", "pattern": "^[1-9][0-9]{0,5}$", "type": "integer", "description": "De gebruiksoppervlakte van een verblijfsobject in gehele vierkante meters.", "example": 205 }, "status": { "title": "StatusVerblijfsobject", "type": "string", "description": "Een aanduiding van alle waarden die de status van een verblijfsobject kan aannemen.", "enum": [ "Verblijfsobject gevormd", "Niet gerealiseerd verblijfsobject", "Verblijfsobject in gebruik (niet ingemeten)", "Verblijfsobject in gebruik", "Verbouwing verblijfsobject", "Verblijfsobject ingetrokken", "Verblijfsobject buiten gebruik", "Verblijfsobject ten onrechte opgevoerd" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.\n", "format": "date", "example": "2019-11-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "19SZ2048" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "maaktDeelUitVan": { "minItems": 1, "type": "array", "description": "Een verblijfsobject maakt onderdeel uit van een pand.\n\nDeze property bevat de identificaties van de panden waar het verblijfsobject onderdeel van uitmaakt.\n", "items": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" } } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkVerblijfsobjectInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanVerblijfsobject", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekVerblijfsobject", "type": "string", "enum": [ "geometrie", "gebruiksdoel", "oppervlakte", "status", "maakt deel uit van", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanVerblijfsobject": { "title": "VerblijfsobjectIdentificatie", "pattern": "^[0-9]{4}01[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een verblijfsobject.", "example": "0226010000038820" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een verblijfsobject waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van verblijfsobject.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een verblijfsobject en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } }, { "properties": { "maaktDeelUitVan": { "minItems": 1, "type": "array", "description": "De panden (1 of meer) waarvan dit verblijfsobject deel uit maakt. Van deze panden: hiervan het voorkomen van pand die gevonden worden op basis van dezelfde tijdreisparameters als waarmee het verblijfsobject voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } }, { "properties": { "maaktDeelUitVan": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "PandIO", "required": [ "pand" ], "type": "object", "properties": { "pand": { "title": "Pand", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "oorspronkelijkBouwjaar", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Pand", "example": "NL.IMBAG.Pand" }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "oorspronkelijkBouwjaar": { "title": "Oorspronkelijk bouwjaar", "maxLength": 4, "pattern": "^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$", "type": "string", "description": "De aanduiding van het jaar waarin een pand oorspronkelijk als bouwkundig \ngereed is of zal worden opgeleverd.\n", "example": "1991" }, "status": { "title": "StatusPand", "type": "string", "description": "Een codering van de verschillende waarden die de status van een pand kan aannemen.\n", "enum": [ "Bouwvergunning verleend", "Niet gerealiseerd pand", "Bouw gestart", "Pand in gebruik (niet ingemeten)", "Pand in gebruik", "Verbouwing pand", "Sloopvergunning verleend", "Pand gesloopt", "Pand buiten gebruik", "Pand ten onrechte opgevoerd" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2009-05-12" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "09.BW.0273" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-\nconstructief zelfstandige eenheid die direct en duurzaam met de aarde is \nverbonden en betreedbaar en afsluitbaar is.\n\n**geometrie**: De minimaal tweedimensionale geometrische representatie van \nhet bovenaanzicht van de omtrekken van een pand.\n\n**status**: De fase van de levenscyclus van een pand, waarin het betreffende \npand zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve werkelijkheid, \nzoals beschreven met de eigenschappen van dit object waarover gegevens \ngeregistreerd worden, waarbij de gegevens gedurende een bepaalde periode \ngelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkPandInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanPand", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekPand", "type": "string", "enum": [ "geometrie", "oorspronkelijk bouwjaar", "status" ] }, "identificatieVanPand": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een pand waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van pand.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-constructief zelfstandige eenheid die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar is. Inclusief aanduiding of deze in onderzoek is" }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] } }, "description": "Een adresseerbaar object kan een ligplaats, standplaats of verblijfsobject zijn, er wordt van onderstaande properties dus altijd maar één ingevuld." }, "panden": { "type": "array", "items": { "allOf": [ { "title": "PandIO", "required": [ "pand" ], "type": "object", "properties": { "pand": { "title": "Pand", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "oorspronkelijkBouwjaar", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Pand", "example": "NL.IMBAG.Pand" }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "oorspronkelijkBouwjaar": { "title": "Oorspronkelijk bouwjaar", "maxLength": 4, "pattern": "^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$", "type": "string", "description": "De aanduiding van het jaar waarin een pand oorspronkelijk als bouwkundig \ngereed is of zal worden opgeleverd.\n", "example": "1991" }, "status": { "title": "StatusPand", "type": "string", "description": "Een codering van de verschillende waarden die de status van een pand kan aannemen.\n", "enum": [ "Bouwvergunning verleend", "Niet gerealiseerd pand", "Bouw gestart", "Pand in gebruik (niet ingemeten)", "Pand in gebruik", "Verbouwing pand", "Sloopvergunning verleend", "Pand gesloopt", "Pand buiten gebruik", "Pand ten onrechte opgevoerd" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2009-05-12" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "09.BW.0273" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-\nconstructief zelfstandige eenheid die direct en duurzaam met de aarde is \nverbonden en betreedbaar en afsluitbaar is.\n\n**geometrie**: De minimaal tweedimensionale geometrische representatie van \nhet bovenaanzicht van de omtrekken van een pand.\n\n**status**: De fase van de levenscyclus van een pand, waarin het betreffende \npand zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve werkelijkheid, \nzoals beschreven met de eigenschappen van dit object waarover gegevens \ngeregistreerd worden, waarbij de gegevens gedurende een bepaalde periode \ngelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkPandInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanPand", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekPand", "type": "string", "enum": [ "geometrie", "oorspronkelijk bouwjaar", "status" ] }, "identificatieVanPand": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een pand waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van pand.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een Pand is de kleinste, bij de totstandkoming functioneel en bouwkundig-constructief zelfstandige eenheid die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar is. Inclusief aanduiding of deze in onderzoek is" }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } } } ] } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "404": { "description": "Not found.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 404, "title": "Opgevraagde resource bestaat niet.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", "detail": "The server has not found anything matching the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notFound" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "412": { "description": "Precondition failed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 412, "title": "Niet voldaan aan vooraf gestelde voorwaarde", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", "detail": "The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "preconditionFailed" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/adressenuitgebreid": { "get": { "tags": [ "Adres uitgebreid" ], "summary": "Bevragen van de uitgebreide informatie van één of meer huidige adressen \nop basis van verschillende combinaties van parameters.\n", "description": "De volgende (combinaties van) parameters worden ondersteund:\n\n1. Bevragen van de uitgebreide informatie van één of meer huidige \n adressen met een postcode, huisnummer en optioneel \n huisnummertoevoeging en huisletter.\n Het opgeven van een combinatie van parameters levert niet altijd \n een exacte match met één adres, bv. in geval van meerdere objecten \n met huisnummertoevoegingen en/of huisletters. \n Met de exacteMatch parameter kan worden aangegeven dat alleen \n object(en) die exact overeenkomen met de opgegeven parameters, \n geretourneerd moeten worden.\n\n2. Bevragen van de uitgebreide informatie van één of meer huidige \n adressen met de identificatie van een adresseerbaar object.\n\n3. Bevragen van de uitgebreide informatie van één of meer huidige \n adressen met woonplaats naam, openbare ruimte naam, huisnummer \n en optioneel huisnummertoevoeging en huisletter.\n Het opgeven van een combinatie van parameters levert niet altijd \n een exacte match met één adres, bv. in geval van meerdere objecten \n met huisnummertoevoegingen en/of huisletters. \n Met de exacteMatch parameter kan worden aangegeven dat alleen \n object(en) die exact overeenkomen met de opgegeven parameters, \n geretourneerd moeten worden.\n\n4. Zoek uitgebreide adres informatie van huidige adressen met een \n zoekterm.\n\n5. Bevragen van de uitgebreide informatie van één of meer huidige \n adressen met de identificatie van een pand.\n\n\nVoor paginering, zie: [functionele specificatie paginering](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).\n\nAls inclusiefEindStatus=true, dan worden ook actuele adressen met een eind status geleverd, zie [functionele specificatie inclusiefEindstatus](https://github.com/lvbag/BAG-API/blob/master/Features/inclusief-eind-status.feature).\n", "operationId": "zoekAdresUitgebreid", "parameters": [ { "name": "postcode", "in": "query", "description": "Postcode behorende bij een nummeraanduiding.", "required": false, "style": "form", "explode": true, "schema": { "pattern": "^[1-9]{1}[0-9]{3}[ ]{0,1}[a-zA-Z]{2}$", "type": "string" }, "examples": { "zonderSpatie": { "value": "6922KZ" }, "metSpatie": { "value": "6922 KZ" } } }, { "name": "huisnummer", "in": "query", "description": "Huisnummer behorende bij een nummeraanduiding.", "required": false, "style": "form", "explode": true, "schema": { "maximum": 99999, "minimum": 1, "type": "integer", "example": 1 } }, { "name": "huisnummertoevoeging", "in": "query", "description": "Huisnummertoevoeging behorende bij een nummeraanduiding.", "required": false, "style": "form", "explode": true, "schema": { "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "example": "bis" } }, { "name": "huisletter", "in": "query", "description": "Huisletter behorende bij een nummeraanduiding.", "required": false, "style": "form", "explode": true, "schema": { "pattern": "^[a-zA-Z]{1}$", "type": "string", "example": "A" } }, { "name": "exacteMatch", "in": "query", "description": "Een indicatie of de resultaten van een zoekoperatie exact overeen \nmoeten komen met de zoekcriteria, zie \n[functionele specificatie exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true, "default": false } }, { "name": "adresseerbaarObjectIdentificatie", "in": "query", "description": "Identificatie van een adresseerbaar object uit de BAG.", "required": false, "style": "form", "explode": true, "schema": { "title": "AdresseerbaarobjectIdentificatie", "pattern": "^[0-9]{4}(01|02|03)[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) \nuit de BAG.\n", "example": "0226010000038820" } }, { "name": "woonplaatsNaam", "in": "query", "description": "Naam van een woonplaats.", "required": false, "style": "form", "explode": true, "schema": { "maxLength": 80, "minLength": 1, "type": "string", "example": "Duiven" } }, { "name": "openbareRuimteNaam", "in": "query", "description": "Naam van een openbare ruimte.", "required": false, "style": "form", "explode": true, "schema": { "maxLength": 80, "minLength": 1, "type": "string", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" } }, { "name": "Accept-Crs", "in": "header", "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, { "name": "page", "in": "query", "description": "Pagina nummer", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Aantal resultaten per pagina", "required": false, "style": "form", "explode": true, "schema": { "maximum": 100, "minimum": 10, "type": "integer", "default": 20 } }, { "name": "q", "in": "query", "description": "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, \nhuisnummertoevoeging.\n", "required": false, "style": "form", "explode": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "inclusiefEindStatus", "in": "query", "description": "Een indicatie of ook actuele voorkomens met een eind status geleverd moeten worden.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true, "default": false } }, { "name": "pandIdentificatie", "in": "query", "description": "De identificatie van een pand uit de BAG.", "required": false, "style": "form", "explode": true, "schema": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging zoekAdresUitgebreid geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "X-Pagination-Page": { "description": "Huidige pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 3 }, "example": 3 }, "X-Pagination-Limit": { "description": "Aantal resultaten per pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 20 }, "example": 20 }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "adressen": { "type": "array", "items": { "allOf": [ { "title": "AdresUitgebreid", "description": "Een adres is een verzameling van informatie uit adresseerbare objecten, \ngerelateerde nummeraanduidingen (hoofd- en nevenadres(sen)), aan de \nnummeraanduiding gerelateerde openbare ruimte en (indien aanwezig)\nde aan de nummeraanduiding gerelateerde woonplaats en indien deze niet \nbeschikbaar is, de aan de openbare ruimte gerelateerde woonplaats. \nWaarbij alleen 'huidige' object voorkomen informatie wordt geretourneerd,\ndit houdt in: het actuele object voorkomen mits deze geen eind status \nheeft. Adres uitgebreid bevat een adres uitgebreid met adresseerbaar \nobject informatie.\n", "allOf": [ { "required": [ "huisnummer", "kortNaam", "nummeraanduidingIdentificatie", "openbareRuimteIdentificatie", "openbareRuimteNaam", "woonplaatsIdentificatie", "woonplaatsNaam" ], "type": "object", "properties": { "openbareRuimteNaam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe \nstrekkend formeel gemeentelijk besluit.\nHet betreft hier de straatnaam.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "korteNaam": { "title": "korteNaam", "maxLength": 24, "minLength": 1, "type": "string", "description": "De officiële openbare ruimte naam als deze niet langer is dan 24 tekens of de volgens de NEN5825 verkorte naam van maximaal 24 tekens.", "example": "Ln vd l D-Westervoort" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "woonplaatsNaam": { "title": "woonplaats naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.", "example": "Duiven" }, "nummeraanduidingIdentificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "openbareRuimteIdentificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "woonplaatsIdentificatie": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "adresseerbaarObjectIdentificatie": { "title": "AdresseerbaarobjectIdentificatie", "pattern": "^[0-9]{4}(01|02|03)[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) \nuit de BAG.\n", "example": "0226010000038820" }, "pandIdentificaties": { "type": "array", "description": "Identificatie(s) van het pand of de panden waar het verblijfsobject deel van uit maakt.", "items": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" } }, "indicatieNevenadres": { "type": "boolean", "description": "Indicatie dat dit adres een nevenadres is van een adresseerbaar object. Het adres is een hoofdadres als deze indicatie niet wordt meegeleverd." }, "adresregel5": { "type": "string", "description": "Adresregel 5 zoals beschreven in NEN 5825:2002 paragraaf 7.2.\nBevat: \n- straatnaam en indien aanwezig huisnummer en huisnummertoevoeging, \n waarbij huisnummertoevoeging een huisletter, huisnummertoevoeging of een combinatie van beide kan bevatten of\n- straatnaam en woonboot- of woonwagenverwijziging of\n- de aanduiding \"Postbus\" en het postbusnummer of\n- de aanduiding \"Antwoordnummer\" en het antwoordnummer of\n- de aanduiding \"PostApart\" en het PostApartnummer\n", "example": "Ln vd l D-Westervoort 1" }, "adresregel6": { "type": "string", "description": "Adresregel 6 zoals beschreven in NEN 5825:2002 paragraaf 7.2.\nBevat:\n postcode en woonplaats\n", "example": "6922 KZ DUIVEN" } }, "description": "Door het bevoegde gemeentelijke orgaan aan een verblijfsobject, een \nstandplaats of een ligplaats toegekende benaming, bestaande uit een \ncombinatie van de naam van een openbare ruimte, het huisnummer, een \neventuele huisletter en huisnummertoevoeging van de nummeraanduiding \nen de naam van de woonplaats.\n" }, { "properties": { "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "adresseerbaarObjectGeometrie": { "title": "PuntOfVlak", "type": "object", "properties": { "punt": { "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "minItems": 2, "type": "array", "items": { "type": "number" } } } }, "vlak": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] } }, "description": "Een samengesteld geometriegegevenstype waarbij wordt afgedwongen dat voor de geometrie een \nkeuze gemaakt moet worden tussen een punt of een vlak.\n" }, "adresseerbaarObjectStatus": { "type": "string" }, "gebruiksdoelen": { "minItems": 1, "type": "array", "items": { "title": "Gebruiksdoel", "type": "string", "description": "Een categorisering waarmee het gebruiksdoel van een object kan worden verbijzonderd.", "enum": [ "woonfunctie", "bijeenkomstfunctie", "celfunctie", "gezondheidszorgfunctie", "industriefunctie", "kantoorfunctie", "logiesfunctie", "onderwijsfunctie", "sportfunctie", "winkelfunctie", "overige gebruiksfunctie" ] } }, "oppervlakte": { "title": "oppervlakte", "pattern": "^[1-9][0-9]{0,5}$", "type": "integer" }, "oorspronkelijkBouwjaar": { "type": "array", "items": { "maxLength": 4, "pattern": "^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$", "type": "string", "description": "De aanduiding van het jaar waarin een pand oorspronkelijk als \nbouwkundig gereed is of zal worden opgeleverd. Bij het initieel \nopvoeren van een PAND wordt door de gemeente een reële \ninschatting gemaakt van het waarschijnlijke bouwjaar van het \nPAND. Bij het bouwkundig gereed opleveren van het PAND wordt \ndeze waarde in voorkomende gevallen aangepast. Indien in latere \njaren wijzigingen aan een pand worden aangebracht, leidt dit \nniet tot wijziging van het bouwjaar.\n", "example": "1991" } }, "pandStatussen": { "type": "array", "items": { "title": "StatusPand", "type": "string", "description": "Een codering van de verschillende waarden die de status van een pand kan aannemen.\n", "enum": [ "Bouwvergunning verleend", "Niet gerealiseerd pand", "Bouw gestart", "Pand in gebruik (niet ingemeten)", "Pand in gebruik", "Verbouwing pand", "Sloopvergunning verleend", "Pand gesloopt", "Pand buiten gebruik", "Pand ten onrechte opgevoerd" ] } }, "geconstateerd": { "allOf": [ { "type": "object", "properties": { "woonplaats": { "type": "boolean" }, "openbareRuimte": { "type": "boolean" }, "nummeraanduiding": { "type": "boolean" } }, "description": "Wanneer hier een property is opgenomen met de waarde true, dan is de aan het adres gerelateerde gelijknamige resource geconstateerd. Geconstateerd is een aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake was van een regulier brondocument voor deze opname." }, { "properties": { "ligplaats": { "type": "boolean" }, "standplaats": { "type": "boolean" }, "verblijfsobject": { "type": "boolean" }, "pand": { "type": "boolean" } } } ] }, "inonderzoek": { "description": "Bij het controleren of een property in onderzoek is kan het zijn \ndat er meerdere indicaties voor een property opgenomen zijn. \nIn dat geval zijn er meerdere indicaties waarvan de naam begint \nmet de property-naam.\n", "allOf": [ { "type": "object", "properties": { "openbareRuimteNaam": { "type": "boolean" }, "korteNaam": { "type": "boolean" }, "huisnummer": { "type": "boolean" }, "huisletter": { "type": "boolean" }, "huisnummertoevoeging": { "type": "boolean" }, "postcode": { "type": "boolean" }, "woonplaatsNaam": { "type": "boolean" }, "openbareRuimteLigtIn": { "type": "boolean", "description": "\"Als de nummeraanduidingLigtIn false is (deze is niet in onderzoek) en de openbareRuimteLigtIn is true (deze is wel in onderzoek) maar is gerelateerd aan een andere woonplaats dan de nummeraanduiding, \ndan wordt de boolean hier niet gezet. Deze is dan niet relevant omdat dan de woonplaats wordt gebruikt die gerelateerd is aan de nummeraanduiding.\"\n" }, "openbareRuimteStatus": { "type": "boolean" }, "nummeraanduidingLigtIn": { "type": "boolean" }, "nummeraanduidingligtAan": { "type": "boolean" }, "nummeraanduidingStatus": { "type": "boolean" }, "toelichting": { "type": "array", "items": { "type": "string", "example": "Woonplaatsnaam is mogelijk onjuist geschreven." } }, "adresregel5": { "type": "boolean" }, "adresregel6": { "type": "boolean" } }, "description": "Wanneer hier een property is opgenomen met de waarde true, dan is de waarde van het gelijknamige property in de resource in onderzoek. De juistheid van dit gegeven wordt op dit moment onderzocht. Onder property toelichting wordt toegelicht wat er mogelijk onjuist is aan het betreffende gegeven." }, { "properties": { "typeAdresseerbaarObject": { "type": "boolean" }, "adresseerbaarObjectGeometrie": { "type": "boolean", "description": "Een indicatie dat de geometrie van het aan een adres gerelateerde \nadresseerbare object in onderzoek is.\n" }, "adresseerbaarObjectStatus": { "type": "boolean", "description": "Een indicatie dat de status van het aan een adres gerelateerde \nadresseerbare object in onderzoek is.\n" }, "adresseerbaarObjectheeftAlsHoofdadres": { "type": "boolean" }, "adresseerbaarObjectheeftAlsNevenadres": { "type": "boolean" }, "gebruiksdoelen": { "type": "boolean" }, "oppervlakte": { "type": "boolean" }, "maaktDeelUitVan": { "type": "boolean" }, "oorspronkelijkBouwjaar": { "type": "boolean" } } } ] } } } ] }, { "properties": { "_links": { "allOf": [ { "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "openbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "nummeraanduiding": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "woonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "adresseerbaarObject": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "panden": { "type": "array", "description": "Het/de aan het adres gerelateerde pand(en).", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] } } } }, "_links": { "title": "HalPaginationLinks", "example": { "first": { "href": "/resourcenaam?page=1", "title": "Eerste pagina" }, "previous": { "href": "/resourcenaam?page=3", "title": "Vorige pagina" }, "next": { "href": "/resourcenaam?page=5", "title": "Volgende pagina" }, "last": { "href": "/resourcenaam?page=15", "title": "Laatste pagina" } }, "allOf": [ { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } }, { "type": "object", "properties": { "first": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "previous": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "next": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "last": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } ] } } } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "412": { "description": "Precondition failed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 412, "title": "Niet voldaan aan vooraf gestelde voorwaarde", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", "detail": "The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "preconditionFailed" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/adressenuitgebreid/{nummeraanduidingIdentificatie}": { "get": { "tags": [ "Adres uitgebreid" ], "summary": "Bevragen van de uitgebreide informatie van één huidig adres met de \nidentificatie van een nummeraanduiding.\n", "description": "Bevragen van de uitgebreide informatie van één huidig adres met de \nidentificatie van een nummeraanduiding.\n\nAls inclusiefEindStatus=true, dan worden ook actuele adressen met een eind status geleverd, zie [functionele specificatie inclusiefEindstatus](https://github.com/lvbag/BAG-API/blob/master/Features/inclusief-eind-status.feature).\n", "operationId": "bevraagAdresUitgebreidMetNumId", "parameters": [ { "name": "nummeraanduidingIdentificatie", "in": "path", "description": "De identificatie van een nummeraanduiding uit de BAG.", "required": true, "style": "simple", "explode": false, "schema": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, { "name": "Accept-Crs", "in": "header", "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, { "name": "inclusiefEindStatus", "in": "query", "description": "Een indicatie of ook actuele voorkomens met een eind status geleverd moeten worden.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true, "default": false } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging bevraagAdresUitgebreidMetNumId geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "allOf": [ { "title": "AdresUitgebreid", "description": "Een adres is een verzameling van informatie uit adresseerbare objecten, \ngerelateerde nummeraanduidingen (hoofd- en nevenadres(sen)), aan de \nnummeraanduiding gerelateerde openbare ruimte en (indien aanwezig)\nde aan de nummeraanduiding gerelateerde woonplaats en indien deze niet \nbeschikbaar is, de aan de openbare ruimte gerelateerde woonplaats. \nWaarbij alleen 'huidige' object voorkomen informatie wordt geretourneerd,\ndit houdt in: het actuele object voorkomen mits deze geen eind status \nheeft. Adres uitgebreid bevat een adres uitgebreid met adresseerbaar \nobject informatie.\n", "allOf": [ { "required": [ "huisnummer", "kortNaam", "nummeraanduidingIdentificatie", "openbareRuimteIdentificatie", "openbareRuimteNaam", "woonplaatsIdentificatie", "woonplaatsNaam" ], "type": "object", "properties": { "openbareRuimteNaam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe \nstrekkend formeel gemeentelijk besluit.\nHet betreft hier de straatnaam.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "korteNaam": { "title": "korteNaam", "maxLength": 24, "minLength": 1, "type": "string", "description": "De officiële openbare ruimte naam als deze niet langer is dan 24 tekens of de volgens de NEN5825 verkorte naam van maximaal 24 tekens.", "example": "Ln vd l D-Westervoort" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "woonplaatsNaam": { "title": "woonplaats naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.", "example": "Duiven" }, "nummeraanduidingIdentificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "openbareRuimteIdentificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "woonplaatsIdentificatie": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "adresseerbaarObjectIdentificatie": { "title": "AdresseerbaarobjectIdentificatie", "pattern": "^[0-9]{4}(01|02|03)[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) \nuit de BAG.\n", "example": "0226010000038820" }, "pandIdentificaties": { "type": "array", "description": "Identificatie(s) van het pand of de panden waar het verblijfsobject deel van uit maakt.", "items": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" } }, "indicatieNevenadres": { "type": "boolean", "description": "Indicatie dat dit adres een nevenadres is van een adresseerbaar object. Het adres is een hoofdadres als deze indicatie niet wordt meegeleverd." }, "adresregel5": { "type": "string", "description": "Adresregel 5 zoals beschreven in NEN 5825:2002 paragraaf 7.2.\nBevat: \n- straatnaam en indien aanwezig huisnummer en huisnummertoevoeging, \n waarbij huisnummertoevoeging een huisletter, huisnummertoevoeging of een combinatie van beide kan bevatten of\n- straatnaam en woonboot- of woonwagenverwijziging of\n- de aanduiding \"Postbus\" en het postbusnummer of\n- de aanduiding \"Antwoordnummer\" en het antwoordnummer of\n- de aanduiding \"PostApart\" en het PostApartnummer\n", "example": "Ln vd l D-Westervoort 1" }, "adresregel6": { "type": "string", "description": "Adresregel 6 zoals beschreven in NEN 5825:2002 paragraaf 7.2.\nBevat:\n postcode en woonplaats\n", "example": "6922 KZ DUIVEN" } }, "description": "Door het bevoegde gemeentelijke orgaan aan een verblijfsobject, een \nstandplaats of een ligplaats toegekende benaming, bestaande uit een \ncombinatie van de naam van een openbare ruimte, het huisnummer, een \neventuele huisletter en huisnummertoevoeging van de nummeraanduiding \nen de naam van de woonplaats.\n" }, { "properties": { "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "adresseerbaarObjectGeometrie": { "title": "PuntOfVlak", "type": "object", "properties": { "punt": { "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "minItems": 2, "type": "array", "items": { "type": "number" } } } }, "vlak": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] } }, "description": "Een samengesteld geometriegegevenstype waarbij wordt afgedwongen dat voor de geometrie een \nkeuze gemaakt moet worden tussen een punt of een vlak.\n" }, "adresseerbaarObjectStatus": { "type": "string" }, "gebruiksdoelen": { "minItems": 1, "type": "array", "items": { "title": "Gebruiksdoel", "type": "string", "description": "Een categorisering waarmee het gebruiksdoel van een object kan worden verbijzonderd.", "enum": [ "woonfunctie", "bijeenkomstfunctie", "celfunctie", "gezondheidszorgfunctie", "industriefunctie", "kantoorfunctie", "logiesfunctie", "onderwijsfunctie", "sportfunctie", "winkelfunctie", "overige gebruiksfunctie" ] } }, "oppervlakte": { "title": "oppervlakte", "pattern": "^[1-9][0-9]{0,5}$", "type": "integer" }, "oorspronkelijkBouwjaar": { "type": "array", "items": { "maxLength": 4, "pattern": "^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$", "type": "string", "description": "De aanduiding van het jaar waarin een pand oorspronkelijk als \nbouwkundig gereed is of zal worden opgeleverd. Bij het initieel \nopvoeren van een PAND wordt door de gemeente een reële \ninschatting gemaakt van het waarschijnlijke bouwjaar van het \nPAND. Bij het bouwkundig gereed opleveren van het PAND wordt \ndeze waarde in voorkomende gevallen aangepast. Indien in latere \njaren wijzigingen aan een pand worden aangebracht, leidt dit \nniet tot wijziging van het bouwjaar.\n", "example": "1991" } }, "pandStatussen": { "type": "array", "items": { "title": "StatusPand", "type": "string", "description": "Een codering van de verschillende waarden die de status van een pand kan aannemen.\n", "enum": [ "Bouwvergunning verleend", "Niet gerealiseerd pand", "Bouw gestart", "Pand in gebruik (niet ingemeten)", "Pand in gebruik", "Verbouwing pand", "Sloopvergunning verleend", "Pand gesloopt", "Pand buiten gebruik", "Pand ten onrechte opgevoerd" ] } }, "geconstateerd": { "allOf": [ { "type": "object", "properties": { "woonplaats": { "type": "boolean" }, "openbareRuimte": { "type": "boolean" }, "nummeraanduiding": { "type": "boolean" } }, "description": "Wanneer hier een property is opgenomen met de waarde true, dan is de aan het adres gerelateerde gelijknamige resource geconstateerd. Geconstateerd is een aanduiding waarmee kan worden aangegeven dat een object in de registratie is opgenomen als gevolg van een feitelijke constatering, zonder dat er op het moment van opname sprake was van een regulier brondocument voor deze opname." }, { "properties": { "ligplaats": { "type": "boolean" }, "standplaats": { "type": "boolean" }, "verblijfsobject": { "type": "boolean" }, "pand": { "type": "boolean" } } } ] }, "inonderzoek": { "description": "Bij het controleren of een property in onderzoek is kan het zijn \ndat er meerdere indicaties voor een property opgenomen zijn. \nIn dat geval zijn er meerdere indicaties waarvan de naam begint \nmet de property-naam.\n", "allOf": [ { "type": "object", "properties": { "openbareRuimteNaam": { "type": "boolean" }, "korteNaam": { "type": "boolean" }, "huisnummer": { "type": "boolean" }, "huisletter": { "type": "boolean" }, "huisnummertoevoeging": { "type": "boolean" }, "postcode": { "type": "boolean" }, "woonplaatsNaam": { "type": "boolean" }, "openbareRuimteLigtIn": { "type": "boolean", "description": "\"Als de nummeraanduidingLigtIn false is (deze is niet in onderzoek) en de openbareRuimteLigtIn is true (deze is wel in onderzoek) maar is gerelateerd aan een andere woonplaats dan de nummeraanduiding, \ndan wordt de boolean hier niet gezet. Deze is dan niet relevant omdat dan de woonplaats wordt gebruikt die gerelateerd is aan de nummeraanduiding.\"\n" }, "openbareRuimteStatus": { "type": "boolean" }, "nummeraanduidingLigtIn": { "type": "boolean" }, "nummeraanduidingligtAan": { "type": "boolean" }, "nummeraanduidingStatus": { "type": "boolean" }, "toelichting": { "type": "array", "items": { "type": "string", "example": "Woonplaatsnaam is mogelijk onjuist geschreven." } }, "adresregel5": { "type": "boolean" }, "adresregel6": { "type": "boolean" } }, "description": "Wanneer hier een property is opgenomen met de waarde true, dan is de waarde van het gelijknamige property in de resource in onderzoek. De juistheid van dit gegeven wordt op dit moment onderzocht. Onder property toelichting wordt toegelicht wat er mogelijk onjuist is aan het betreffende gegeven." }, { "properties": { "typeAdresseerbaarObject": { "type": "boolean" }, "adresseerbaarObjectGeometrie": { "type": "boolean", "description": "Een indicatie dat de geometrie van het aan een adres gerelateerde \nadresseerbare object in onderzoek is.\n" }, "adresseerbaarObjectStatus": { "type": "boolean", "description": "Een indicatie dat de status van het aan een adres gerelateerde \nadresseerbare object in onderzoek is.\n" }, "adresseerbaarObjectheeftAlsHoofdadres": { "type": "boolean" }, "adresseerbaarObjectheeftAlsNevenadres": { "type": "boolean" }, "gebruiksdoelen": { "type": "boolean" }, "oppervlakte": { "type": "boolean" }, "maaktDeelUitVan": { "type": "boolean" }, "oorspronkelijkBouwjaar": { "type": "boolean" } } } ] } } } ] }, { "properties": { "_links": { "allOf": [ { "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "openbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "nummeraanduiding": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "woonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "adresseerbaarObject": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "panden": { "type": "array", "description": "Het/de aan het adres gerelateerde pand(en).", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "412": { "description": "Precondition failed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 412, "title": "Niet voldaan aan vooraf gestelde voorwaarde", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", "detail": "The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "preconditionFailed" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/bronhouders": { "get": { "tags": [ "Bronhouder" ], "summary": "Bevragen bronhouder met een object identificatie.", "description": "Bevragen/raadplegen van een bronhouder met de identificatie van een object. De identificatie van één van de objecten: woonplaats, openbare ruimte, nummeraanduiding, ligplaats, standplaats, verblijfsobject of pand dient gespecificeerd te worden:\u003cbr/\u003e\nDe geldigOp en beschikbaarOp parameters kunnen gebruikt worden voor tijdreis vragen, zie [functionele specificatie tijdreizen](https://github.com/lvbag/BAG-API/blob/master/Features/tijdreizen.feature). ", "operationId": "zoekBronhouder", "parameters": [ { "name": "woonplaatsIdentificatie", "in": "query", "description": "De identificatie van een woonplaats uit de BAG.", "required": false, "deprecated": true, "style": "form", "explode": true, "schema": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" } }, { "name": "objectIdentificatie", "in": "query", "description": "De identificatie van een object uit de BAG. Deze is 4 lang bij een \nwoonplaats en 16 lang bij de andere objecten.\n", "required": false, "style": "form", "explode": true, "schema": { "pattern": "^[0-9]{4}(?:01|02|03|10|20|30)[0-9]{10}$|^[0-9]{3}[1-9]$|^[0-9]{2}[1-9][0-9]$|^[0-9][1-9][0-9]{2}$|^[1-9][0-9]{3}$", "type": "string", "example": "0226100000008856" } }, { "name": "geldigOp", "in": "query", "description": "Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD`\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2019-11-23" } }, { "name": "beschikbaarOp", "in": "query", "description": "Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd \n`YYYY-MM-DDThh:mm:ss.sss'. Hierin kunnen de seconden ':ss' en milliseconden \n'.sss' of alleen de milliseconden conform ISO 8601 specificatie worden \nweggelaten, in dat geval krijgen deze automatisch de waarde ':00' \nrespectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 \ncijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'.\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging zoekBronhouder geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "bronhouders": { "type": "array", "items": { "title": "BronhouderHal", "required": [ "bronhouder" ], "type": "object", "properties": { "bronhouder": { "title": "Gemeente", "required": [ "beginGeldigheid", "code", "naam", "provincie", "status", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "code": { "title": "code", "pattern": "^[0-9]{4}$", "type": "string", "description": "Een officiële code die aan een gemeente is toegekend, ontleend is aan \ntabel 33 en zoals bijgehouden in de LVBAG. \nDit gegeven is geen officieel BAG gegeven en wordt niet als kenmerk van \nhet BAG object Woonplaats object bijgehouden. \nHet wordt als hulpgegeven meegeleverd.\n", "example": "0226" }, "naam": { "title": "naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een officiële naam die aan een gemeente is toegekend.", "example": "Duiven" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een bronhouder geldig is in de werkelijkheid. \nDit tijdstip wordt vastgelegd in de beginGeldigheid.\n", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een bronhouder \neindigt. \nWanneer er geen tijdstip is ingevuld, dan is de versie nog geldig. \nDit tijdstip wordt vastgelegd in de eindGeldigheid.\n", "format": "date", "example": "2019-06-01" }, "provincie": { "title": "Provincie", "required": [ "afkorting", "identificatie", "naam" ], "type": "object", "properties": { "identificatie": { "type": "integer" }, "naam": { "title": "naam", "maxLength": 32, "minLength": 1, "type": "string", "example": "Gelderland" }, "afkorting": { "title": "afkorting", "maxLength": 2, "minLength": 1, "type": "string", "example": "Ge" } }, "description": "Gegevens van een provincie" }, "status": { "title": "StatusGemeente", "type": "string", "description": "Een aanduiding van alle waarden die de status van een gemeente kan aannemen.", "enum": [ "Actief", "Beëindigd" ] }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip (conform RFC 3339) waarop een versie van een object of een relatie is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time", "example": "2019-06-01T12:00:00+01:00" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip (conform RFC 3339) waarop een versie van een object of een relatie is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time", "example": "2019-06-01T12:00:00+01:00" } }, "description": "Een bronhouder is een gemeente of samenwerkingsverband van gemeenten en \nheeft een code en naam net als een gemeente.\n" }, "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } }, "description": "Bronhouder aangevuld met HAL link." } } } }, "_links": { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/bronhouders/{identificatie}": { "get": { "tags": [ "Bronhouder" ], "summary": "Bevragen bronhouder met de bronhouder identificatie (gemeentecode).", "description": "Bevragen/raadplegen van een bronhouder met de identificatie van een bronhouder (gemeentecode).\nDe geldigOp en beschikbaarOp parameters kunnen gebruikt worden voor tijdreis vragen, zie [functionele specificatie tijdreizen](https://github.com/lvbag/BAG-API/blob/master/Features/tijdreizen.feature). ", "operationId": "bevragenBronhouder", "parameters": [ { "name": "identificatie", "in": "path", "description": "Een officiële code die aan een gemeente is toegekend en ontleend is \naan tabel 33.\n", "required": true, "style": "simple", "explode": false, "schema": { "title": "code", "pattern": "^[0-9]{4}$", "type": "string", "description": "Een officiële code die aan een gemeente is toegekend, ontleend is aan \ntabel 33 en zoals bijgehouden in de LVBAG. \nDit gegeven is geen officieel BAG gegeven en wordt niet als kenmerk van \nhet BAG object Woonplaats object bijgehouden. \nHet wordt als hulpgegeven meegeleverd.\n", "example": "0226" } }, { "name": "geldigOp", "in": "query", "description": "Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD`\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2019-11-23" } }, { "name": "beschikbaarOp", "in": "query", "description": "Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd \n`YYYY-MM-DDThh:mm:ss.sss'. Hierin kunnen de seconden ':ss' en milliseconden \n'.sss' of alleen de milliseconden conform ISO 8601 specificatie worden \nweggelaten, in dat geval krijgen deze automatisch de waarde ':00' \nrespectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 \ncijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'.\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging bronhouder geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "title": "BronhouderHal", "required": [ "bronhouder" ], "type": "object", "properties": { "bronhouder": { "title": "Gemeente", "required": [ "beginGeldigheid", "code", "naam", "provincie", "status", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "code": { "title": "code", "pattern": "^[0-9]{4}$", "type": "string", "description": "Een officiële code die aan een gemeente is toegekend, ontleend is aan \ntabel 33 en zoals bijgehouden in de LVBAG. \nDit gegeven is geen officieel BAG gegeven en wordt niet als kenmerk van \nhet BAG object Woonplaats object bijgehouden. \nHet wordt als hulpgegeven meegeleverd.\n", "example": "0226" }, "naam": { "title": "naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een officiële naam die aan een gemeente is toegekend.", "example": "Duiven" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een bronhouder geldig is in de werkelijkheid. \nDit tijdstip wordt vastgelegd in de beginGeldigheid.\n", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een bronhouder \neindigt. \nWanneer er geen tijdstip is ingevuld, dan is de versie nog geldig. \nDit tijdstip wordt vastgelegd in de eindGeldigheid.\n", "format": "date", "example": "2019-06-01" }, "provincie": { "title": "Provincie", "required": [ "afkorting", "identificatie", "naam" ], "type": "object", "properties": { "identificatie": { "type": "integer" }, "naam": { "title": "naam", "maxLength": 32, "minLength": 1, "type": "string", "example": "Gelderland" }, "afkorting": { "title": "afkorting", "maxLength": 2, "minLength": 1, "type": "string", "example": "Ge" } }, "description": "Gegevens van een provincie" }, "status": { "title": "StatusGemeente", "type": "string", "description": "Een aanduiding van alle waarden die de status van een gemeente kan aannemen.", "enum": [ "Actief", "Beëindigd" ] }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip (conform RFC 3339) waarop een versie van een object of een relatie is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time", "example": "2019-06-01T12:00:00+01:00" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip (conform RFC 3339) waarop een versie van een object of een relatie is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time", "example": "2019-06-01T12:00:00+01:00" } }, "description": "Een bronhouder is een gemeente of samenwerkingsverband van gemeenten en \nheeft een code en naam net als een gemeente.\n" }, "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } }, "description": "Bronhouder aangevuld met HAL link." } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "404": { "description": "Not found.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 404, "title": "Opgevraagde resource bestaat niet.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", "detail": "The server has not found anything matching the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notFound" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/bronhouders/{identificatie}/{versie}/{timestampRegistratieLv}": { "get": { "tags": [ "Bronhouder" ], "summary": "bevragen voorkomen van een bronhouder met de identificatie van een bronhouder en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.", "description": "Bevragen/raadplegen van een voorkomen van een bronhouder met de identificatie van een bronhouder en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.", "operationId": "bronhouderIdentificatieVoorkomen", "parameters": [ { "name": "identificatie", "in": "path", "description": "Een officiële code die aan een gemeente is toegekend en ontleend is \naan tabel 33.\n", "required": true, "style": "simple", "explode": false, "schema": { "title": "code", "pattern": "^[0-9]{4}$", "type": "string", "description": "Een officiële code die aan een gemeente is toegekend, ontleend is aan \ntabel 33 en zoals bijgehouden in de LVBAG. \nDit gegeven is geen officieel BAG gegeven en wordt niet als kenmerk van \nhet BAG object Woonplaats object bijgehouden. \nHet wordt als hulpgegeven meegeleverd.\n", "example": "0226" } }, { "name": "versie", "in": "path", "description": "De versie van een voorkomen van een object.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 1 } }, { "name": "timestampRegistratieLv", "in": "path", "description": "Een timestamp van het tijdstip waarop een voorkomen is geregistreerd in de LV BAG.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^\\d+$", "type": "string", "example": "1530403860000" } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging bronhouderIdentificatieVoorkomen geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "title": "BronhouderHal", "required": [ "bronhouder" ], "type": "object", "properties": { "bronhouder": { "title": "Gemeente", "required": [ "beginGeldigheid", "code", "naam", "provincie", "status", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "code": { "title": "code", "pattern": "^[0-9]{4}$", "type": "string", "description": "Een officiële code die aan een gemeente is toegekend, ontleend is aan \ntabel 33 en zoals bijgehouden in de LVBAG. \nDit gegeven is geen officieel BAG gegeven en wordt niet als kenmerk van \nhet BAG object Woonplaats object bijgehouden. \nHet wordt als hulpgegeven meegeleverd.\n", "example": "0226" }, "naam": { "title": "naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een officiële naam die aan een gemeente is toegekend.", "example": "Duiven" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een bronhouder geldig is in de werkelijkheid. \nDit tijdstip wordt vastgelegd in de beginGeldigheid.\n", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een bronhouder \neindigt. \nWanneer er geen tijdstip is ingevuld, dan is de versie nog geldig. \nDit tijdstip wordt vastgelegd in de eindGeldigheid.\n", "format": "date", "example": "2019-06-01" }, "provincie": { "title": "Provincie", "required": [ "afkorting", "identificatie", "naam" ], "type": "object", "properties": { "identificatie": { "type": "integer" }, "naam": { "title": "naam", "maxLength": 32, "minLength": 1, "type": "string", "example": "Gelderland" }, "afkorting": { "title": "afkorting", "maxLength": 2, "minLength": 1, "type": "string", "example": "Ge" } }, "description": "Gegevens van een provincie" }, "status": { "title": "StatusGemeente", "type": "string", "description": "Een aanduiding van alle waarden die de status van een gemeente kan aannemen.", "enum": [ "Actief", "Beëindigd" ] }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip (conform RFC 3339) waarop een versie van een object of een relatie is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time", "example": "2019-06-01T12:00:00+01:00" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip (conform RFC 3339) waarop een versie van een object of een relatie is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time", "example": "2019-06-01T12:00:00+01:00" } }, "description": "Een bronhouder is een gemeente of samenwerkingsverband van gemeenten en \nheeft een code en naam net als een gemeente.\n" }, "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } }, "description": "Bronhouder aangevuld met HAL link." } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "404": { "description": "Not found.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 404, "title": "Opgevraagde resource bestaat niet.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", "detail": "The server has not found anything matching the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notFound" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/info": { "get": { "tags": [ "Algemene informatie" ], "summary": "Algemene info van de API", "operationId": "getInfo", "responses": { "default": { "description": "Onverwacht probleem", "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging getInfo geslaagd", "content": { "application/json": { "schema": { "title": "API-info", "type": "object", "properties": { "api-name": { "type": "string", "description": "De naam van de API." }, "api-version": { "type": "string", "description": "Versie van de API." }, "api-description": { "type": "string", "description": "Omschrijving van de API." }, "informationmodel": { "type": "string", "description": "Naam van het informatiemodel dat als basis is genomen voor deze API.", "example": "IMBAGLV" }, "informationmodel-version": { "type": "string", "description": "Versie van het logische informatiemodel dat als basis is genomen voor deze API.", "example": "v20190601" }, "informationmodel-location": { "type": "string", "description": "Locatie (URI) van het logische informatiemodel die als basis is genomen voor deze API.", "format": "URI" } }, "description": "Algemene informatie voor gebruikers van de API." } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/ligplaatsen": { "get": { "tags": [ "Ligplaats" ], "summary": "Zoeken van ligplaatsen met een geometrische locatie of binnen een bounding box.", "description": "Zoek actuele ligplaatsen:\n\n1. met een geometrische locatie.\n\n2. binnen een geometrische contour (rechthoek).\n\n\nParameter huidig kan worden toegepast, zie [functionele specificatie huidig](https://github.com/lvbag/BAG-API/blob/master/Features/huidig.feature).\n\nDe geldigOp en beschikbaarOp parameters kunnen gebruikt worden voor \ntijdreis vragen, zie \n[functionele specificatie tijdreizen](https://github.com/lvbag/BAG-API/blob/master/Features/tijdreizen.feature). \n\nAls expand=heeftAlsHoofdAdres, heeftAlsNevenAdres of true dan worden de gevraagde of alle objecten als geneste resource geleverd, zie\n[functionele specificatie expand](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature).\n\nVoor paginering, zie: [functionele specificatie paginering](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).\n", "operationId": "zoekLigplaatsen", "parameters": [ { "name": "geldigOp", "in": "query", "description": "Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD`\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2019-11-23" } }, { "name": "beschikbaarOp", "in": "query", "description": "Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd \n`YYYY-MM-DDThh:mm:ss.sss'. Hierin kunnen de seconden ':ss' en milliseconden \n'.sss' of alleen de milliseconden conform ISO 8601 specificatie worden \nweggelaten, in dat geval krijgen deze automatisch de waarde ':00' \nrespectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 \ncijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'.\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "huidig", "in": "query", "description": "Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false, "default": false } }, { "name": "expand", "in": "query", "description": "Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Crs", "in": "header", "description": "CRS van de meegegeven geometrie.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, { "name": "Accept-Crs", "in": "header", "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, { "name": "page", "in": "query", "description": "Pagina nummer", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Aantal resultaten per pagina", "required": false, "style": "form", "explode": true, "schema": { "maximum": 100, "minimum": 10, "type": "integer", "default": 20 } }, { "name": "point", "in": "query", "description": "Punt conform OGC API Features standaard.\nMet de content-crs header wordt aangegeven in welk CRS de coördinaten van het punt is. \n", "required": false, "style": "form", "explode": false, "schema": { "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "minItems": 2, "type": "array", "items": { "type": "number" } } } }, "example": { "type": "Point", "coordinates": [ 196733.51, 439931.89 ] } }, { "name": "bbox", "in": "query", "description": "Rechthoek (bounding box) waarbinnen het object dat je zoekt valt.\nVoor een definitie van bbox, zie [OGC API Features specificatie - bbox definitie](https://docs.opengeospatial.org/is/17-069r3/17-069r3.html#ats_core_fc-bbox-definition).\nMet de content-crs header wordt aangegeven in welk CRS de coördinaten van de bbox zijn. \nCoördinaten worden als volgt opgegeven: linksonder x, linksonder y, rechtsboven x, rechtsboven y.\nDe oppervlakte van de bounding box mag maximaal 250.000 vierkante meter zijn.\n", "required": false, "style": "form", "explode": false, "schema": { "maxItems": 4, "minItems": 4, "type": "array", "example": [ 196733.51, 439931.89, 196833.51, 440031.89 ], "items": { "type": "number" } } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "zoekLigplaatsen geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "X-Pagination-Page": { "description": "Huidige pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 3 }, "example": 3 }, "X-Pagination-Limit": { "description": "Aantal resultaten per pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 20 }, "example": 20 }, "Content-Crs": { "description": "CRS van de geometrie verstrekt door de server aan de client.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "ligplaatsen": { "type": "array", "items": { "allOf": [ { "allOf": [ { "title": "LigplaatsIO", "required": [ "ligplaats" ], "properties": { "ligplaats": { "title": "Ligplaats", "description": "Een Ligplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen plaats in het water al dan niet aangevuld met een op de oever \naanwezig terrein of een gedeelte daarvan, die bestemd is voor het permanent \nafmeren van een voor woon-, bedrijfsmatige of recreatieve doeleinden \ngeschikt drijvend object.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een ligplaats, waarin de \nbetreffende ligplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een ligplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Ligplaats", "example": "NL.IMBAG.Ligplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een \nopname, mutatie of een verwijdering van gegevens ten aanzien van een \nobject heeft plaatsgevonden.\n", "format": "date", "example": "2011-12-30" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "AVGEL30122011-07" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkLigplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanLigplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekLigplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanLigplaats": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een ligplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van ligplaats\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Ligplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] } } } }, "_links": { "title": "HalPaginationLinks", "example": { "first": { "href": "/resourcenaam?page=1", "title": "Eerste pagina" }, "previous": { "href": "/resourcenaam?page=3", "title": "Vorige pagina" }, "next": { "href": "/resourcenaam?page=5", "title": "Volgende pagina" }, "last": { "href": "/resourcenaam?page=15", "title": "Laatste pagina" } }, "allOf": [ { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } }, { "type": "object", "properties": { "first": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "previous": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "next": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "last": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } ] } } } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "412": { "description": "Precondition failed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 412, "title": "Niet voldaan aan vooraf gestelde voorwaarde", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", "detail": "The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "preconditionFailed" } } } }, "415": { "description": "Unsupported media type.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 415, "title": "Media-type niet ondersteund", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.16 415 Unsupported Media Type", "detail": "The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "unsupported" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] }, "post": { "tags": [ "Ligplaats" ], "summary": "bevragen van een ligplaats, op basis van een geometrische locatie.", "description": "Bevragen/raadplegen van één of meer ligplaatsen met een geometrische locatie.\nParameter huidig kan worden toegepast, zie [functionele specificatie huidig](https://github.com/lvbag/BAG-API/blob/master/Features/huidig.feature).\nDe geldigOp en beschikbaarOp parameters kunnen gebruikt worden voor tijdreis vragen, zie [functionele specificatie tijdreizen](https://github.com/lvbag/BAG-API/blob/master/Features/tijdreizen.feature). \nAls expand=heeftAlsHoofdAdres, heeftAlsNevenAdres of true dan worden de gevraagde of alle objecten als geneste resource geleverd, zie [functionele specificatie expand](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature).", "operationId": "ligplaatsGeometrie", "parameters": [ { "name": "geldigOp", "in": "query", "description": "Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD`\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2019-11-23" } }, { "name": "beschikbaarOp", "in": "query", "description": "Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd \n`YYYY-MM-DDThh:mm:ss.sss'. Hierin kunnen de seconden ':ss' en milliseconden \n'.sss' of alleen de milliseconden conform ISO 8601 specificatie worden \nweggelaten, in dat geval krijgen deze automatisch de waarde ':00' \nrespectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 \ncijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'.\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "huidig", "in": "query", "description": "Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false, "default": false } }, { "name": "expand", "in": "query", "description": "Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Crs", "in": "header", "description": "CRS van de meegegeven geometrie.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, { "name": "Accept-Crs", "in": "header", "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } ], "requestBody": { "description": "Geometrisch punt waarop de ligplaatsen bepaald moeten worden.", "content": { "application/json": { "schema": { "required": [ "coordinates", "type" ], "type": "object", "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "minItems": 2, "type": "array", "items": { "type": "number" } } } }, "example": { "type": "Point", "coordinates": "[196733.510, 439931.890]" } } }, "required": true }, "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging ligplaatsGeometrie geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Content-Crs": { "description": "CRS van de geometrie verstrekt door de server aan de client.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "ligplaatsen": { "type": "array", "items": { "allOf": [ { "allOf": [ { "title": "LigplaatsIO", "required": [ "ligplaats" ], "properties": { "ligplaats": { "title": "Ligplaats", "description": "Een Ligplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen plaats in het water al dan niet aangevuld met een op de oever \naanwezig terrein of een gedeelte daarvan, die bestemd is voor het permanent \nafmeren van een voor woon-, bedrijfsmatige of recreatieve doeleinden \ngeschikt drijvend object.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een ligplaats, waarin de \nbetreffende ligplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een ligplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Ligplaats", "example": "NL.IMBAG.Ligplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een \nopname, mutatie of een verwijdering van gegevens ten aanzien van een \nobject heeft plaatsgevonden.\n", "format": "date", "example": "2011-12-30" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "AVGEL30122011-07" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkLigplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanLigplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekLigplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanLigplaats": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een ligplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van ligplaats\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Ligplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] } } } }, "_links": { "title": "HalPaginationLinks", "example": { "first": { "href": "/resourcenaam?page=1", "title": "Eerste pagina" }, "previous": { "href": "/resourcenaam?page=3", "title": "Vorige pagina" }, "next": { "href": "/resourcenaam?page=5", "title": "Volgende pagina" }, "last": { "href": "/resourcenaam?page=15", "title": "Laatste pagina" } }, "allOf": [ { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } }, { "type": "object", "properties": { "first": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "previous": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "next": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "last": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } ] } } } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "412": { "description": "Precondition failed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 412, "title": "Niet voldaan aan vooraf gestelde voorwaarde", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", "detail": "The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "preconditionFailed" } } } }, "415": { "description": "Unsupported media type.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 415, "title": "Media-type niet ondersteund", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.16 415 Unsupported Media Type", "detail": "The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "unsupported" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/ligplaatsen/{identificatie}": { "get": { "tags": [ "Ligplaats" ], "summary": "bevragen 1 ligplaats met de identificatie van een ligplaats.", "description": "Bevragen/raadplegen van een voorkomen van een ligplaats met de identificatie van de ligplaats.\nParameter huidig kan worden toegepast, zie [functionele specificatie huidig](https://github.com/lvbag/BAG-API/blob/master/Features/huidig.feature).\nDe geldigOp en beschikbaarOp parameters kunnen gebruikt worden voor tijdreis vragen, zie [functionele specificatie tijdreizen](https://github.com/lvbag/BAG-API/blob/master/Features/tijdreizen.feature). \nAls expand=heeftAlsHoofdAdres, heeftAlsNevenAdres of true dan worden de gevraagde of alle objecten als geneste resource geleverd, zie [functionele specificatie expand](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature).", "operationId": "ligplaatsIdentificatie", "parameters": [ { "name": "identificatie", "in": "path", "description": "De identificatie van een ligplaats uit de BAG.", "required": true, "style": "simple", "explode": false, "schema": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" } }, { "name": "geldigOp", "in": "query", "description": "Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD`\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2019-11-23" } }, { "name": "beschikbaarOp", "in": "query", "description": "Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd \n`YYYY-MM-DDThh:mm:ss.sss'. Hierin kunnen de seconden ':ss' en milliseconden \n'.sss' of alleen de milliseconden conform ISO 8601 specificatie worden \nweggelaten, in dat geval krijgen deze automatisch de waarde ':00' \nrespectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 \ncijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'.\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "expand", "in": "query", "description": "Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Accept-Crs", "in": "header", "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, { "name": "huidig", "in": "query", "description": "Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false, "default": false } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging ligplaatsIdentificatie geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Content-Crs": { "description": "CRS van de geometrie verstrekt door de server aan de client.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "allOf": [ { "allOf": [ { "title": "LigplaatsIO", "required": [ "ligplaats" ], "properties": { "ligplaats": { "title": "Ligplaats", "description": "Een Ligplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen plaats in het water al dan niet aangevuld met een op de oever \naanwezig terrein of een gedeelte daarvan, die bestemd is voor het permanent \nafmeren van een voor woon-, bedrijfsmatige of recreatieve doeleinden \ngeschikt drijvend object.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een ligplaats, waarin de \nbetreffende ligplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een ligplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Ligplaats", "example": "NL.IMBAG.Ligplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een \nopname, mutatie of een verwijdering van gegevens ten aanzien van een \nobject heeft plaatsgevonden.\n", "format": "date", "example": "2011-12-30" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "AVGEL30122011-07" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkLigplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanLigplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekLigplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanLigplaats": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een ligplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van ligplaats\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Ligplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "404": { "description": "Not found.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 404, "title": "Opgevraagde resource bestaat niet.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", "detail": "The server has not found anything matching the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notFound" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "412": { "description": "Precondition failed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 412, "title": "Niet voldaan aan vooraf gestelde voorwaarde", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", "detail": "The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "preconditionFailed" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/ligplaatsen/{identificatie}/lvc": { "get": { "tags": [ "Ligplaats" ], "summary": "bevragen levenscyclus van een ligplaats met de identificatie van een ligplaats.", "description": "Bevragen/raadplegen van de levenscyclus van een ligplaats, via de identificatie van de ligplaats.", "operationId": "ligplaatsLvcIdentificatie", "parameters": [ { "name": "identificatie", "in": "path", "description": "De identificatie van een ligplaats uit de BAG.", "required": true, "style": "simple", "explode": false, "schema": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" } }, { "name": "geheleLvc", "in": "query", "description": "Filtert naast geldige voorkomens ook de voorkomens die uit de geldige levenscyclus van het object zijn verwijderd.\nAls deze parameter wordt weggelaten worden alleen geldige voorkomens geretourneerd (default is false).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true, "default": false } }, { "name": "Accept-Crs", "in": "header", "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging ligplaatsLvcIdentificatie geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Content-Crs": { "description": "CRS van de geometrie verstrekt door de server aan de client.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "voorkomens": { "minItems": 1, "type": "array", "items": { "allOf": [ { "allOf": [ { "title": "LigplaatsIO", "required": [ "ligplaats" ], "properties": { "ligplaats": { "title": "Ligplaats", "description": "Een Ligplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen plaats in het water al dan niet aangevuld met een op de oever \naanwezig terrein of een gedeelte daarvan, die bestemd is voor het permanent \nafmeren van een voor woon-, bedrijfsmatige of recreatieve doeleinden \ngeschikt drijvend object.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een ligplaats, waarin de \nbetreffende ligplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een ligplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Ligplaats", "example": "NL.IMBAG.Ligplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een \nopname, mutatie of een verwijdering van gegevens ten aanzien van een \nobject heeft plaatsgevonden.\n", "format": "date", "example": "2011-12-30" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "AVGEL30122011-07" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkLigplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanLigplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekLigplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanLigplaats": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een ligplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van ligplaats\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Ligplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] } } } }, "_links": { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "404": { "description": "Not found.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 404, "title": "Opgevraagde resource bestaat niet.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", "detail": "The server has not found anything matching the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notFound" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "412": { "description": "Precondition failed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 412, "title": "Niet voldaan aan vooraf gestelde voorwaarde", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", "detail": "The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "preconditionFailed" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/ligplaatsen/{identificatie}/{versie}/{timestampRegistratieLv}": { "get": { "tags": [ "Ligplaats" ], "summary": "bevragen voorkomen van een ligplaats met de identificatie van een ligplaats en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.", "description": "Bevragen/raadplegen van een voorkomen van een ligplaats met de identificatie van een ligplaats en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.", "operationId": "ligplaatsIdentificatieVoorkomen", "parameters": [ { "name": "identificatie", "in": "path", "description": "De identificatie van een ligplaats uit de BAG.", "required": true, "style": "simple", "explode": false, "schema": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" } }, { "name": "versie", "in": "path", "description": "De versie van een voorkomen van een object.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 1 } }, { "name": "timestampRegistratieLv", "in": "path", "description": "Een timestamp van het tijdstip waarop een voorkomen is geregistreerd in de LV BAG.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^\\d+$", "type": "string", "example": "1530403860000" } }, { "name": "Accept-Crs", "in": "header", "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging ligplaatsIdentificatieVoorkomen geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Content-Crs": { "description": "CRS van de geometrie verstrekt door de server aan de client.", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "allOf": [ { "allOf": [ { "title": "LigplaatsIO", "required": [ "ligplaats" ], "properties": { "ligplaats": { "title": "Ligplaats", "description": "Een Ligplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen plaats in het water al dan niet aangevuld met een op de oever \naanwezig terrein of een gedeelte daarvan, die bestemd is voor het permanent \nafmeren van een voor woon-, bedrijfsmatige of recreatieve doeleinden \ngeschikt drijvend object.\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n\n**status**: De fase van de levenscyclus van een ligplaats, waarin de \nbetreffende ligplaats zich bevindt.\n\n**geometrie**: De tweedimensionale geometrische representatie van de \nomtrekken van een ligplaats.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object \nwaarover gegevens geregistreerd worden, waarbij de gegevens gedurende een \nbepaalde periode gelijk zijn in de (basis) registratie.\n", "allOf": [ { "title": "AdresseerbaarObject", "required": [ "heeftAlsHoofdAdres", "type" ], "type": "object", "properties": { "heeftAlsHoofdAdres": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "Een adresseerbaar object heeft als nevenadres een nummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die een nevenadres is van het adresseerbare object.\n", "items": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, "type": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] } }, "description": "Abstract type adresseerbaar object\n\n**heeftAlsHoofdAdres**: Een adresseerbaar object heeft als hoofadres een \nnummeraanduiding.\n\nDeze property bevat de identificatie van de nummeraanduiding die het \nhoofdadres is van het adresseerbare object.\n", "discriminator": { "propertyName": "type" } }, { "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "geometrie", "identificatie", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Ligplaats", "example": "NL.IMBAG.Ligplaats" }, "status": { "title": "StatusPlaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een ligplaats en een standplaats kan aannemen.", "enum": [ "Plaats aangewezen", "Plaats ingetrokken" ] }, "geometrie": { "title": "Surface", "example": { "type": "Polygon", "coordinates": [ [ [ 207714.815, 474033.093, 0 ], [ 207714.752, 474033.015, 0 ], [ 207711.949, 474035.274, 0 ], [ 207712.012, 474035.352, 0 ], [ 207709.521, 474037.36, 0 ], [ 207696.597, 474021.265, 0 ], [ 207701.81, 474017.015, 0 ], [ 207700.455, 474015.414, 0 ], [ 207702.745, 474013.563, 0 ], [ 207706.48, 474010.544, 0 ], [ 207715.147, 474003.633, 0 ], [ 207719.675, 474000, 0 ], [ 207721.708, 473998.505, 0 ], [ 207721.734, 473998.54, 0 ], [ 207734.185, 473989.711, 0 ], [ 207735.432, 473992.061, 0 ], [ 207736.838, 473994.711, 0 ], [ 207738.01, 473996.919, 0 ], [ 207739.13, 473999.03, 0 ], [ 207740.107, 474000.734, 0 ], [ 207744.747, 474008.829, 0 ], [ 207745.138, 474009.51, 0 ], [ 207732.654, 474018.715, 0 ], [ 207714.815, 474033.093, 0 ] ], [ [ 207717.277, 474015.307, 0 ], [ 207719.863, 474018.659, 0 ], [ 207725.737, 474014.126, 0 ], [ 207723.15, 474010.774, 0 ], [ 207717.277, 474015.307, 0 ] ] ] }, "allOf": [ { "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": { "type": "number" } } } } } } ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een \nopname, mutatie of een verwijdering van gegevens ten aanzien van een \nobject heeft plaatsgevonden.\n", "format": "date", "example": "2011-12-30" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 \nkarakterset zijn toegestaan.\n", "example": "AVGEL30122011-07" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } } } ] }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkLigplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanLigplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekLigplaats", "type": "string", "enum": [ "geometrie", "status", "heeft als hoofdadres", "heeft als nevenadres" ] }, "identificatieVanLigplaats": { "title": "LigplaatsIdentificatie", "pattern": "^[0-9]{4}02[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een ligplaats.", "example": "0797020000056894" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een ligplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van ligplaats\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Een verzameling van een Ligplaats en een lijst van alle bijbehorende inonderzoek informatie." }, { "properties": { "_links": { "allOf": [ { "required": [ "heeftAlsHoofdAdres", "maaktDeelUitVan", "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsHoofdAdres": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "description": "De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } ] } } } ] }, { "properties": { "_embedded": { "allOf": [ { "type": "object", "properties": { "heeftAlsHoofdAdres": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, "heeftAlsNevenAdres": { "minItems": 1, "type": "array", "items": { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } ] } } } ] } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "404": { "description": "Not found.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 404, "title": "Opgevraagde resource bestaat niet.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", "detail": "The server has not found anything matching the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notFound" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "412": { "description": "Precondition failed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 412, "title": "Niet voldaan aan vooraf gestelde voorwaarde", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", "detail": "The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "preconditionFailed" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/nummeraanduidingen": { "get": { "tags": [ "Nummeraanduiding" ], "summary": "bevragen nummeraanduiding(en) op basis van verschillende combinaties van parameters.", "description": "De volgende (combinaties van) parameters worden ondersteund:\n\n1. Bevragen/raadplegen van een (collectie van) nummeraanduiding(en) met postcode en huisnummer (evt. met huisletter en huisnummertoevoeging).\n\n2. Bevragen/raadplegen van een (collectie van) nummeraanduiding(en) met woonplaats naam, openbare ruimte naam, huisnummer en optioneel huisnummertoevoeging en huisletter.\n\n3. Bevragen/zoeken van alle aan een openbare ruimte gerelateerde nummeraanduidingen met een openbare ruimte identificatie. \n Expand wordt niet ondersteund.\n \n4. Bevragen/zoeken van nummeraanduidingen met een pand identificatie.\n Expand wordt niet ondersteund.\n\n\nBij de bovenstaande bevragingen kunnen (tenzij anders vermeld) de volgende parameters worden gebruikt:\ngeldigOp, beschikbaarOp, huidig, page en pageSize. \nVoor paginering, zie: [functionele specificatie paginering](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).\n\nDe geldigOp en beschikbaarOp parameters kunnen gebruikt worden voor \ntijdreis vragen, zie \n[functionele specificatie tijdreizen](https://github.com/lvbag/BAG-API/blob/master/Features/tijdreizen.feature). \n\nParameter huidig kan worden toegepast, zie [functionele specificatie huidig](https://github.com/lvbag/BAG-API/blob/master/Features/huidig.feature).\n\nAls expand=ligtInWoonplaats, ligtAanOpenbareRuimte of als expand=true dan worden de gevraagde of alle gerelateerde objecten als geneste resources geleverd, zie\n[functionele specificatie expand](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature). \n\nMet de exacteMatch parameter kan worden aangegeven dat alleen object(en) die exact overeenkomen met de opgegeven parameters, geretourneerd moeten worden, zie\n[functionele specificatie exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_matchnd.feature).\n", "operationId": "zoekNummeraanduiding", "parameters": [ { "name": "postcode", "in": "query", "description": "Postcode behorende bij een nummeraanduiding.", "required": false, "style": "form", "explode": true, "schema": { "pattern": "^[1-9]{1}[0-9]{3}[ ]{0,1}[a-zA-Z]{2}$", "type": "string" }, "examples": { "zonderSpatie": { "value": "6922KZ" }, "metSpatie": { "value": "6922 KZ" } } }, { "name": "huisnummer", "in": "query", "description": "Huisnummer behorende bij een nummeraanduiding.", "required": false, "style": "form", "explode": true, "schema": { "maximum": 99999, "minimum": 1, "type": "integer", "example": 1 } }, { "name": "huisnummertoevoeging", "in": "query", "description": "Huisnummertoevoeging behorende bij een nummeraanduiding.", "required": false, "style": "form", "explode": true, "schema": { "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "example": "bis" } }, { "name": "huisletter", "in": "query", "description": "Huisletter behorende bij een nummeraanduiding.", "required": false, "style": "form", "explode": true, "schema": { "pattern": "^[a-zA-Z]{1}$", "type": "string", "example": "A" } }, { "name": "exacteMatch", "in": "query", "description": "Een indicatie of de resultaten van een zoekoperatie exact overeen \nmoeten komen met de zoekcriteria, zie \n[functionele specificatie exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true, "default": false } }, { "name": "woonplaatsNaam", "in": "query", "description": "De naam van een woonplaats.", "required": false, "style": "form", "explode": true, "schema": { "maxLength": 80, "minLength": 1, "type": "string", "example": "Duiven" } }, { "name": "openbareRuimteNaam", "in": "query", "description": "De naam van een openbare ruimte.", "required": false, "style": "form", "explode": true, "schema": { "maxLength": 80, "minLength": 1, "type": "string", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" } }, { "name": "openbareRuimteIdentificatie", "in": "query", "description": "De identificatie van een openbare ruimte uit de BAG.", "required": false, "style": "form", "explode": true, "schema": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, { "name": "huidig", "in": "query", "description": "Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false, "default": false } }, { "name": "geldigOp", "in": "query", "description": "Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD`\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2019-11-23" } }, { "name": "beschikbaarOp", "in": "query", "description": "Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd \n`YYYY-MM-DDThh:mm:ss.sss'. Hierin kunnen de seconden ':ss' en milliseconden \n'.sss' of alleen de milliseconden conform ISO 8601 specificatie worden \nweggelaten, in dat geval krijgen deze automatisch de waarde ':00' \nrespectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 \ncijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'.\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "description": "Pagina nummer", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Aantal resultaten per pagina", "required": false, "style": "form", "explode": true, "schema": { "maximum": 100, "minimum": 10, "type": "integer", "default": 20 } }, { "name": "expand", "in": "query", "description": "Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "pandIdentificatie", "in": "query", "description": "De identificatie van een pand uit de BAG.", "required": false, "style": "form", "explode": true, "schema": { "title": "PandIdentificatie", "pattern": "^[0-9]{4}10[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een pand.", "example": "0226100000008856" } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging zoekNummeraanduiding geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "X-Pagination-Page": { "description": "Huidige pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 3 }, "example": 3 }, "X-Pagination-Limit": { "description": "Aantal resultaten per pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 20 }, "example": 20 }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "nummeraanduidingen": { "type": "array", "items": { "allOf": [ { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, { "properties": { "_embedded": { "type": "object", "properties": { "ligtInWoonplaats": { "allOf": [ { "title": "WoonplaatsIO (incl. inonderzoek informatie)", "required": [ "woonplaats" ], "type": "object", "properties": { "woonplaats": { "title": "Woonplaats", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "naam", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Woonplaats", "example": "NL.IMBAG.Woonplaats" }, "naam": { "title": "naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.", "example": "Duiven" }, "status": { "title": "StatusWoonplaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen.", "enum": [ "Woonplaats aangewezen", "Woonplaats ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2009-02-09" }, "documentnummer": { "title": "documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "09.0898" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Woonplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorzien gedeelte van het grondgebied van de \ngemeente.\n\n**status**: De fase van de levenscyclus van een woonplaats, waarin de \nbetreffende woonplaats zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkWoonplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanWoonplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekWoonplaats", "type": "string", "enum": [ "naam", "geometrie", "status" ] }, "identificatieVanWoonplaats": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is. \n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'. \n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een woonplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van woonplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Woonplaats, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn (als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "bronhouders": { "minItems": 1, "type": "array", "description": "De gemeente(n) waar de woonplaats onderdeel van uitmaakt.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } ] }, "ligtAanOpenbareRuimte": { "allOf": [ { "title": "OpenbareRuimteIO (incl. in onderzoek)", "required": [ "openbareRuimte" ], "type": "object", "properties": { "openbareRuimte": { "title": "OpenbareRuimte", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "korteNaam", "ligtIn", "naam", "status", "type", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Openbareruimte", "example": "NL.IMBAG.Openbareruimte" }, "naam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe strekkend \nformeel gemeentelijk besluit.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "type": { "title": "TypeOpenbareRuimte", "type": "string", "description": "Een codering van de verschillende waarden die de typering van een openbare \nruimte kan aannemen.\n", "enum": [ "Weg", "Water", "Spoorbaan", "Terrein", "Kunstwerk", "Landschappelijk gebied", "Administratief gebied" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "korteNaam": { "title": "korteNaam", "maxLength": 24, "minLength": 1, "type": "string", "description": "De officiële openbare ruimte naam als deze niet langer is dan 24 tekens of \nde volgens de NEN5825 verkorte naam van maximaal 24 tekens.\n", "example": "Ln vd l D-Westervoort" }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-08-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "11INT00398" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" } }, "description": "Een Openbare ruimte is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorziene buitenruimte die binnen één woonplaats \nis gelegen.\n\n**type**: De aard van de als zodanig benoemde openbare ruimte.\n\n**status**: De fase van de levenscyclus van een openbare ruimte, waarin de \nbetreffende openbare ruimte zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een openbare ruimte ligt in een woonplaats.\nDeze property bevat de identificatie van de woonplaats waar de openbare\nruimte in ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkOpenbareRuimteInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanOpenbareRuimte", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekOpenbareRuimte", "type": "string", "enum": [ "naam", "type", "status", "gerelateerde woonplaats" ] }, "identificatieVanOpenbareRuimte": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een openbare ruimte waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van openbare ruimte.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Openbare ruimte, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } } ] } } } }, "_links": { "title": "HalPaginationLinks", "example": { "first": { "href": "/resourcenaam?page=1", "title": "Eerste pagina" }, "previous": { "href": "/resourcenaam?page=3", "title": "Vorige pagina" }, "next": { "href": "/resourcenaam?page=5", "title": "Volgende pagina" }, "last": { "href": "/resourcenaam?page=15", "title": "Laatste pagina" } }, "allOf": [ { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } }, { "type": "object", "properties": { "first": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "previous": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "next": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "last": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } ] } } } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/nummeraanduidingen/{nummeraanduidingIdentificatie}": { "get": { "tags": [ "Nummeraanduiding" ], "summary": "bevragen van een nummeraanduiding op basis van de identificatie van een nummeraanduiding", "description": "Bevragen/raadplegen van één nummeraanduiding met de identificatie van een nummeraanduiding.\nParameter huidig kan worden toegepast, zie [functionele specificatie huidig](https://github.com/lvbag/BAG-API/blob/master/Features/huidig.feature).\nDe geldigOp en beschikbaarOp parameters kunnen gebruikt worden voor tijdreis vragen, zie [functionele specificatie tijdreizen](https://github.com/lvbag/BAG-API/blob/master/Features/tijdreizen.feature). \nAls expand=ligtInWoonplaats, ligtAanOpenbareRuimte of als expand=true dan worden de gevraagde of alle gerelateerde objecten als geneste resources geleverd, zie [functionele specificatie expand](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature). ", "operationId": "nummeraanduidingIdentificatie", "parameters": [ { "name": "nummeraanduidingIdentificatie", "in": "path", "description": "De identificatie van een nummeraanduiding uit de BAG.", "required": true, "style": "simple", "explode": false, "schema": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, { "name": "geldigOp", "in": "query", "description": "Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD`\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2019-11-23" } }, { "name": "beschikbaarOp", "in": "query", "description": "Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd \n`YYYY-MM-DDThh:mm:ss.sss'. Hierin kunnen de seconden ':ss' en milliseconden \n'.sss' of alleen de milliseconden conform ISO 8601 specificatie worden \nweggelaten, in dat geval krijgen deze automatisch de waarde ':00' \nrespectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 \ncijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'.\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "expand", "in": "query", "description": "Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "huidig", "in": "query", "description": "Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false, "default": false } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging nummeraanduidingIdentificatie geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "allOf": [ { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, { "properties": { "_embedded": { "type": "object", "properties": { "ligtInWoonplaats": { "allOf": [ { "title": "WoonplaatsIO (incl. inonderzoek informatie)", "required": [ "woonplaats" ], "type": "object", "properties": { "woonplaats": { "title": "Woonplaats", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "naam", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Woonplaats", "example": "NL.IMBAG.Woonplaats" }, "naam": { "title": "naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.", "example": "Duiven" }, "status": { "title": "StatusWoonplaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen.", "enum": [ "Woonplaats aangewezen", "Woonplaats ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2009-02-09" }, "documentnummer": { "title": "documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "09.0898" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Woonplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorzien gedeelte van het grondgebied van de \ngemeente.\n\n**status**: De fase van de levenscyclus van een woonplaats, waarin de \nbetreffende woonplaats zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkWoonplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanWoonplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekWoonplaats", "type": "string", "enum": [ "naam", "geometrie", "status" ] }, "identificatieVanWoonplaats": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is. \n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'. \n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een woonplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van woonplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Woonplaats, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn (als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "bronhouders": { "minItems": 1, "type": "array", "description": "De gemeente(n) waar de woonplaats onderdeel van uitmaakt.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } ] }, "ligtAanOpenbareRuimte": { "allOf": [ { "title": "OpenbareRuimteIO (incl. in onderzoek)", "required": [ "openbareRuimte" ], "type": "object", "properties": { "openbareRuimte": { "title": "OpenbareRuimte", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "korteNaam", "ligtIn", "naam", "status", "type", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Openbareruimte", "example": "NL.IMBAG.Openbareruimte" }, "naam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe strekkend \nformeel gemeentelijk besluit.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "type": { "title": "TypeOpenbareRuimte", "type": "string", "description": "Een codering van de verschillende waarden die de typering van een openbare \nruimte kan aannemen.\n", "enum": [ "Weg", "Water", "Spoorbaan", "Terrein", "Kunstwerk", "Landschappelijk gebied", "Administratief gebied" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "korteNaam": { "title": "korteNaam", "maxLength": 24, "minLength": 1, "type": "string", "description": "De officiële openbare ruimte naam als deze niet langer is dan 24 tekens of \nde volgens de NEN5825 verkorte naam van maximaal 24 tekens.\n", "example": "Ln vd l D-Westervoort" }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-08-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "11INT00398" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" } }, "description": "Een Openbare ruimte is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorziene buitenruimte die binnen één woonplaats \nis gelegen.\n\n**type**: De aard van de als zodanig benoemde openbare ruimte.\n\n**status**: De fase van de levenscyclus van een openbare ruimte, waarin de \nbetreffende openbare ruimte zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een openbare ruimte ligt in een woonplaats.\nDeze property bevat de identificatie van de woonplaats waar de openbare\nruimte in ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkOpenbareRuimteInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanOpenbareRuimte", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekOpenbareRuimte", "type": "string", "enum": [ "naam", "type", "status", "gerelateerde woonplaats" ] }, "identificatieVanOpenbareRuimte": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een openbare ruimte waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van openbare ruimte.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Openbare ruimte, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } } ] } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "404": { "description": "Not found.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 404, "title": "Opgevraagde resource bestaat niet.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", "detail": "The server has not found anything matching the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notFound" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/nummeraanduidingen/{nummeraanduidingIdentificatie}/lvc": { "get": { "tags": [ "Nummeraanduiding" ], "summary": "bevragen levenscyclus van een nummeraanduiding met de identificatie van een nummeraanduiding.", "description": "Bevragen/raadplegen van de levenscyclus van één nummeraanduiding met de identificatie van een nummeraanduiding. ", "operationId": "nummeraanduidingLvcIdentificatie", "parameters": [ { "name": "nummeraanduidingIdentificatie", "in": "path", "description": "De identificatie van een nummeraanduiding uit de BAG.", "required": true, "style": "simple", "explode": false, "schema": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, { "name": "geheleLvc", "in": "query", "description": "Filtert naast geldige voorkomens ook de voorkomens die uit de geldige levenscyclus van het object zijn verwijderd.\nAls deze parameter wordt weggelaten worden alleen geldige voorkomens geretourneerd (default is false).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true, "default": false } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging nummeraanduidingLvcIdentificatie geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "voorkomens": { "minItems": 1, "type": "array", "items": { "allOf": [ { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, { "properties": { "_embedded": { "type": "object", "properties": { "ligtInWoonplaats": { "allOf": [ { "title": "WoonplaatsIO (incl. inonderzoek informatie)", "required": [ "woonplaats" ], "type": "object", "properties": { "woonplaats": { "title": "Woonplaats", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "naam", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Woonplaats", "example": "NL.IMBAG.Woonplaats" }, "naam": { "title": "naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.", "example": "Duiven" }, "status": { "title": "StatusWoonplaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen.", "enum": [ "Woonplaats aangewezen", "Woonplaats ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2009-02-09" }, "documentnummer": { "title": "documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "09.0898" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Woonplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorzien gedeelte van het grondgebied van de \ngemeente.\n\n**status**: De fase van de levenscyclus van een woonplaats, waarin de \nbetreffende woonplaats zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkWoonplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanWoonplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekWoonplaats", "type": "string", "enum": [ "naam", "geometrie", "status" ] }, "identificatieVanWoonplaats": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is. \n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'. \n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een woonplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van woonplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Woonplaats, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn (als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "bronhouders": { "minItems": 1, "type": "array", "description": "De gemeente(n) waar de woonplaats onderdeel van uitmaakt.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } ] }, "ligtAanOpenbareRuimte": { "allOf": [ { "title": "OpenbareRuimteIO (incl. in onderzoek)", "required": [ "openbareRuimte" ], "type": "object", "properties": { "openbareRuimte": { "title": "OpenbareRuimte", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "korteNaam", "ligtIn", "naam", "status", "type", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Openbareruimte", "example": "NL.IMBAG.Openbareruimte" }, "naam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe strekkend \nformeel gemeentelijk besluit.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "type": { "title": "TypeOpenbareRuimte", "type": "string", "description": "Een codering van de verschillende waarden die de typering van een openbare \nruimte kan aannemen.\n", "enum": [ "Weg", "Water", "Spoorbaan", "Terrein", "Kunstwerk", "Landschappelijk gebied", "Administratief gebied" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "korteNaam": { "title": "korteNaam", "maxLength": 24, "minLength": 1, "type": "string", "description": "De officiële openbare ruimte naam als deze niet langer is dan 24 tekens of \nde volgens de NEN5825 verkorte naam van maximaal 24 tekens.\n", "example": "Ln vd l D-Westervoort" }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-08-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "11INT00398" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" } }, "description": "Een Openbare ruimte is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorziene buitenruimte die binnen één woonplaats \nis gelegen.\n\n**type**: De aard van de als zodanig benoemde openbare ruimte.\n\n**status**: De fase van de levenscyclus van een openbare ruimte, waarin de \nbetreffende openbare ruimte zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een openbare ruimte ligt in een woonplaats.\nDeze property bevat de identificatie van de woonplaats waar de openbare\nruimte in ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkOpenbareRuimteInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanOpenbareRuimte", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekOpenbareRuimte", "type": "string", "enum": [ "naam", "type", "status", "gerelateerde woonplaats" ] }, "identificatieVanOpenbareRuimte": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een openbare ruimte waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van openbare ruimte.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Openbare ruimte, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } } ] } } } }, "_links": { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "404": { "description": "Not found.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 404, "title": "Opgevraagde resource bestaat niet.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", "detail": "The server has not found anything matching the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notFound" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/nummeraanduidingen/{nummeraanduidingIdentificatie}/{versie}/{timestampRegistratieLv}": { "get": { "tags": [ "Nummeraanduiding" ], "summary": "bevragen van een voorkomen van een nummeraanduiding, op basis van de identificatie van een nummeraanduiding en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.", "description": "Bevragen/raadplegen van een voorkomen van een nummeraanduiding met de identificatie van een nummeraanduiding en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.", "operationId": "nummeraanduidingIdentificatieVoorkomen", "parameters": [ { "name": "nummeraanduidingIdentificatie", "in": "path", "description": "De identificatie van een nummeraanduiding uit de BAG.", "required": true, "style": "simple", "explode": false, "schema": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" } }, { "name": "versie", "in": "path", "description": "De versie van een voorkomen van een object.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 1 } }, { "name": "timestampRegistratieLv", "in": "path", "description": "Een timestamp van het tijdstip waarop een voorkomen is geregistreerd in de LV BAG.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^\\d+$", "type": "string", "example": "1530403860000" } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging nummeraanduidingIdentificatieVoorkomen geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "allOf": [ { "allOf": [ { "title": "NummeraanduidingIO (incl. in onderzoek)", "required": [ "nummeraanduiding" ], "type": "object", "properties": { "nummeraanduiding": { "title": "Nummeraanduiding", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "huisnummer", "identificatie", "ligtAan", "status", "typeAdresseerbaarObject", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Nummeraanduiding", "example": "NL.IMBAG.Nummeraanduiding" }, "huisnummer": { "title": "huisnummer", "maximum": 99999, "minimum": 1, "type": "integer", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering.", "example": 1 }, "huisletter": { "title": "huisletter", "pattern": "^[a-zA-Z]{1}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.", "example": "A" }, "huisnummertoevoeging": { "title": "huisnummer toevoeging", "pattern": "^[0-9a-zA-Z]{1,4}$", "type": "string", "description": "Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter.", "example": "bis" }, "postcode": { "title": "postcode", "pattern": "^[1-9]{1}[0-9]{3}[A-Z]{2}$", "type": "string", "description": "De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer.", "example": "6922KZ" }, "typeAdresseerbaarObject": { "title": "TypeAdresseerbaarObject", "type": "string", "description": "De aard van het object waaraan een nummeraanduiding is toegekend.", "enum": [ "Verblijfsobject", "Standplaats", "Ligplaats" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2019-11-25" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "Duiven 25112019" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "ligtAan": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, "description": "Een Nummeraanduiding is een door het bevoegde gemeentelijke orgaan als \nzodanig toegekende aanduiding van een verblijfsobject, een standplaats of \neen ligplaats.\n\n**status**: De fase van de levenscyclus van een nummeraanduiding, waarin de \nbetreffende nummeraanduiding zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een nummeraanduiding ligt in een woonplaats.\nAls een object in een andere woonplaats ligt dan de openbare ruimte waaraan \nde nummeraanduiding ligt, dan wordt hier de identificatie van de woonplaats \ningevuld waar de nummeraanduiding in ligt. In alle andere gevallen wordt de \nidentificatie van de woonplaats ingevuld waar de openbare ruimte in ligt.\n\n**ligtAan**: Een nummeraanduiding ligt aan een openbare ruimte.\nDeze property bevat de identificatie van de openbare ruimte waar de \nnummeraanduiding aan ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkNummeraanduidingInOnderzoek", "required": [ "historie", "identificatieVanNummeraanduiding", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekNummeraanduiding", "type": "string", "enum": [ "huisnummer", "huisletter", "huisnummertoevoeging", "postcode", "type adresseerbaar object", "status", "ligt in", "ligt aan" ] }, "identificatieVanNummeraanduiding": { "title": "NummeraanduidingIdentificatie", "pattern": "^[0-9]{4}20[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een nummeraanduiding.", "example": "0226200000038923" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een nummeraanduiding waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van nummeraanduiding.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Nummeraanduiding, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtAanOpenbareRuimte": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, { "properties": { "_embedded": { "type": "object", "properties": { "ligtInWoonplaats": { "allOf": [ { "title": "WoonplaatsIO (incl. inonderzoek informatie)", "required": [ "woonplaats" ], "type": "object", "properties": { "woonplaats": { "title": "Woonplaats", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "naam", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Woonplaats", "example": "NL.IMBAG.Woonplaats" }, "naam": { "title": "naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.", "example": "Duiven" }, "status": { "title": "StatusWoonplaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen.", "enum": [ "Woonplaats aangewezen", "Woonplaats ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2009-02-09" }, "documentnummer": { "title": "documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "09.0898" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Woonplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorzien gedeelte van het grondgebied van de \ngemeente.\n\n**status**: De fase van de levenscyclus van een woonplaats, waarin de \nbetreffende woonplaats zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkWoonplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanWoonplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekWoonplaats", "type": "string", "enum": [ "naam", "geometrie", "status" ] }, "identificatieVanWoonplaats": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is. \n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'. \n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een woonplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van woonplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Woonplaats, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn (als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "bronhouders": { "minItems": 1, "type": "array", "description": "De gemeente(n) waar de woonplaats onderdeel van uitmaakt.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } ] }, "ligtAanOpenbareRuimte": { "allOf": [ { "title": "OpenbareRuimteIO (incl. in onderzoek)", "required": [ "openbareRuimte" ], "type": "object", "properties": { "openbareRuimte": { "title": "OpenbareRuimte", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "korteNaam", "ligtIn", "naam", "status", "type", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Openbareruimte", "example": "NL.IMBAG.Openbareruimte" }, "naam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe strekkend \nformeel gemeentelijk besluit.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "type": { "title": "TypeOpenbareRuimte", "type": "string", "description": "Een codering van de verschillende waarden die de typering van een openbare \nruimte kan aannemen.\n", "enum": [ "Weg", "Water", "Spoorbaan", "Terrein", "Kunstwerk", "Landschappelijk gebied", "Administratief gebied" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "korteNaam": { "title": "korteNaam", "maxLength": 24, "minLength": 1, "type": "string", "description": "De officiële openbare ruimte naam als deze niet langer is dan 24 tekens of \nde volgens de NEN5825 verkorte naam van maximaal 24 tekens.\n", "example": "Ln vd l D-Westervoort" }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-08-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "11INT00398" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" } }, "description": "Een Openbare ruimte is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorziene buitenruimte die binnen één woonplaats \nis gelegen.\n\n**type**: De aard van de als zodanig benoemde openbare ruimte.\n\n**status**: De fase van de levenscyclus van een openbare ruimte, waarin de \nbetreffende openbare ruimte zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een openbare ruimte ligt in een woonplaats.\nDeze property bevat de identificatie van de woonplaats waar de openbare\nruimte in ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkOpenbareRuimteInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanOpenbareRuimte", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekOpenbareRuimte", "type": "string", "enum": [ "naam", "type", "status", "gerelateerde woonplaats" ] }, "identificatieVanOpenbareRuimte": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een openbare ruimte waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van openbare ruimte.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Openbare ruimte, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] } } } } } ] } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "404": { "description": "Not found.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 404, "title": "Opgevraagde resource bestaat niet.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", "detail": "The server has not found anything matching the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notFound" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/openbareruimten": { "get": { "tags": [ "Openbare ruimte" ], "summary": "bevragen openbare ruimte(n) op basis van de verschillende combinaties van parameters.", "description": "De volgende (combinaties van) parameters worden ondersteund:\n\n1. Bevragen/raadplegen van een openbare ruimte met een woonplaats naam en een openbare ruimte naam.\n Als expand=ligtInWoonplaats of true dan wordt de woonplaats als geneste resource geleverd, zie\n[functionele specificatie expand](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature).\n\n2. Bevragen/raadplegen van een openbare ruimte met een woonplaats identificatie en een openbare ruimte naam.\n Als expand=ligtInWoonplaats of true dan wordt de woonplaats als geneste resource geleverd, zie\n[functionele specificatie expand](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature).\n\n3. Bevragen/zoeken van alle aan een woonplaats gerelateerde openbare ruimten met de woonplaats identificatie.\n Parameter huidig kan worden toegepast, zie [functionele specificatie huidig](https://github.com/lvbag/BAG-API/blob/master/Features/huidig.feature).\n Expand wordt niet ondersteund.\n\n\nBij alle bovenstaande combinaties wordt paginering ondersteund en kunnen de parameters geldigOp en beschikbaarOp worden gebruikt.\nVoor paginering, zie: [functionele specificatie paginering](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).\n\nDe geldigOp en beschikbaarOp parameters kunnen gebruikt worden voor \ntijdreis vragen, zie \n[functionele specificatie tijdreizen](https://github.com/lvbag/BAG-API/blob/master/Features/tijdreizen.feature). \n", "operationId": "zoekOpenbareRuimten", "parameters": [ { "name": "woonplaatsNaam", "in": "query", "description": "De naam van een woonplaats object uit de BAG.", "required": false, "style": "form", "explode": true, "schema": { "maxLength": 80, "minLength": 1, "type": "string", "example": "Duiven" } }, { "name": "openbareRuimteNaam", "in": "query", "description": "De naam van een openbare ruimte object uit de BAG.", "required": false, "style": "form", "explode": true, "schema": { "maxLength": 80, "minLength": 1, "type": "string", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" } }, { "name": "woonplaatsIdentificatie", "in": "query", "description": "De identificatie van een woonplats uit de BAG.", "required": false, "style": "form", "explode": true, "schema": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" } }, { "name": "huidig", "in": "query", "description": "Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false, "default": false } }, { "name": "geldigOp", "in": "query", "description": "Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD`\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2019-11-23" } }, { "name": "beschikbaarOp", "in": "query", "description": "Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd \n`YYYY-MM-DDThh:mm:ss.sss'. Hierin kunnen de seconden ':ss' en milliseconden \n'.sss' of alleen de milliseconden conform ISO 8601 specificatie worden \nweggelaten, in dat geval krijgen deze automatisch de waarde ':00' \nrespectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 \ncijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'.\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "description": "Pagina nummer", "required": false, "style": "form", "explode": true, "schema": { "minimum": 1, "type": "integer", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Aantal resultaten per pagina", "required": false, "style": "form", "explode": true, "schema": { "maximum": 100, "minimum": 10, "type": "integer", "default": 20 } }, { "name": "expand", "in": "query", "description": "Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging zoekOpenbareRuimten geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "X-Pagination-Page": { "description": "Huidige pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 3 }, "example": 3 }, "X-Pagination-Limit": { "description": "Aantal resultaten per pagina.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 20 }, "example": 20 }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "openbareruimten": { "minItems": 1, "type": "array", "items": { "allOf": [ { "allOf": [ { "title": "OpenbareRuimteIO (incl. in onderzoek)", "required": [ "openbareRuimte" ], "type": "object", "properties": { "openbareRuimte": { "title": "OpenbareRuimte", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "korteNaam", "ligtIn", "naam", "status", "type", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Openbareruimte", "example": "NL.IMBAG.Openbareruimte" }, "naam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe strekkend \nformeel gemeentelijk besluit.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "type": { "title": "TypeOpenbareRuimte", "type": "string", "description": "Een codering van de verschillende waarden die de typering van een openbare \nruimte kan aannemen.\n", "enum": [ "Weg", "Water", "Spoorbaan", "Terrein", "Kunstwerk", "Landschappelijk gebied", "Administratief gebied" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "korteNaam": { "title": "korteNaam", "maxLength": 24, "minLength": 1, "type": "string", "description": "De officiële openbare ruimte naam als deze niet langer is dan 24 tekens of \nde volgens de NEN5825 verkorte naam van maximaal 24 tekens.\n", "example": "Ln vd l D-Westervoort" }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-08-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "11INT00398" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" } }, "description": "Een Openbare ruimte is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorziene buitenruimte die binnen één woonplaats \nis gelegen.\n\n**type**: De aard van de als zodanig benoemde openbare ruimte.\n\n**status**: De fase van de levenscyclus van een openbare ruimte, waarin de \nbetreffende openbare ruimte zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een openbare ruimte ligt in een woonplaats.\nDeze property bevat de identificatie van de woonplaats waar de openbare\nruimte in ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkOpenbareRuimteInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanOpenbareRuimte", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekOpenbareRuimte", "type": "string", "enum": [ "naam", "type", "status", "gerelateerde woonplaats" ] }, "identificatieVanOpenbareRuimte": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een openbare ruimte waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van openbare ruimte.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Openbare ruimte, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, { "properties": { "_embedded": { "type": "object", "properties": { "ligtInWoonplaats": { "allOf": [ { "title": "WoonplaatsIO (incl. inonderzoek informatie)", "required": [ "woonplaats" ], "type": "object", "properties": { "woonplaats": { "title": "Woonplaats", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "naam", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Woonplaats", "example": "NL.IMBAG.Woonplaats" }, "naam": { "title": "naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.", "example": "Duiven" }, "status": { "title": "StatusWoonplaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen.", "enum": [ "Woonplaats aangewezen", "Woonplaats ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2009-02-09" }, "documentnummer": { "title": "documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "09.0898" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Woonplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorzien gedeelte van het grondgebied van de \ngemeente.\n\n**status**: De fase van de levenscyclus van een woonplaats, waarin de \nbetreffende woonplaats zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkWoonplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanWoonplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekWoonplaats", "type": "string", "enum": [ "naam", "geometrie", "status" ] }, "identificatieVanWoonplaats": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is. \n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'. \n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een woonplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van woonplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Woonplaats, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn (als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "bronhouders": { "minItems": 1, "type": "array", "description": "De gemeente(n) waar de woonplaats onderdeel van uitmaakt.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } ] } } } } } ] } } } }, "_links": { "title": "HalPaginationLinks", "example": { "first": { "href": "/resourcenaam?page=1", "title": "Eerste pagina" }, "previous": { "href": "/resourcenaam?page=3", "title": "Vorige pagina" }, "next": { "href": "/resourcenaam?page=5", "title": "Volgende pagina" }, "last": { "href": "/resourcenaam?page=15", "title": "Laatste pagina" } }, "allOf": [ { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } }, { "type": "object", "properties": { "first": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "previous": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "next": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "last": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } ] } } } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/openbareruimten/{openbareRuimteIdentificatie}": { "get": { "tags": [ "Openbare ruimte" ], "summary": "bevragen van een openbare ruimte met de identificatie van een openbare ruimte.", "description": "Bevragen/raadplegen van een openbare ruimte met de identificatie van een openbare ruimte.\nParameter huidig kan worden toegepast, zie [functionele specificatie huidig](https://github.com/lvbag/BAG-API/blob/master/Features/huidig.feature).\nDe geldigOp en beschikbaarOp parameters kunnen gebruikt worden voor tijdreis vragen, zie [functionele specificatie tijdreizen](https://github.com/lvbag/BAG-API/blob/master/Features/tijdreizen.feature). \nAls expand=ligtInWoonplaats of true dan wordt de woonplaats als geneste resource geleverd, zie [functionele specificatie expand](https://github.com/lvbag/BAG-API/blob/master/Features/expand.feature).", "operationId": "openbareruimteIdentificatie", "parameters": [ { "name": "openbareRuimteIdentificatie", "in": "path", "description": "De identificatie van een openbare ruimte uit de BAG.", "required": true, "style": "simple", "explode": false, "schema": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, { "name": "geldigOp", "in": "query", "description": "Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD`\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date", "example": "2019-11-23" } }, { "name": "beschikbaarOp", "in": "query", "description": "Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd \n`YYYY-MM-DDThh:mm:ss.sss'. Hierin kunnen de seconden ':ss' en milliseconden \n'.sss' of alleen de milliseconden conform ISO 8601 specificatie worden \nweggelaten, in dat geval krijgen deze automatisch de waarde ':00' \nrespectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 \ncijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'.\nDeze parameter komt uit de API strategie, het hoofdstuk \n[Temporal](https://docs.geostandaarden.nl/api/API-Strategie-ext/#temporal).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "expand", "in": "query", "description": "Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "huidig", "in": "query", "description": "Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false, "default": false } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging openbareruimtenIdentificatie geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "allOf": [ { "allOf": [ { "title": "OpenbareRuimteIO (incl. in onderzoek)", "required": [ "openbareRuimte" ], "type": "object", "properties": { "openbareRuimte": { "title": "OpenbareRuimte", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "korteNaam", "ligtIn", "naam", "status", "type", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Openbareruimte", "example": "NL.IMBAG.Openbareruimte" }, "naam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe strekkend \nformeel gemeentelijk besluit.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "type": { "title": "TypeOpenbareRuimte", "type": "string", "description": "Een codering van de verschillende waarden die de typering van een openbare \nruimte kan aannemen.\n", "enum": [ "Weg", "Water", "Spoorbaan", "Terrein", "Kunstwerk", "Landschappelijk gebied", "Administratief gebied" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "korteNaam": { "title": "korteNaam", "maxLength": 24, "minLength": 1, "type": "string", "description": "De officiële openbare ruimte naam als deze niet langer is dan 24 tekens of \nde volgens de NEN5825 verkorte naam van maximaal 24 tekens.\n", "example": "Ln vd l D-Westervoort" }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-08-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "11INT00398" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" } }, "description": "Een Openbare ruimte is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorziene buitenruimte die binnen één woonplaats \nis gelegen.\n\n**type**: De aard van de als zodanig benoemde openbare ruimte.\n\n**status**: De fase van de levenscyclus van een openbare ruimte, waarin de \nbetreffende openbare ruimte zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een openbare ruimte ligt in een woonplaats.\nDeze property bevat de identificatie van de woonplaats waar de openbare\nruimte in ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkOpenbareRuimteInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanOpenbareRuimte", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekOpenbareRuimte", "type": "string", "enum": [ "naam", "type", "status", "gerelateerde woonplaats" ] }, "identificatieVanOpenbareRuimte": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een openbare ruimte waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van openbare ruimte.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Openbare ruimte, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, { "properties": { "_embedded": { "type": "object", "properties": { "ligtInWoonplaats": { "allOf": [ { "title": "WoonplaatsIO (incl. inonderzoek informatie)", "required": [ "woonplaats" ], "type": "object", "properties": { "woonplaats": { "title": "Woonplaats", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "naam", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Woonplaats", "example": "NL.IMBAG.Woonplaats" }, "naam": { "title": "naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.", "example": "Duiven" }, "status": { "title": "StatusWoonplaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen.", "enum": [ "Woonplaats aangewezen", "Woonplaats ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2009-02-09" }, "documentnummer": { "title": "documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "09.0898" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Woonplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorzien gedeelte van het grondgebied van de \ngemeente.\n\n**status**: De fase van de levenscyclus van een woonplaats, waarin de \nbetreffende woonplaats zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkWoonplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanWoonplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekWoonplaats", "type": "string", "enum": [ "naam", "geometrie", "status" ] }, "identificatieVanWoonplaats": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is. \n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'. \n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een woonplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van woonplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Woonplaats, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn (als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "bronhouders": { "minItems": 1, "type": "array", "description": "De gemeente(n) waar de woonplaats onderdeel van uitmaakt.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } ] } } } } } ] } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "404": { "description": "Not found.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 404, "title": "Opgevraagde resource bestaat niet.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", "detail": "The server has not found anything matching the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notFound" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/openbareruimten/{openbareRuimteIdentificatie}/lvc": { "get": { "tags": [ "Openbare ruimte" ], "summary": "bevragen levenscyclus van een openbare ruimte met de identificatie van een openbare ruimte.", "description": "Bevragen/raadplegen van de levenscyclus van één openbare ruimte, via de identificatie van een openbare ruimte.", "operationId": "openbareruimteLvcIdentificatie", "parameters": [ { "name": "openbareRuimteIdentificatie", "in": "path", "description": "De identificatie van een openbare ruimte uit de BAG.", "required": true, "style": "simple", "explode": false, "schema": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, { "name": "geheleLvc", "in": "query", "description": "Filtert naast geldige voorkomens ook de voorkomens die uit de geldige levenscyclus van het object zijn verwijderd.\nAls deze parameter wordt weggelaten worden alleen geldige voorkomens geretourneerd (default is false).\n", "required": false, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true, "default": false } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging openbareruimteLvcIdentificatie geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "type": "object", "properties": { "_embedded": { "type": "object", "properties": { "voorkomens": { "minItems": 1, "type": "array", "items": { "allOf": [ { "allOf": [ { "title": "OpenbareRuimteIO (incl. in onderzoek)", "required": [ "openbareRuimte" ], "type": "object", "properties": { "openbareRuimte": { "title": "OpenbareRuimte", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "korteNaam", "ligtIn", "naam", "status", "type", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Openbareruimte", "example": "NL.IMBAG.Openbareruimte" }, "naam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe strekkend \nformeel gemeentelijk besluit.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "type": { "title": "TypeOpenbareRuimte", "type": "string", "description": "Een codering van de verschillende waarden die de typering van een openbare \nruimte kan aannemen.\n", "enum": [ "Weg", "Water", "Spoorbaan", "Terrein", "Kunstwerk", "Landschappelijk gebied", "Administratief gebied" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "korteNaam": { "title": "korteNaam", "maxLength": 24, "minLength": 1, "type": "string", "description": "De officiële openbare ruimte naam als deze niet langer is dan 24 tekens of \nde volgens de NEN5825 verkorte naam van maximaal 24 tekens.\n", "example": "Ln vd l D-Westervoort" }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een object heeft \nplaatsgevonden.\n", "format": "date", "example": "2011-08-22" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, \nmutatie of een verwijdering van gegevens ten aanzien van een woonplaats \nheeft plaatsgevonden binnen een gemeente. \nAlle karakters uit de MES-1 karakterset zijn toegestaan.\n", "example": "11INT00398" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." }, "ligtIn": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" } }, "description": "Een Openbare ruimte is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorziene buitenruimte die binnen één woonplaats \nis gelegen.\n\n**type**: De aard van de als zodanig benoemde openbare ruimte.\n\n**status**: De fase van de levenscyclus van een openbare ruimte, waarin de \nbetreffende openbare ruimte zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n\n**ligtIn**: Een openbare ruimte ligt in een woonplaats.\nDeze property bevat de identificatie van de woonplaats waar de openbare\nruimte in ligt.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkOpenbareRuimteInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanOpenbareRuimte", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekOpenbareRuimte", "type": "string", "enum": [ "naam", "type", "status", "gerelateerde woonplaats" ] }, "identificatieVanOpenbareRuimte": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.\n", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt \nvastgelegd. \nDit wordt vastgelegd in het attribuut documentnummer.\n", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is.\n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'.\n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde is van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een openbare ruimte waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van openbare ruimte.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Openbare ruimte, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn(als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "ligtInWoonplaats": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } ] }, { "properties": { "_embedded": { "type": "object", "properties": { "ligtInWoonplaats": { "allOf": [ { "title": "WoonplaatsIO (incl. inonderzoek informatie)", "required": [ "woonplaats" ], "type": "object", "properties": { "woonplaats": { "title": "Woonplaats", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "naam", "status", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Woonplaats", "example": "NL.IMBAG.Woonplaats" }, "naam": { "title": "naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "De benaming van een door het gemeentebestuur aangewezen woonplaats.", "example": "Duiven" }, "status": { "title": "StatusWoonplaats", "type": "string", "description": "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen.", "enum": [ "Woonplaats aangewezen", "Woonplaats ingetrokken" ] }, "geconstateerd": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden.", "format": "date", "example": "2009-02-09" }, "documentnummer": { "title": "documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan.", "example": "09.0898" }, "voorkomen": { "title": "VoorkomenLV", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV", "versie" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "versie": { "title": "versie", "type": "integer", "description": "De identificatie van een voorkomen van een object.", "example": 3 }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipInactief": { "title": "tijdstipInactief", "type": "string", "description": "Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd.", "format": "date-time" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipNietBAG": { "title": "tijdstipNietBAG", "type": "string", "description": "Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" }, "tijdstipInactiefLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die worden bijgehouden bij een voorkomen van een object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9 aangevuld met de historie die alleen in de LVBAG wordt opgebouwd." } }, "description": "Een Woonplaats is een door het bevoegde gemeentelijke orgaan als zodanig \naangewezen en van een naam voorzien gedeelte van het grondgebied van de \ngemeente.\n\n**status**: De fase van de levenscyclus van een woonplaats, waarin de \nbetreffende woonplaats zich bevindt.\n\n**geconstateerd**: Een aanduiding waarmee kan worden aangegeven dat een \nobject in de registratie is opgenomen als gevolg van een feitelijke \nconstatering, zonder dat er op het moment van opname sprake was van een \nregulier brondocument voor deze opname.\n\n**voorkomen**: De toestand van een object in de administratieve \nwerkelijkheid, zoals beschreven met de eigenschappen van dit object waarover \ngegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde \nperiode gelijk zijn in de (basis) registratie.\n" }, "inonderzoek": { "minItems": 1, "type": "array", "items": { "title": "KenmerkWoonplaatsInOnderzoek", "required": [ "documentdatum", "documentnummer", "historie", "identificatieVanWoonplaats", "inOnderzoek", "kenmerk" ], "type": "object", "properties": { "kenmerk": { "title": "InOnderzoekWoonplaats", "type": "string", "enum": [ "naam", "geometrie", "status" ] }, "identificatieVanWoonplaats": { "title": "WoonplaatsIdentificatie", "pattern": "^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$", "type": "string", "description": "De unieke aanduiding van een woonplaats, zoals opgenomen in de landelijke \nwoonplaatsentabel.\nEen natuurlijk getal tussen 0001 en 9999. \n", "example": "2096" }, "inOnderzoek": { "title": "Indicatie", "type": "string", "description": "Een aanduiding waarmee kan worden aangegeven of een attribuut van een object of data type een indicatie J (Ja) of N (Nee) heeft in de registratie.", "enum": [ "J", "N" ] }, "historie": { "title": "HistorieInOnderzoek", "required": [ "beginGeldigheid", "tijdstipRegistratie", "tijdstipRegistratieLV" ], "type": "object", "properties": { "tijdstipRegistratie": { "title": "tijdstipRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van en BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt.", "format": "date-time" }, "eindRegistratie": { "title": "eindRegistratie", "type": "string", "description": "Het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van een bronhouder.", "format": "date-time" }, "beginGeldigheid": { "title": "beginGeldigheid", "type": "string", "description": "De datum waarop een versie van een onderzoek naar een attribuut van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen.", "format": "date", "example": "2019-06-01" }, "eindGeldigheid": { "title": "eindGeldigheid", "type": "string", "description": "De datum waarop de periode van geldigheid van een versie van een onderzoek naar een attribuut van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig.", "format": "date", "example": "2019-06-01" }, "tijdstipRegistratieLV": { "title": "tijdstipRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers.", "format": "date-time" }, "tijdstipEindRegistratieLV": { "title": "tijdstipEindRegistratieLV", "type": "string", "description": "Dit is het tijdstip waarop een versie van een onderzoek naar een attribuut van een BAG-object is beëindigd in de registratie van de landelijke voorziening.", "format": "date-time" } }, "description": "Alle tijdslijn metagegevens die wordt bijgehouden bij een voorkomen van een kenmerk in onderzoek object en die te maken hebben met het historiemodel van de BAG en LVBAG conform de BAG Catalogus 2018 hoofdstuk 9.\n" }, "documentdatum": { "title": "documentdatum", "type": "string", "description": "De datum van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentdatum.", "format": "date", "example": "2019-08-14" }, "documentnummer": { "title": "Documentnummer", "maxLength": 40, "minLength": 1, "type": "string", "description": "Het nummer van het document waarin de grondslag van het onderzoek wordt vastgelegd. Dit wordt vastgelegd in het attribuut documentnummer.", "example": "AV-2019-08-19-00" } }, "description": "Een indicatie waarmee aangegeven is dat een specifiek kenmerk van een specifieke object wel of niet in onderzoek is. \n\nHet gegeven wat geregistreerd is voor dit kenmerk is mogelijk onjuist, te herkennen aan het gegeven 'in onderzoek': 'Ja'. \n\nNa onderzoek kan blijken dat het gegeven wel juist is. Zolang 'in onderzoek' de waarde 'Ja' heeft, komt de gebruiksplicht van het kenmerk te vervallen, althans voor die organisaties waarvoor de gebruiksplicht geldt. Het gegeven mag wel gebruikt worden.\n\nEen enkelvoudig kenmerk is in algemeenheid in onderzoek, waarbij door de bronhouder onderzocht wordt wat de juiste waarde van dit kenmerk moet zijn. Om deze reden kan een kenmerk nooit meerdere keren in onderzoek zijn (ondanks dat er om meerdere redenen onderzoeken zijn gestart).\n\n**kenmerk**: Het specifieke kenmerk van een woonplaats waarvoor geregistreerd is dat dit kenmerk in onderzoek is.\n\n**identificatieVanLigplaats**: Identificatie van woonplaats.\n\n**inOnderzoek**: Aanduiding of een kenmerk wel of niet in onderzoek is.\n\n**historie**: De toestand van een kenmerk in onderzoek object in de administratieve werkelijkheid, zoals beschreven met de eigenschappen van dit object waarover gegevens geregistreerd worden, waarbij de gegevens gedurende een bepaalde periode gelijk zijn in de (basis) registratie.\n" } } }, "description": "Woonplaats, aangevuld met een limitatieve opsomming van alle kenmerken van dit object die in onderzoek zijn (als metadata). Bij een normale vraag wordt aangegeven welke kenmerken er op dit moment in onderzoek zijn. Bij een tijdreisvraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest. Bij een levenscyclus vraag wordt aangegeven welke gegevens er ooit in onderzoek zijn geweest." }, { "properties": { "_links": { "required": [ "self" ], "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" }, "bronhouders": { "minItems": 1, "type": "array", "description": "De gemeente(n) waar de woonplaats onderdeel van uitmaakt.", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } ] } } } } } ] } } } }, "_links": { "title": "HalCollectionLinks", "type": "object", "properties": { "self": { "required": [ "href" ], "type": "object", "properties": { "href": { "title": "Href", "type": "string", "example": "https://{base-uri}/{dienst}/{apinaam}/{major-versie}/resourcenaam/{resource-identificatie}" }, "templated": { "type": "boolean" }, "title": { "type": "string", "description": "Voor mens leesbaar label bij de link" } }, "description": "Het Link Object zoals gespecificeerd in \nhttps://tools.ietf.org/html/draft-kelly-json-hal-08#section-5'\n" } } } } } } } }, "400": { "description": "Bad request", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 400, "title": "Ten minste één parameter moet worden opgegeven.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", "detail": "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "paramsRequired", "invalid-params": [ { "type": "https://www.vng.nl/realisatie/api/validaties/integer", "name": "verblijfplaats_huisnummer", "code": "integer", "reason": "Waarde is geen geldige integer." } ] } } } }, "401": { "description": "Unauthorized. Je hebt waarschijnlijk geen geldige `X-Api-Key` header meegestuurd.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 401, "title": "Niet correct geauthenticeerd.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", "detail": "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "authentication" } } } }, "403": { "description": "Forbidden. Je hebt geen rechten om deze URL te benaderen.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 403, "title": "U bent niet geautoriseerd voor deze operatie.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", "detail": "The server understood the request, but is refusing to fulfill it.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "autorisation" } } } }, "404": { "description": "Not found.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 404, "title": "Opgevraagde resource bestaat niet.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", "detail": "The server has not found anything matching the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notFound" } } } }, "405": { "description": "Method not allowed.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "example": { "status": 405, "title": "Methode niet toegestaan", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.6 405 Method Not Allowed", "detail": "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "methodNotAllowed" } } } }, "406": { "description": "Not Acceptable. Je hebt waarschijnlijk een gewenst formaat met de `Accept` header verstuurd welke niet ondersteund wordt.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "acceptCrs": { "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "deprecated": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": [ "epsg:28992" ] } } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 406, "title": "Gevraagde contenttype wordt niet ondersteund.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAcceptable" } } } }, "429": { "description": "Too many requests.", "headers": { "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "allOf": [ { "title": "ProblemDetails", "type": "object", "properties": { "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" } }, "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807." }, { "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." } } } ] }, "example": { "type": "https://tools.ietf.org/html/rfc6585", "title": "Te veel verzoeken", "status": 429, "detail": "The user has sent too many requests in a given amount of time (rate limiting).", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "tooManyRequests" } } } }, "500": { "description": "Internal server error.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 500, "title": "Interne server fout.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", "detail": "The server encountered an unexpected condition which prevented it from fulfilling the request.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "serverError" } } } }, "503": { "description": "Service Unavailable. Er vindt mogelijk (gepland) onderhoud of een storing plaats.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "Retry-After": { "description": "Tijdstip waarop verwacht wordt dat de service weer beschikbaar zal zijn.", "style": "simple", "explode": false, "schema": { "type": "string", "format": "date-time" }, "x-example": "Sun, 28 Nov 2017 16:41:41 GMT" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } }, "example": { "status": 503, "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", "detail": "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", "code": "notAvailable" } } } } }, "security": [ { "apiKeyBAG": [] } ] } }, "/openbareruimten/{openbareRuimteIdentificatie}/{versie}/{timestampRegistratieLv}": { "get": { "tags": [ "Openbare ruimte" ], "summary": "bevragen van een voorkomen van een openbare ruimte met de identificatie van een openbare ruimte en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.", "description": "Bevragen/raadplegen van een voorkomen van een openbare ruimte met de identificatie van een openbare ruimte en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.", "operationId": "openbareruimteIdentificatieVoorkomen", "parameters": [ { "name": "openbareRuimteIdentificatie", "in": "path", "description": "De identificatie van een openbare ruimte uit de BAG.", "required": true, "style": "simple", "explode": false, "schema": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" } }, { "name": "versie", "in": "path", "description": "De versie van een voorkomen van een object.", "required": true, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 1 } }, { "name": "timestampRegistratieLv", "in": "path", "description": "Een timestamp van het tijdstip waarop een voorkomen is geregistreerd in de LV BAG.", "required": true, "style": "simple", "explode": false, "schema": { "pattern": "^\\d+$", "type": "string", "example": "1530403860000" } } ], "responses": { "default": { "description": "Er is een onverwachte fout opgetreden.", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" } }, "content": { "application/problem+json": { "schema": { "title": "Error", "required": [ "detail", "instance", "status", "title", "type" ], "type": "object", "properties": { "status": { "type": "integer", "description": "De HTTP status code.", "example": 401 }, "title": { "type": "string", "description": "De titel behorende bij de HTTP status code.", "example": "Niet correct geauthenticeerd" }, "type": { "type": "string", "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n", "format": "uri", "example": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized" }, "detail": { "type": "string", "description": "Een gedetailleerde beschrijving van de HTTP status code.", "example": "Het verzoek vereist gebruikers authenticatie." }, "instance": { "type": "string", "description": "URI van de aanroep die fout heeft veroorzaakt.", "format": "uri" }, "code": { "minLength": 1, "type": "string", "description": "Systeem code die het type fout aangeeft." }, "invalid-params": { "type": "array", "items": { "title": "InvalidParams", "required": [ "code", "name", "reason" ], "type": "object", "properties": { "type": { "type": "string", "description": "Een url naar een beschrijving van de fout in de parameter. \nDe hier gerefereerde foutbeschrijving is specifieker dan type op het \nhoofdniveau van het bericht.\n", "format": "uri" }, "name": { "type": "string", "description": "De naam van de parameter waar de fout in zit.", "example": "geldigOp" }, "code": { "type": "string", "description": "Een vaste waarde afhankelijk van het soort fout.", "example": "date" }, "reason": { "type": "string", "description": "Een vaste omschrijving afhankelijk van het soort fout.", "example": "Waarde is geen geldige datum." } }, "description": "Wanneer de fout is veroorzaakt door fouten in requestparameters (of request body), \nwordt invalid-params gevuld met details over elke foute parameter.\nWanneer er fouten zitten op meerdere parameters, wordt er per validatiefout een \ninvalid-params instantie opgenomen in het antwoord. \nAlle fouten worden dus teruggegeven.\nEen gedetailleerde beschrijving hoe de onderstaande attributen ingevuld moeten \nworden staat op:\nhttps://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/master/features/foutafhandeling.feature\"\n" } } } } } } }, "200": { "description": "Bevraging openbareruimteIdentificatieVoorkomen geslaagd", "headers": { "api-version": { "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "1.0.1" }, "example": "1.0.1" }, "warning": { "description": "Zie RFC 7234. \nIn het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 \n(\"Miscellaneous Persistent Warning\") en het API end-point (inclusief \nversienummer) als de warn-agent van de warning, gevolgd door de warn-text \nmet de human-readable waarschuwing.\n", "required": false, "style": "simple", "explode": false, "schema": { "type": "string", "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "example": "299 https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op ... . Raadpleeg voor meer informatie hier de documentatie: https://www.kadaster.nl/zakelijk/producten/adressen-en-gebouwen/bag-api-individuele-bevragingen.\"" }, "Kadaster-RateLimit-DayLimit": { "description": "Aantal requests dat is toegestaan per dag.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 50000 }, "example": 50000 }, "Kadaster-RateLimit-DayLimit-Remaining": { "description": "Het resterende aantal requests voordat de dag limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 100 }, "example": 100 }, "Kadaster-RateLimit-DayLimit-Reset": { "description": "Het aantal seconden tot het moment waarop de limiet wordt gereset.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64", "example": 3600 }, "example": 3600 }, "RateLimit-Limit": { "description": "Aantal requests dat is toegestaan per seconde.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 10 }, "example": 10 }, "RateLimit-Remaining": { "description": "Het resterende aantal requests voordat de limiet wordt bereikt.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "example": 6 }, "example": 6 }, "RateLimit-Reset": { "description": "Het aantal seconden totdat de limiet wordt geupdate.", "required": false, "style": "simple", "explode": false, "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/hal+json": { "schema": { "allOf": [ { "allOf": [ { "title": "OpenbareRuimteIO (incl. in onderzoek)", "required": [ "openbareRuimte" ], "type": "object", "properties": { "openbareRuimte": { "title": "OpenbareRuimte", "required": [ "documentdatum", "documentnummer", "domein", "geconstateerd", "identificatie", "korteNaam", "ligtIn", "naam", "status", "type", "voorkomen" ], "type": "object", "properties": { "identificatie": { "title": "OpenbareRuimteIdentificatie", "pattern": "^[0-9]{4}30[0-9]{10}$", "type": "string", "description": "De unieke aanduiding van een openbare ruimte.", "example": "0226300000136124" }, "domein": { "title": "domein", "minLength": 1, "type": "string", "description": "NL.IMBAG.Openbareruimte", "example": "NL.IMBAG.Openbareruimte" }, "naam": { "title": "openbare ruimte naam", "maxLength": 80, "minLength": 1, "type": "string", "description": "Een naam die aan een openbare ruimte is toegekend in een daartoe strekkend \nformeel gemeentelijk besluit.\n", "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "type": { "title": "TypeOpenbareRuimte", "type": "string", "description": "Een codering van de verschillende waarden die de typering van een openbare \nruimte kan aannemen.\n", "enum": [ "Weg", "Water", "Spoorbaan", "Terrein", "Kunstwerk", "Landschappelijk gebied", "Administratief gebied" ] }, "status": { "title": "StatusNaamgeving", "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of \neen nummeraanduiding kan aannemen.\n", "enum": [ "Naamgeving uitgegeven", "Naamgeving ingetrokken" ] }, "korteNaam": { "title": "korteNaam",