From 97f43b1cba198262acb8ab381ed129dd1d490d88 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 10 Jan 2024 11:58:11 +0000 Subject: [PATCH 1/4] Bump follow-redirects from 1.15.2 to 1.15.4 Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.15.2 to 1.15.4. - [Release notes](https://github.com/follow-redirects/follow-redirects/releases) - [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.15.2...v1.15.4) --- updated-dependencies: - dependency-name: follow-redirects dependency-type: indirect ... Signed-off-by: dependabot[bot] --- package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 95671f2..e705f68 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2283,9 +2283,9 @@ } }, "node_modules/follow-redirects": { - "version": "1.15.2", - "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz", - "integrity": "sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA==", + "version": "1.15.4", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.4.tgz", + "integrity": "sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw==", "dev": true, "funding": [ { From 897aaa661fda2b4cd6148406481cc157d59c46f3 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Mon, 22 Jan 2024 15:51:12 +0100 Subject: [PATCH 2/4] Opgeschoond Bestanden die niets met BAG Individuele Bevragingen van doen hebben zijn verwijderd. Na doorvoeren van deze PR kan PR #562 doorgevoerd worden waarna de repository hernoemd kan worden naar 'BAG gemeentelijke wensen tav BAG Bevragingen'. --- cucumber.js | 3 - features/step_definitions/foutafhandeling.js | 148 - features/step_definitions/world.js | 10 - .../step_definitions/zoeken-met-geometrie.js | 155 - generate-cucumber-report.js | 14 - specificatie/genereervariant/openapi.json | 4834 ---------- specificatie/genereervariant/openapi.yaml | 3748 -------- specificatie/openapi.yaml | 1675 ---- test/BAG-Bevragen-postman-collection.json | 7847 ----------------- 9 files changed, 18434 deletions(-) delete mode 100644 cucumber.js delete mode 100644 features/step_definitions/foutafhandeling.js delete mode 100644 features/step_definitions/world.js delete mode 100644 features/step_definitions/zoeken-met-geometrie.js delete mode 100644 generate-cucumber-report.js delete mode 100644 specificatie/genereervariant/openapi.json delete mode 100644 specificatie/genereervariant/openapi.yaml delete mode 100644 specificatie/openapi.yaml delete mode 100644 test/BAG-Bevragen-postman-collection.json diff --git a/cucumber.js b/cucumber.js deleted file mode 100644 index f815285..0000000 --- a/cucumber.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = { - default: `--format-options '{"snippetInterface": "synchronous"}'` -} diff --git a/features/step_definitions/foutafhandeling.js b/features/step_definitions/foutafhandeling.js deleted file mode 100644 index da0fbb5..0000000 --- a/features/step_definitions/foutafhandeling.js +++ /dev/null @@ -1,148 +0,0 @@ -const { World } = require('./world') -const { Given, When, Then, setWorldConstructor } = require('@cucumber/cucumber'); -const should = require('chai').should(); -const axios = require('axios'); - -setWorldConstructor(World); - -Given('pand met identificatie {string} heeft {int} adresseerbare objecten', function (string, int) { -}); - -Given('er is een technische fout waardoor er een interne server error optreedt', function () { -}); - -When('{string} wordt aangeroepen met de volgende queryparameters', async function (path, dataTable) { - let params = dataTable.hashes().map(function(param) { - return `${param.naam}=${param.waarde}`; - }).join("&"); - let url = `${this.context.url}${path}?${params}`; - // console.log(url); - - const config = { - headers: { - "X-Api-Key": this.context.apiKey - } - }; - - try { - this.context.response = await axios.get(url, config); - } - catch(e) { - this.context.response = e; - this.context.hasError = true; - } -}); - -When('{string} request wordt gedaan zonder header {string}', async function (path, header) { - const url = `${this.context.url}${path}`; - const config = { - headers: { - // "X-Api-Key": this.context.apiKey - } - }; - - try { - this.context.response = await axios.get(url, config); - } - catch(e) { - this.context.response = e; - this.context.hasError = true; - } -}); - -When('{string} request wordt gedaan met header {string}', async function (path, header) { - const url = `${this.context.url}${path}`; - const config = { - headers: { - "X-Api-Key": this.context.apiKey - } - }; - let hdr = header.split(": "); - config.headers[hdr[0]] = hdr[1]; - - try { - this.context.response = await axios.get(url, config); - } - catch(e) { - this.context.response = e; - this.context.hasError = true; - } -}); - -When('{string} wordt aangeroepen', async function (path) { - const url = `${this.context.url}${path}`; - const config = { - headers: { - "X-Api-Key": this.context.apiKey - } - }; - - try { - this.context.response = await axios.get(url, config); - } - catch(e) { - this.context.response = e; - this.context.hasError = true; - } -}); - -Then('bevat de response de volgende invalidParams', function (dataTable) { - // console.log(this.context.response.response.data); - - const data = this.context.hasError - ? this.context.response.response.data - : this.context.response.data; - - dataTable.hashes().forEach(function(expected, index) { - let actual = data.invalidParams.find(function(invalidParam) { - return invalidParam.name === expected.name && - invalidParam.code === expected.code && - invalidParam.reason === expected.reason; - }); - should.exist(actual, `geen invalidParam gevonden met name '${expected.name}', code '${expected.code}', reason '${expected.reason}'\n${JSON.stringify(data.invalidParams , null, "\t")}`); - }); -}); - -Then('bevat de response ten minste de volgende velden', function (dataTable) { - // console.log(this.context.response.response); - - const data = this.context.hasError - ? this.context.response.response.data - : this.context.response.data; - - dataTable.hashes().forEach(function(value, index) { - let expected = value.waarde - let actual = String(data[value.naam]); - actual.should.equal(expected, JSON.stringify(data, null, "\t")); - }); -}); - -Then('bevat de response geen veld {string}', function (propertyNaam) { - // console.log(this.context.response.response.data); - - const data = this.context.hasError - ? this.context.response.response.data - : this.context.response.data; - - should.not.exist(data[propertyNaam], JSON.stringify(data, null, "\t")); -}); - -Then('is de http status code van het antwoord {int}', function (httpStatusCode) { - // console.log(this.context.response); - - const response = this.context.hasError - ? this.context.response.response - : this.context.response; - - response.status.should.equal(httpStatusCode, JSON.stringify(response.data, null, "\t")); -}); - -Then('bevat de response de header {string} met waarde {string}', function (headerNaam, headerWaarde) { - // console.log(this.context.response.response); - - const response = this.context.hasError - ? this.context.response.response - : this.context.response; - - response.headers[headerNaam.toLowerCase()].should.equal(headerWaarde, JSON.stringify(response.data, null, "\t")); -}); diff --git a/features/step_definitions/world.js b/features/step_definitions/world.js deleted file mode 100644 index 259d287..0000000 --- a/features/step_definitions/world.js +++ /dev/null @@ -1,10 +0,0 @@ -class World { - constructor({parameters}) { - this.context = { - url: 'https://api.bag.acceptatie.kadaster.nl/esd/huidigebevragingen/v1', - apiKey: '' - }; - } -} - -module.exports = {World} diff --git a/features/step_definitions/zoeken-met-geometrie.js b/features/step_definitions/zoeken-met-geometrie.js deleted file mode 100644 index 1b40443..0000000 --- a/features/step_definitions/zoeken-met-geometrie.js +++ /dev/null @@ -1,155 +0,0 @@ -const { World } = require('./world') -const { Given, When, Then, setWorldConstructor } = require('@cucumber/cucumber'); -const should = require('chai').should(); -const axios = require('axios'); - -setWorldConstructor(World); - -Given('het pand met identificatie {string} heeft de volgende geometrie polygoon coördinaten', function (string, dataTable) { -}); - -Given('het adresseerbaar object met identificatie {string} heeft de volgende geometrie punt coördinaten', function (string, dataTable) { -}); - -When('met {string} {string} wordt gezocht zonder requestheader {string}', async function (verb, path, header) { - const url = `${this.context.url}${path}`; - const config = { - headers: { - "X-Api-Key": this.context.apiKey - } - }; - - try { - this.context.response = await axios.get(url, config); - } - catch(e) { - console.log(e); - } -}); - -When('met {string} {string} wordt gezocht met requestheader {string} met waarde {string}', async function (verb, path, headername, headervalue) { - const url = `${this.context.url}${path}`; - let config = { - headers: { - "X-Api-Key": this.context.apiKey, - } - }; - config.headers[headername] = headervalue; - - try { - this.context.response = await axios.get(url, config); - } - catch(e) { - console.log(e); - } -}); - -When('met {string} {string} wordt gezocht', async function (verb, path) { - const url = `${this.context.url}${path}`; - const config = { - headers: { - "X-Api-Key": this.context.apiKey - } - }; - - try { - this.context.response = await axios.get(url, config); - } - catch(e) { - console.log(e); - } -}); - -Then('bevat het resultaat het pand met identificatie {string}', function (pandIdentificatie) { - // console.log(this.context.response.data); - - const data = this.context.response.data; - should.exist(data, this.context.response); - should.exist(data._embedded, data); - - const actual = data._embedded.panden.find(function(pand){ - return pand.identificatie == pandIdentificatie; - }); - should.exist(actual, `geen pand gevonden met identificatie ${pandIdentificatie}\npanden: ${JSON.stringify(data._embedded.panden, null, "\t")}`); -}); - -Then('bevat het resultaat GEEN pand met identificatie {string}', function (pandIdentificatie) { - // console.log(this.context.response.data); - - const data = this.context.response.data; - should.exist(data, this.context.response); - should.exist(data._embedded, data); - if(data._embedded.panden !== undefined) { - const actual = data._embedded.panden.find(function(pand){ - return pand.identificatie == pandIdentificatie; - }); - should.not.exist(actual, `pand gevonden met identificatie ${pandIdentificatie}\npanden: ${JSON.stringify(data._embedded.panden, null, "\t")}`); - } -}); - -Then('bevat het resultaat niet het pand met identificatie {string}', function (pandIdentificatie) { - // console.log(this.context.response.data); - - const data = this.context.response.data; - should.exist(data, this.context.response); - should.exist(data._embedded, data); - if(data._embedded.panden !== undefined) { - const actual = data._embedded.panden.find(function(pand){ - return pand.identificatie == pandIdentificatie; - }); - should.not.exist(actual, `pand gevonden met identificatie ${pandIdentificatie}\npanden: ${JSON.stringify(data._embedded.panden, null, "\t")}`); - } -}); - -Then('bevat het resultaat wel het pand met identificatie {string}', function (pandIdentificatie) { - // console.log(this.context.response.data); - - const data = this.context.response.data; - should.exist(data, this.context.response); - should.exist(data._embedded, data); - - const actual = data._embedded.panden.find(function(pand){ - return pand.identificatie == pandIdentificatie; - }); - should.exist(actual, `geen pand gevonden met identificatie ${pandIdentificatie}\npanden: ${JSON.stringify(data._embedded.panden, null, "\t")}`); -}); - -Then('bevat het resultaat het adresseerbaar object met identificatie {string}', function (adresseerbaarObjectIdentificatie) { - // console.log(this.context.response.data); - - const data = this.context.response.data; - should.exist(data, this.context.response); - should.exist(data._embedded, data); - - const actual = data._embedded.adresseerbareObjecten.find(function(adresseerbaarObject){ - return adresseerbaarObject.identificatie == adresseerbaarObjectIdentificatie; - }); - should.exist(actual, `geen adresseerbaar object gevonden met identificatie ${adresseerbaarObjectIdentificatie}\nadresseerbareObjecten: ${JSON.stringify(data._embedded.adresseerbareObjecten, null, "\t")}`); -}); - -Then('bevat het resultaat wel het adresseerbaar object met identificatie {string}', function (adresseerbaarObjectIdentificatie) { - // console.log(this.context.response.data); - - const data = this.context.response.data; - should.exist(data, this.context.response); - should.exist(data._embedded, data); - - const actual = data._embedded.adresseerbareObjecten.find(function(adresseerbaarObject){ - return adresseerbaarObject.identificatie == adresseerbaarObjectIdentificatie; - }); - should.exist(actual, `geen adresseerbaar object gevonden met identificatie ${adresseerbaarObjectIdentificatie}\nadresseerbareObjecten: ${JSON.stringify(data._embedded.adresseerbareObjecten, null, "\t")}`); -}); - -Then('bevat het resultaat niet het adresseerbaar object met identificatie {string}', function (adresseerbaarObjectIdentificatie) { - // console.log(this.context.response.data); - - const data = this.context.response.data; - should.exist(data, this.context.response); - should.exist(data._embedded, data); - if(data._embedded.adresseerbareObjecten !== undefined) { - const actual = data._embedded.adresseerbareObjecten.find(function(adresseerbaarObject){ - return adresseerbaarObject.identificatie == adresseerbaarObjectIdentificatie; - }); - should.not.exist(actual, `adresseerbaar object gevonden met identificatie ${adresseerbaarObjectIdentificatie}\nadresseerbareObjecten: ${JSON.stringify(data._embedded.adresseerbareObjecten, null, "\t")}`); - } -}); diff --git a/generate-cucumber-report.js b/generate-cucumber-report.js deleted file mode 100644 index bebb382..0000000 --- a/generate-cucumber-report.js +++ /dev/null @@ -1,14 +0,0 @@ -const reporter = require('cucumber-html-reporter'); - -const options = { - theme: 'bootstrap', - jsonFile: 'docs/features/test-result.json', - output: 'docs/features/test-report.html', - reportSuiteAsScenarios: true, - scenarioTimestamp: true, - launchReport: false, - name:'Haal Centraal BAG Bevragen API specificaties', - brandTitle:'Haal Centraal' -}; - -reporter.generate(options); \ No newline at end of file diff --git a/specificatie/genereervariant/openapi.json b/specificatie/genereervariant/openapi.json deleted file mode 100644 index a636120..0000000 --- a/specificatie/genereervariant/openapi.json +++ /dev/null @@ -1,4834 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "Huidige bevragingen API", - "description": "Deze API levert actuele gegevens over adressen, adresseerbare objecten en panden. Actueel betekent in deze API `zonder eindstatus`. De bron voor deze API is de basisregistratie adressen en gebouwen (BAG).", - "termsOfService": "https://zakelijk.kadaster.nl/algemene-voorwaarden", - "contact": { - "name": "Kadaster - Beheerder Landelijke Voorziening BAG", - "url": "https://zakelijk.kadaster.nl/bag", - "email": "bag@kadaster.nl" - }, - "license": { - "name": "European Union Public License, version 1.2 (EUPL-1.2)", - "url": "https://eupl.eu/1.2/nl/" - }, - "version": "1.5.0" - }, - "servers": [ - { - "url": "https://api.bag.acceptatie.kadaster.nl/esd/huidigebevragingen/v1", - "description": "LVBAG - ACCEPTATIE" - }, - { - "url": "https://api.bag.kadaster.nl/esd/huidigebevragingen/v1", - "description": "LVBAG - PRODUCTIE" - } - ], - "security": [ - { - "apiKeyBAG": [] - } - ], - "paths": { - "/adressen/zoek": { - "get": { - "tags": [ - "Adres" - ], - "summary": "\"fuzzy\" zoeken van adressen", - "description": "Free query zoeken van adressen met postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging. Delen van de adressen in het antwoord matchen exact met jouw invoer. Je vindt een adres door de zoekresultaatidentificatie uit het antwoord te gebruiken in get/adressen", - "operationId": "zoek", - "parameters": [ - { - "name": "zoek", - "in": "query", - "description": "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging.", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "in": "query", - "description": "Pagina nummer", - "required": false, - "schema": { - "minimum": 1, - "type": "integer", - "default": 1 - } - }, - { - "name": "pageSize", - "in": "query", - "required": false, - "schema": { - "maximum": 100, - "minimum": 1, - "type": "integer", - "default": 20 - } - } - ], - "responses": { - "200": { - "description": "Geslaagd", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - }, - "warning": { - "$ref": "#/components/headers/warning" - }, - "X-Pagination-Page": { - "$ref": "#/components/headers/X_Pagination_Page" - }, - "X-Pagination-Limit": { - "$ref": "#/components/headers/X_Pagination_Limit" - } - }, - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/ZoekResultaatHalCollectie" - } - } - } - }, - "400": { - "description": "Bad Request", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/BadRequestFoutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title": "Ten minste één parameter moet worden opgegeven.", - "status": 400, - "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", - "invalidParams": [ - { - "type": "https://www.vng.nl/realisatie/api/validaties/integer", - "name": "verblijfplaats__huisnummer", - "code": "integer", - "reason": "Waarde is geen geldige integer." - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title": "Niet correct geauthenticeerd.", - "status": 401, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title": "U bent niet geautoriseerd voor deze operatie.", - "status": 403, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title": "Gevraagde contenttype wordt niet ondersteund.", - "status": 406, - "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request", - "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code": "notAcceptable" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title": "Interne server fout.", - "status": 500, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status": 503, - "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" - } - } - } - }, - "default": { - "description": "Er is een onverwachte fout opgetreden", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - } - } - } - } - }, - "deprecated": true, - "security": [ - { - "apiKeyBAG": [] - } - ] - } - }, - "/adressen": { - "get": { - "tags": [ - "Adres" - ], - "summary": "vindt adressen", - "description": "Vind een actueel adres met:\n1. Een pandidentificatie of\n2. Een adresseerbaarobjectidentificatie of\n3. Een postcode, huisnummer en optioneel huisletter, huisnummertoevoeging en/of exacteMatch.\n4. Een zoekterm.\n\nGebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). \nGebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources nummeraanduiding, woonplaats en openbare ruimte, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature).\nGebruik de exacteMatch parameter als je alleen resultaten wilt ontvangen die exact overeenkomen met de opgegeven zoek criteria, zie [functionele specificaties exacteMatch-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/blob/v1.2.0/features/exacte_match.feature). Je kunt adresseerbare objecten niet expanden als je tegelijkertijd de query parameter adresseerbaarObjectIdentificatie gebruikt.", - "operationId": "raadpleegAdressen", - "parameters": [ - { - "name": "pandIdentificatie", - "in": "query", - "description": "Identificatie van een pand uit de BAG. Deze is 16 cijfers lang.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226100000008856" - } - }, - { - "name": "adresseerbaarObjectIdentificatie", - "in": "query", - "description": "De identificatie van een adresseerbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226010000038820" - } - }, - { - "name": "zoekresultaatIdentificatie", - "in": "query", - "description": "De identificatie van een zoekresultaat van het endpoint get /adressen/zoek.", - "required": false, - "deprecated": true, - "style": "form", - "explode": true, - "schema": { - "type": "string" - } - }, - { - "name": "expand", - "in": "query", - "description": "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "fields", - "in": "query", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "in": "query", - "description": "Pagina nummer", - "required": false, - "schema": { - "minimum": 1, - "type": "integer", - "default": 1 - } - }, - { - "name": "pageSize", - "in": "query", - "required": false, - "schema": { - "maximum": 100, - "minimum": 1, - "type": "integer", - "default": 20 - } - }, - { - "name": "postcode", - "in": "query", - "description": "Postcode van het adres.", - "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 van het adres.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "maximum": 99999, - "minimum": 1, - "type": "integer", - "example": 1 - } - }, - { - "name": "huisletter", - "in": "query", - "description": "Een toevoeging (in de vorm van een letter) aan een huisnummer van het adres. Bijvoorbeeld: Bij adres: Belgiëlaan 1 A2, 2391 PH HAZERSWOUDE-DORP, is 1 het huisnummer en A de huisletter.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[a-zA-Z]{1}$", - "type": "string", - "example": "A" - } - }, - { - "name": "huisnummertoevoeging", - "in": "query", - "description": "Een toevoeging (in de vorm van maximaal 4 cijfers of letters) aan een huisnummer of een combinatie van huisnummer en huisletter van het adres. Bijvoorbeeld: Bij het adres: Belgiëlaan 1 A2, 2391 PH HAZERSWOUDE-DORP, is 1 het huisnummer, A de huisletter en 2 de huisnummertoevoeging.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[0-9a-zA-Z]{1,4}$", - "type": "string", - "example": "bis" - } - }, - { - "name": "exacteMatch", - "in": "query", - "description": "Geeft aan of de resultaten van de zoekopdracht exact overeen moeten komen met de opgegeven parameters, zie [functionele specificatie exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature).", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "boolean", - "example": true, - "default": false - } - }, - { - "name": "q", - "in": "query", - "description": "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Geslaagd", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - }, - "warning": { - "$ref": "#/components/headers/warning" - }, - "X-Pagination-Page": { - "$ref": "#/components/headers/X_Pagination_Page" - }, - "X-Pagination-Limit": { - "$ref": "#/components/headers/X_Pagination_Limit" - } - }, - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/AdresHalCollectie" - } - } - } - }, - "400": { - "description": "Bad Request", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/BadRequestFoutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title": "Ten minste één parameter moet worden opgegeven.", - "status": 400, - "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", - "invalidParams": [ - { - "type": "https://www.vng.nl/realisatie/api/validaties/integer", - "name": "verblijfplaats__huisnummer", - "code": "integer", - "reason": "Waarde is geen geldige integer." - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title": "Niet correct geauthenticeerd.", - "status": 401, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title": "U bent niet geautoriseerd voor deze operatie.", - "status": 403, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title": "Gevraagde contenttype wordt niet ondersteund.", - "status": 406, - "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request", - "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code": "notAcceptable" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title": "Interne server fout.", - "status": 500, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status": 503, - "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" - } - } - } - }, - "default": { - "description": "Er is een onverwachte fout opgetreden", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - } - } - } - } - }, - "security": [ - { - "apiKeyBAG": [] - } - ] - } - }, - "/adressen/{nummeraanduidingidentificatie}": { - "get": { - "tags": [ - "Adres" - ], - "summary": "levert een adres", - "description": "Raadpleeg een actueel adres met de nummeraanduidingidentificatie. \nGebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). \nGebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources nummeraanduiding, woonplaats, openbare ruimte, adresseerbaarobject, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature).", - "operationId": "raadpleegAdresMetNumId", - "parameters": [ - { - "name": "nummeraanduidingidentificatie", - "in": "path", - "description": "Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang.", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226200000038923" - } - }, - { - "name": "expand", - "in": "query", - "description": "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "fields", - "in": "query", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Geslaagd", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - }, - "warning": { - "$ref": "#/components/headers/warning" - } - }, - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/AdresHal" - } - } - } - }, - "400": { - "description": "Bad Request", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/BadRequestFoutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title": "Ten minste één parameter moet worden opgegeven.", - "status": 400, - "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", - "invalidParams": [ - { - "type": "https://www.vng.nl/realisatie/api/validaties/integer", - "name": "verblijfplaats__huisnummer", - "code": "integer", - "reason": "Waarde is geen geldige integer." - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title": "Niet correct geauthenticeerd.", - "status": 401, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title": "U bent niet geautoriseerd voor deze operatie.", - "status": 403, - "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": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5", - "title": "Opgevraagde resource bestaat niet.", - "status": 404, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title": "Gevraagde contenttype wordt niet ondersteund.", - "status": 406, - "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request", - "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code": "notAcceptable" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title": "Interne server fout.", - "status": 500, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status": 503, - "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" - } - } - } - }, - "default": { - "description": "Er is een onverwachte fout opgetreden", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - } - } - } - } - }, - "security": [ - { - "apiKeyBAG": [] - } - ] - } - }, - "/adresseerbareobjecten/{adresseerbaarobjectidentificatie}": { - "get": { - "tags": [ - "Adresseerbaar object" - ], - "summary": "levert een verblijfsobject, standplaats of ligplaats", - "description": "Raadpleeg een actueel adresseerbaar object met de identificatie. Dit is de identificatie van een verblijfsobject, ligplaats of standplaats. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). Gebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources adres en pand, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature).", - "operationId": "raadpleegAdresseerbaarobject", - "parameters": [ - { - "name": "adresseerbaarobjectidentificatie", - "in": "path", - "description": "De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn.", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226010000038820" - } - }, - { - "name": "expand", - "in": "query", - "description": "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "fields", - "in": "query", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Crs", - "in": "header", - "description": "Gewenste CRS van de coördinaten in de response.", - "required": false, - "schema": { - "$ref": "#/components/schemas/CrsEnum" - } - } - ], - "responses": { - "200": { - "description": "Geslaagd", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - }, - "warning": { - "$ref": "#/components/headers/warning" - }, - "Content-Crs": { - "$ref": "#/components/headers/contentCrs" - } - }, - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/AdresseerbaarObjectHal" - } - } - } - }, - "400": { - "description": "Bad Request", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/BadRequestFoutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title": "Ten minste één parameter moet worden opgegeven.", - "status": 400, - "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", - "invalidParams": [ - { - "type": "https://www.vng.nl/realisatie/api/validaties/integer", - "name": "verblijfplaats__huisnummer", - "code": "integer", - "reason": "Waarde is geen geldige integer." - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title": "Niet correct geauthenticeerd.", - "status": 401, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title": "U bent niet geautoriseerd voor deze operatie.", - "status": 403, - "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": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5", - "title": "Opgevraagde resource bestaat niet.", - "status": 404, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title": "Gevraagde contenttype wordt niet ondersteund.", - "status": 406, - "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr 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": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13", - "title": "Precondition Failed", - "status": 412, - "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" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title": "Interne server fout.", - "status": 500, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status": 503, - "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" - } - } - } - }, - "default": { - "description": "Er is een onverwachte fout opgetreden", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - } - } - } - } - }, - "security": [ - { - "apiKeyBAG": [] - } - ] - } - }, - "/adresseerbareobjecten": { - "get": { - "tags": [ - "Adresseerbaar object" - ], - "summary": "vindt verblijfsobjecten, ligplaatsen, standplaatsen", - "description": "Zoek actuele adresseerbare objecten (verblijfsobjecten, standplaatsen of ligplaatsen) met:\n1. een nummeraanduidingidentificatie of\n2. een pandidentificatie of\n3. een lijst met pandidentificaties of\n4. een geometrische contour (rechthoek) in combinatie met status geconstateerd, oppervlakte, gebruiksdoel en/of type.\n\nHet zoeken van adresseerbare objecten met een oppervlakte en een type=ligplaats of type=standplaats wordt niet ondersteund en levert een foutmelding.\nGebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).\nGebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources adres en pand, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). Je kunt panden niet expanden als je tegelijkertijd de query parameter pandIdentificatie(s) gebruikt.", - "operationId": "raadpleegAdresseerbareobjecten", - "parameters": [ - { - "name": "nummeraanduidingIdentificatie", - "in": "query", - "description": "Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226200000038923" - } - }, - { - "name": "pandIdentificatie", - "in": "query", - "description": "Identificatie van een pand uit de BAG. Deze is 16 cijfers lang.", - "required": false, - "deprecated": true, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226100000008856" - } - }, - { - "name": "expand", - "in": "query", - "description": "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "fields", - "in": "query", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Crs", - "in": "header", - "description": "Gewenste CRS van de coördinaten in de response.", - "required": false, - "schema": { - "$ref": "#/components/schemas/CrsEnum" - } - }, - { - "name": "page", - "in": "query", - "description": "Pagina nummer", - "required": false, - "schema": { - "minimum": 1, - "type": "integer", - "default": 1 - } - }, - { - "name": "pageSize", - "in": "query", - "required": false, - "schema": { - "maximum": 100, - "minimum": 1, - "type": "integer", - "default": 20 - } - }, - { - "name": "pandIdentificaties", - "in": "query", - "description": "Een lijst met identificaties van panden uit de BAG.", - "required": false, - "style": "form", - "explode": false, - "schema": { - "minItems": 1, - "type": "array", - "example": [ - "0226100000008856" - ], - "items": { - "pattern": "^[0-9]{16}$", - "type": "string" - } - } - }, - { - "name": "geconstateerd", - "in": "query", - "description": "Geeft aan of naar geconstateerde objecten moet worden gezocht.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "boolean" - } - }, - { - "name": "type", - "in": "query", - "description": "Geeft aan of het adresseerbaar object een ligplaats, standplaats of verblijfsobject is.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "$ref": "#/components/schemas/TypeAdresseerbaarObjectEnum" - } - }, - { - "name": "gebruiksdoelen", - "in": "query", - "description": "De gebruiksdoelen van het verblijfsobject zoals in de vergunning is opgenomen of bij constatering is vastgesteld. Als een verblijfsobject één van de gebruiksdoelen in deze lijst heeft, dan wordt het verblijfsobject in het zoekresultaat meegenomen.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/GebruiksdoelEnum" - } - } - }, - { - "name": "bbox", - "in": "query", - "description": "Rechthoek waarbinnen het object dat je zoekt valt. Objecten die de rand van de rechthoek raken of kruisen worden in het zoekresultaat meegenomen. Voor 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). In tegenstelling tot wat er in de OGC API Features specificatie staat, wordt hier geen bbox-crs parameter maar de contentCrs parameter gebruikt om aan te geven in welk CRS de coördinaten van de bbox zijn. Daarnaast kan er alleen met 2D coördinaten worden gezocht. De oppervlakte van de bounding box mag maximaal 250 duizend vierkante meter zijn.", - "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": "oppervlakte", - "in": "query", - "description": "Geef de minimale en maximale oppervlakte op waarbinnen je wilt zoeken (in m2). Alleen verblijfsobjecten hebben een oppervlakte en kunnen met deze parameter worden gevonden. Ligplaatsen en standplaatsen hebben geen oppervlakte en kunnen met deze parameter niet worden gevonden. De oppervlakte van een verblijfsobject is een natuurlijk getal tussen 1 (minimaal) en 999999 (maximaal). Het is niet toegestaan voor min een grotere waarde op te geven dan voor max. Is min > max dan treedt een foutmelding op. Bv: oppervlakte[min]=100&oppervlakte[max]=200", - "required": false, - "style": "deepObject", - "explode": true, - "schema": { - "$ref": "#/components/schemas/OppervlakteFilter" - } - }, - { - "name": "Content-Crs", - "in": "header", - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "required": false, - "schema": { - "$ref": "#/components/schemas/CrsEnum" - } - } - ], - "responses": { - "200": { - "description": "Geslaagd", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - }, - "warning": { - "$ref": "#/components/headers/warning" - }, - "X-Pagination-Page": { - "$ref": "#/components/headers/X_Pagination_Page" - }, - "X-Pagination-Limit": { - "$ref": "#/components/headers/X_Pagination_Limit" - }, - "Content-Crs": { - "$ref": "#/components/headers/contentCrs" - } - }, - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/AdresseerbaarobjectHalCollectie" - } - } - } - }, - "400": { - "description": "Bad Request", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/BadRequestFoutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title": "Ten minste één parameter moet worden opgegeven.", - "status": 400, - "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", - "invalidParams": [ - { - "type": "https://www.vng.nl/realisatie/api/validaties/integer", - "name": "verblijfplaats__huisnummer", - "code": "integer", - "reason": "Waarde is geen geldige integer." - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title": "Niet correct geauthenticeerd.", - "status": 401, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title": "U bent niet geautoriseerd voor deze operatie.", - "status": 403, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title": "Gevraagde contenttype wordt niet ondersteund.", - "status": 406, - "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr 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": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13", - "title": "Precondition Failed", - "status": 412, - "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" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title": "Interne server fout.", - "status": 500, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status": 503, - "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" - } - } - } - }, - "default": { - "description": "Er is een onverwachte fout opgetreden", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - } - } - } - } - }, - "security": [ - { - "apiKeyBAG": [] - } - ] - } - }, - "/woonplaatsen/{woonplaatsidentificatie}": { - "get": { - "tags": [ - "Adres" - ], - "summary": "levert BAG details van een woonplaats", - "description": "Raadpleeg een actuele woonplaats met de identificatie. Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). Gebruik de expand-parameter als je het antwoord wil uitbreiden met de gerelateerde resource geometrie, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature).", - "operationId": "raadpleegWoonplaats", - "parameters": [ - { - "name": "woonplaatsidentificatie", - "in": "path", - "description": "De identificatie van een woonplaats.", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "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": "Deze wordt gebruikt in de operation, bv. /woonplaatsen/0123. Waarde: 0001-9999.", - "example": "2096" - } - }, - { - "name": "expand", - "in": "query", - "description": "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "fields", - "in": "query", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Crs", - "in": "header", - "description": "Gewenste CRS van de coördinaten in de response.", - "required": false, - "schema": { - "$ref": "#/components/schemas/CrsEnum" - } - } - ], - "responses": { - "200": { - "description": "Geslaagd", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - }, - "warning": { - "$ref": "#/components/headers/warning" - }, - "Content-Crs": { - "$ref": "#/components/headers/contentCrs" - } - }, - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/WoonplaatsHal" - } - } - } - }, - "400": { - "description": "Bad Request", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/BadRequestFoutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title": "Ten minste één parameter moet worden opgegeven.", - "status": 400, - "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", - "invalidParams": [ - { - "type": "https://www.vng.nl/realisatie/api/validaties/integer", - "name": "verblijfplaats__huisnummer", - "code": "integer", - "reason": "Waarde is geen geldige integer." - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title": "Niet correct geauthenticeerd.", - "status": 401, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title": "U bent niet geautoriseerd voor deze operatie.", - "status": 403, - "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": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5", - "title": "Opgevraagde resource bestaat niet.", - "status": 404, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title": "Gevraagde contenttype wordt niet ondersteund.", - "status": 406, - "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr 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": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13", - "title": "Precondition Failed", - "status": 412, - "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" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title": "Interne server fout.", - "status": 500, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status": 503, - "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" - } - } - } - }, - "default": { - "description": "Er is een onverwachte fout opgetreden", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - } - } - } - } - }, - "security": [ - { - "apiKeyBAG": [] - } - ] - } - }, - "/openbareruimten/{openbareruimteidentificatie}": { - "get": { - "tags": [ - "Adres" - ], - "summary": "levert BAG detals van een openbare ruimte", - "description": "Raadpleeg een actuele openbare ruimte met de identificatie. Een openbare ruimte is een buitenruimte met een naam die binnen één woonplaats ligt, bijvoorbeeld een straat of een plein. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).", - "operationId": "raadpleegOpenbareRuimte", - "parameters": [ - { - "name": "openbareruimteidentificatie", - "in": "path", - "description": "Identificatie van een object uit de BAG. Deze is 16 cijfers lang.", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226300000136166" - } - }, - { - "name": "fields", - "in": "query", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Geslaagd", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - }, - "warning": { - "$ref": "#/components/headers/warning" - } - }, - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/OpenbareRuimteHalBasis" - } - } - } - }, - "400": { - "description": "Bad Request", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/BadRequestFoutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title": "Ten minste één parameter moet worden opgegeven.", - "status": 400, - "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", - "invalidParams": [ - { - "type": "https://www.vng.nl/realisatie/api/validaties/integer", - "name": "verblijfplaats__huisnummer", - "code": "integer", - "reason": "Waarde is geen geldige integer." - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title": "Niet correct geauthenticeerd.", - "status": 401, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title": "U bent niet geautoriseerd voor deze operatie.", - "status": 403, - "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": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5", - "title": "Opgevraagde resource bestaat niet.", - "status": 404, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title": "Gevraagde contenttype wordt niet ondersteund.", - "status": 406, - "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request", - "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code": "notAcceptable" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title": "Interne server fout.", - "status": 500, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status": 503, - "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" - } - } - } - }, - "default": { - "description": "Er is een onverwachte fout opgetreden", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - } - } - } - } - }, - "security": [ - { - "apiKeyBAG": [] - } - ] - } - }, - "/nummeraanduidingen/{nummeraanduidingidentificatie}": { - "get": { - "tags": [ - "Adres" - ], - "summary": "levert BAG details van een nummeraanduiding", - "description": "Raadpleeg een actuele nummeraanduiding met de identificatie. Een nummeraanduiding is een postcode, huisnummer met evt een huisletter en huisnummertoevoeging die hoort bij een verblijfsobject, een standplaats of een ligplaats. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).", - "operationId": "raadpleegNummeraanduiding", - "parameters": [ - { - "name": "nummeraanduidingidentificatie", - "in": "path", - "description": "Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang.", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226200000038923" - } - }, - { - "name": "fields", - "in": "query", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Geslaagd", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - }, - "warning": { - "$ref": "#/components/headers/warning" - } - }, - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/NummeraanduidingHalBasis" - } - } - } - }, - "400": { - "description": "Bad Request", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/BadRequestFoutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title": "Ten minste één parameter moet worden opgegeven.", - "status": 400, - "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", - "invalidParams": [ - { - "type": "https://www.vng.nl/realisatie/api/validaties/integer", - "name": "verblijfplaats__huisnummer", - "code": "integer", - "reason": "Waarde is geen geldige integer." - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title": "Niet correct geauthenticeerd.", - "status": 401, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title": "U bent niet geautoriseerd voor deze operatie.", - "status": 403, - "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": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5", - "title": "Opgevraagde resource bestaat niet.", - "status": 404, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title": "Gevraagde contenttype wordt niet ondersteund.", - "status": 406, - "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request", - "instance": "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code": "notAcceptable" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title": "Interne server fout.", - "status": 500, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status": 503, - "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" - } - } - } - }, - "default": { - "description": "Er is een onverwachte fout opgetreden", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - } - } - } - } - }, - "security": [ - { - "apiKeyBAG": [] - } - ] - } - }, - "/panden/{pandidentificatie}": { - "get": { - "tags": [ - "Pand" - ], - "summary": "levert een pand", - "description": "Raadpleeg een actueel pand met de identificatie. Een pand is een bouwkundige, constructief zelfstandige eenheid die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar is. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).", - "operationId": "raadpleegPand", - "parameters": [ - { - "name": "pandidentificatie", - "in": "path", - "description": "Identificatie van een pand uit de BAG. Deze is 16 cijfers lang.", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226100000008856" - } - }, - { - "name": "fields", - "in": "query", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Crs", - "in": "header", - "description": "Gewenste CRS van de coördinaten in de response.", - "required": false, - "schema": { - "$ref": "#/components/schemas/CrsEnum" - } - } - ], - "responses": { - "200": { - "description": "Geslaagd", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - }, - "warning": { - "$ref": "#/components/headers/warning" - }, - "Content-Crs": { - "$ref": "#/components/headers/contentCrs" - } - }, - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/PandHalBasis" - } - } - } - }, - "400": { - "description": "Bad Request", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/BadRequestFoutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title": "Ten minste één parameter moet worden opgegeven.", - "status": 400, - "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", - "invalidParams": [ - { - "type": "https://www.vng.nl/realisatie/api/validaties/integer", - "name": "verblijfplaats__huisnummer", - "code": "integer", - "reason": "Waarde is geen geldige integer." - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title": "Niet correct geauthenticeerd.", - "status": 401, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title": "U bent niet geautoriseerd voor deze operatie.", - "status": 403, - "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": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5", - "title": "Opgevraagde resource bestaat niet.", - "status": 404, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title": "Gevraagde contenttype wordt niet ondersteund.", - "status": 406, - "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr 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": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13", - "title": "Precondition Failed", - "status": 412, - "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" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title": "Interne server fout.", - "status": 500, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status": 503, - "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" - } - } - } - }, - "default": { - "description": "Er is een onverwachte fout opgetreden", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - } - } - } - } - }, - "security": [ - { - "apiKeyBAG": [] - } - ] - } - }, - "/panden": { - "get": { - "tags": [ - "Pand" - ], - "summary": "vindt panden", - "description": "Zoek actuele panden:\n1. met de identificatie van een adresseerbaar object of\n2. met de identificatie van een nummeraanduiding of\n3. met een locatie (punt) of \n4. binnen een geometrische contour (rechthoek) die voldoen aan de opgegeven status, geconstateerd of bouwjaar.\n\nGebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).", - "operationId": "raadpleegPanden", - "parameters": [ - { - "name": "adresseerbaarObjectIdentificatie", - "in": "query", - "description": "De identificatie van een adresseerbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226010000038820" - } - }, - { - "name": "nummeraanduidingIdentificatie", - "in": "query", - "description": "Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226200000038923" - } - }, - { - "name": "locatie", - "in": "query", - "description": "Coördinaten van een locatie die als query-parameter gebruikt wordt om een object te zoeken. Let op, explode is false dus het formaat is ?locatie=196733.51,439931.89", - "required": false, - "style": "form", - "explode": false, - "schema": { - "maxItems": 2, - "minItems": 2, - "type": "array", - "example": [ - 196733.51, - 439931.89 - ], - "items": { - "type": "number" - } - } - }, - { - "name": "fields", - "in": "query", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Crs", - "in": "header", - "description": "Gewenste CRS van de coördinaten in de response.", - "required": false, - "schema": { - "$ref": "#/components/schemas/CrsEnum" - } - }, - { - "name": "Content-Crs", - "in": "header", - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "required": false, - "schema": { - "$ref": "#/components/schemas/CrsEnum" - } - }, - { - "name": "bbox", - "in": "query", - "description": "Rechthoek waarbinnen het object dat je zoekt valt. Objecten die de rand van de rechthoek raken of kruisen worden in het zoekresultaat meegenomen. Voor 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). In tegenstelling tot wat er in de OGC API Features specificatie staat, wordt hier geen bbox-crs parameter maar de contentCrs parameter gebruikt om aan te geven in welk CRS de coördinaten van de bbox zijn. Daarnaast kan er alleen met 2D coördinaten worden gezocht. De oppervlakte van de bounding box mag maximaal 250 duizend vierkante meter zijn.", - "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": "statusPand", - "in": "query", - "description": "Status van het pand.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusPandEnum" - } - } - }, - { - "name": "geconstateerd", - "in": "query", - "description": "Geeft aan of naar geconstateerde objecten moet worden gezocht.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "boolean" - } - }, - { - "name": "bouwjaar", - "in": "query", - "description": "Bouwjaar van het pand. Geeft het minimale en/of maximale bouwjaar aan van het pand waarnaar moet worden gezocht. Een bouwjaar is een natuurlijk getal tussen 0 (minimaal) en 9999 (maximaal). Bv: bouwjaar[min]=1970&bouwjaar[max]=2010", - "required": false, - "style": "deepObject", - "explode": true, - "schema": { - "$ref": "#/components/schemas/BouwjaarFilter" - } - }, - { - "name": "page", - "in": "query", - "description": "Pagina nummer", - "required": false, - "schema": { - "minimum": 1, - "type": "integer", - "default": 1 - } - }, - { - "name": "pageSize", - "in": "query", - "required": false, - "schema": { - "maximum": 100, - "minimum": 1, - "type": "integer", - "default": 20 - } - } - ], - "responses": { - "200": { - "description": "Geslaagd", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - }, - "warning": { - "$ref": "#/components/headers/warning" - }, - "X-Pagination-Page": { - "$ref": "#/components/headers/X_Pagination_Page" - }, - "X-Pagination-Limit": { - "$ref": "#/components/headers/X_Pagination_Limit" - }, - "Content-Crs": { - "$ref": "#/components/headers/contentCrs" - } - }, - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/PandHalCollectie" - } - } - } - }, - "400": { - "description": "Bad Request", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/BadRequestFoutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title": "Ten minste één parameter moet worden opgegeven.", - "status": 400, - "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", - "invalidParams": [ - { - "type": "https://www.vng.nl/realisatie/api/validaties/integer", - "name": "verblijfplaats__huisnummer", - "code": "integer", - "reason": "Waarde is geen geldige integer." - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title": "Niet correct geauthenticeerd.", - "status": 401, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title": "U bent niet geautoriseerd voor deze operatie.", - "status": 403, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title": "Gevraagde contenttype wordt niet ondersteund.", - "status": 406, - "detail": "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr 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": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13", - "title": "Precondition Failed", - "status": 412, - "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" - } - } - } - }, - "500": { - "description": "Internal Server Error", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title": "Interne server fout.", - "status": 500, - "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", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - }, - "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title": "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status": 503, - "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" - } - } - } - }, - "default": { - "description": "Er is een onverwachte fout opgetreden", - "headers": { - "api-version": { - "$ref": "#/components/headers/api_version" - } - }, - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Foutbericht" - } - } - } - } - }, - "security": [ - { - "apiKeyBAG": [] - } - ] - } - } - }, - "components": { - "schemas": { - "ZoekResultaat": { - "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 - }, - "ZoekResultaatHal": { - "deprecated": true, - "allOf": [ - { - "$ref": "#/components/schemas/ZoekResultaat" - }, - { - "properties": { - "_links": { - "$ref": "#/components/schemas/ZoekResultaatLinks" - } - } - } - ] - }, - "ZoekResultaatLinks": { - "type": "object", - "properties": { - "adres": { - "$ref": "#/components/schemas/HalLink" - } - }, - "deprecated": true - }, - "ZoekResultaatHalCollectie": { - "type": "object", - "properties": { - "_links": { - "$ref": "#/components/schemas/HalPaginationLinksMetLast" - }, - "_embedded": { - "$ref": "#/components/schemas/ZoekResultaatHalCollectieEmbedded" - } - }, - "description": "Resultaten als lijst.", - "deprecated": true - }, - "ZoekResultaatHalCollectieEmbedded": { - "type": "object", - "properties": { - "zoekresultaten": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ZoekResultaatHal" - } - } - }, - "deprecated": true - }, - "BouwjaarFilter": { - "type": "object", - "properties": { - "min": { - "maximum": 9999, - "minimum": 0, - "type": "integer", - "description": "Zoek naar waarden groter of gelijk aan de opgegeven waarde." - }, - "max": { - "maximum": 9999, - "minimum": 0, - "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" - }, - "OppervlakteFilter": { - "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" - }, - "Adres": { - "type": "object", - "properties": { - "straat": { - "title": "openbareruimte naam", - "type": "string", - "description": "Een naam die door de gemeente aan een openbare ruimte is gegeven.", - "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" - }, - "huisnummer": { - "type": "integer", - "description": "Een nummer dat door de gemeente aan een adresseerbaar object is gegeven.", - "example": 1 - }, - "huisletter": { - "type": "string", - "description": "Een toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven.", - "example": "A" - }, - "huisnummertoevoeging": { - "type": "string", - "description": "Een toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven.", - "example": "bis" - }, - "postcode": { - "type": "string", - "description": "De door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort.", - "example": "6922KZ" - }, - "woonplaats": { - "title": "woonplaats naam", - "type": "string", - "description": "Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam.", - "example": "Duiven" - } - }, - "description": "Eigenschappen van het adres die kunnen worden hergebruikt in andere API's met adresgegevens." - }, - "AdresUitgebreid": { - "allOf": [ - { - "$ref": "#/components/schemas/Adres" - }, - { - "properties": { - "adresregel1": { - "type": "string", - "description": "De eerste regel van het adres zoals deze gebruikt kan worden in postadressering.", - "example": "Ln vd l D-Westervoort 1" - }, - "adresregel2": { - "type": "string", - "description": "De tweede regel van het adres zoals deze gebruikt kan worden in postadressering.", - "example": "6922 KZ DUIVEN" - }, - "korteNaam": { - "maxLength": 24, - "type": "string", - "description": "De officiële openbareruimtenaam of een verkorte versie. Beiden hebben maximaal 24 tekens.", - "example": "Ln vd l D-Westervoort" - }, - "nummeraanduidingIdentificatie": { - "type": "string", - "description": "Fungeert ook als identificatie van het adres.", - "example": "0226200000038923" - }, - "openbareRuimteIdentificatie": { - "type": "string", - "example": "0226300000136166" - }, - "woonplaatsIdentificatie": { - "type": "string", - "example": "2096" - }, - "adresseerbaarObjectIdentificatie": { - "type": "string", - "example": "0226010000038820" - }, - "pandIdentificaties": { - "type": "array", - "description": "Identificatie(s) van het pand of de panden waar het verblijfsobject deel van is.", - "example": [ - "0226100000008856" - ], - "items": { - "type": "string" - } - }, - "isNevenadres": { - "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." - }, - "geconstateerd": { - "type": "boolean", - "description": "Indicatie dat dit adres in de registratie is opgenomen door een feitelijke constatering, zonder dat er sprake was van een brondocument/vergunning. Het adres is mogelijk illegaal." - }, - "mogelijkOnjuist": { - "$ref": "#/components/schemas/AdresMogelijkOnjuist" - } - }, - "description": "Het adres is de benaming van een locatie bestaande uit straatnaam, huisnummer, (mogelijk met huisletter, huisnummertoevoeging, postcode) en woonplaatsnaam. Dit is de vereenvoudigde samenstelling van de officiële naamgeving gebaseerd op woonplaats, openbare ruimte en nummeraanduiding." - } - ] - }, - "AdresMogelijkOnjuist": { - "type": "object", - "properties": { - "adresregel1": { - "type": "boolean" - }, - "adresregel2": { - "type": "boolean" - }, - "korteNaam": { - "type": "boolean" - }, - "straat": { - "type": "boolean" - }, - "huisnummer": { - "type": "boolean" - }, - "huisletter": { - "type": "boolean" - }, - "huisnummertoevoeging": { - "type": "boolean" - }, - "postcode": { - "type": "boolean" - }, - "woonplaats": { - "type": "boolean" - }, - "nummeraanduidingIdentificatie": { - "type": "boolean" - }, - "openbareRuimteIdentificatie": { - "type": "boolean" - }, - "woonplaatsIdentificatie": { - "type": "boolean" - }, - "toelichting": { - "type": "array", - "items": { - "type": "string", - "example": "Geometrie of woonplaatsgrens is mogelijk onjuist, waardoor gaten of overlappingen ontstaan in de registratie van woonplaatsen. Gevolg kan zijn dat een object in een verkeerde woonplaats, in twee woonplaatsen, of in geen enkele woonplaats ligt." - } - } - }, - "description": "Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting." - }, - "AdresHal": { - "allOf": [ - { - "$ref": "#/components/schemas/AdresHalBasis" - }, - { - "properties": { - "_embedded": { - "$ref": "#/components/schemas/AdresEmbedded" - } - } - } - ] - }, - "AdresHalBasis": { - "allOf": [ - { - "$ref": "#/components/schemas/AdresUitgebreid" - }, - { - "properties": { - "_links": { - "$ref": "#/components/schemas/AdresLinks" - } - } - } - ] - }, - "AdresHalCollectie": { - "type": "object", - "properties": { - "_links": { - "$ref": "#/components/schemas/HalPaginationLinksMetLast" - }, - "_embedded": { - "$ref": "#/components/schemas/AdresHalCollectieEmbedded" - } - } - }, - "AdresHalCollectieEmbedded": { - "type": "object", - "properties": { - "adressen": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AdresHal" - } - } - } - }, - "AdresLinks": { - "type": "object", - "properties": { - "self": { - "$ref": "#/components/schemas/HalLink" - }, - "openbareRuimte": { - "$ref": "#/components/schemas/HalLink" - }, - "nummeraanduiding": { - "$ref": "#/components/schemas/HalLink" - }, - "woonplaats": { - "$ref": "#/components/schemas/HalLink" - }, - "adresseerbaarObject": { - "$ref": "#/components/schemas/HalLink" - }, - "panden": { - "type": "array", - "description": "Het/de aan het adres gerelateerde pand(en).", - "items": { - "$ref": "#/components/schemas/HalLink" - } - } - } - }, - "AdresEmbedded": { - "type": "object", - "properties": { - "openbareRuimte": { - "$ref": "#/components/schemas/OpenbareRuimteHalBasis" - }, - "nummeraanduiding": { - "$ref": "#/components/schemas/NummeraanduidingHalBasis" - }, - "woonplaats": { - "$ref": "#/components/schemas/WoonplaatsHalBasis" - }, - "adresseerbaarObject": { - "$ref": "#/components/schemas/AdresseerbaarObjectHalBasis" - } - } - }, - "AdresseerbaarObject": { - "type": "object", - "properties": { - "identificatie": { - "type": "string", - "description": "Dit is de identificatie van een verblijfsobject, standplaats of ligplaats.", - "example": "0226010000038820" - }, - "domein": { - "type": "string", - "description": "Het domein waartoe de identificatie behoort." - }, - "type": { - "$ref": "#/components/schemas/TypeAdresseerbaarObjectEnum" - }, - "documentdatum": { - "type": "string", - "description": "De vaststellingsdatum van het brondocument dat de basis is voor opname, wijziging of een verwijdering van een object.", - "format": "date", - "example": "2019-11-22T00:00:00.000Z" - }, - "documentnummer": { - "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": "19SZ2048" - }, - "gebruiksdoelen": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GebruiksdoelEnum" - } - }, - "geconstateerd": { - "type": "boolean", - "description": "Indicatie dat een standplaats, ligplaats of verblijfsobject in de registratie is opgenomen door een feitelijke constatering, zonder dat er een brondocument aan ten grondslag ligt. Het adresseerbaar object is mogelijk illegaal." - }, - "geometrie": { - "$ref": "#/components/schemas/PuntOfVlak" - }, - "pandIdentificaties": { - "type": "array", - "description": "Identificatie(s) van het pand of de panden waar het verblijfsobject deel van is.", - "example": [ - "0226100000008856" - ], - "items": { - "type": "string" - } - }, - "nummeraanduidingIdentificaties": { - "type": "array", - "description": "Identificatie(s) van de hoofd- en nevenadressen van de standplaats, ligplaats of verblijfsobject.", - "items": { - "$ref": "#/components/schemas/NummeraanduidingIdentificatiesArray" - } - }, - "oppervlakte": { - "type": "integer" - }, - "status": { - "$ref": "#/components/schemas/AdresseerbaarObjectStatusEnum" - }, - "mogelijkOnjuist": { - "$ref": "#/components/schemas/AdresseerbaarObjectMogelijkOnjuist" - } - }, - "description": "Een adresseerbaarobject is een standplaats, ligplaats of verblijfsobject." - }, - "AdresseerbaarObjectHal": { - "allOf": [ - { - "$ref": "#/components/schemas/AdresseerbaarObjectHalBasis" - }, - { - "properties": { - "_embedded": { - "$ref": "#/components/schemas/AdresseerbaarObjectEmbedded" - } - } - } - ] - }, - "AdresseerbaarObjectHalBasis": { - "allOf": [ - { - "$ref": "#/components/schemas/AdresseerbaarObject" - }, - { - "properties": { - "_links": { - "$ref": "#/components/schemas/AdresseerbaarObjectLinks" - } - } - } - ] - }, - "AdresseerbaarObjectMogelijkOnjuist": { - "type": "object", - "properties": { - "gebruiksdoelen": { - "type": "boolean" - }, - "geometrie": { - "type": "boolean" - }, - "nummeraanduidingIdentificaties": { - "type": "boolean" - }, - "pandIdentificaties": { - "type": "boolean" - }, - "oppervlakte": { - "type": "boolean" - }, - "status": { - "type": "boolean" - }, - "toelichting": { - "type": "array", - "items": { - "type": "string", - "example": "Locatie/contour mogelijk onjuist." - } - } - }, - "description": "Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting." - }, - "AdresseerbaarObjectEmbedded": { - "type": "object", - "properties": { - "adressen": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AdresHalBasis" - } - }, - "panden": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PandHalBasis" - } - } - } - }, - "AdresseerbaarObjectLinks": { - "type": "object", - "properties": { - "adressen": { - "type": "array", - "description": "Link(s) naar het hoofdadres en waar van toepassing de nevenadressen van het adresseerbaar object.", - "items": { - "$ref": "#/components/schemas/HalLink" - } - }, - "panden": { - "type": "array", - "description": "Link(s) naar het pand of de panden waar het adresseerbaar object deel van uitmaakt.", - "items": { - "$ref": "#/components/schemas/HalLink" - } - }, - "self": { - "$ref": "#/components/schemas/HalLink" - } - } - }, - "AdresseerbaarobjectHalCollectie": { - "type": "object", - "properties": { - "_embedded": { - "$ref": "#/components/schemas/AdresseerbaarobjectHalCollectieEmbedded" - }, - "_links": { - "$ref": "#/components/schemas/HalPaginationLinksMetLast" - } - } - }, - "AdresseerbaarobjectHalCollectieEmbedded": { - "type": "object", - "properties": { - "adresseerbareObjecten": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AdresseerbaarObjectHal" - } - } - } - }, - "AdresseerbaarObjectStatusEnum": { - "type": "string", - "enum": [ - "Plaats aangewezen", - "Verblijfsobject gevormd", - "Verblijfsobject in gebruik (niet ingemeten)", - "Verblijfsobject in gebruik", - "Verbouwing verblijfsobject", - "Verblijfsobject buiten gebruik" - ] - }, - "GebruiksdoelEnum": { - "type": "string", - "enum": [ - "woonfunctie", - "bijeenkomstfunctie", - "celfunctie", - "gezondheidszorgfunctie", - "industriefunctie", - "kantoorfunctie", - "logiesfunctie", - "onderwijsfunctie", - "sportfunctie", - "winkelfunctie", - "overige gebruiksfunctie" - ] - }, - "OpenbareRuimte": { - "type": "object", - "properties": { - "identificatie": { - "type": "string" - }, - "domein": { - "type": "string", - "description": "Het domein waartoe de identificatie behoort." - }, - "naam": { - "title": "openbare ruimte naam", - "type": "string", - "description": "De naam die door de gemeente aan een openbare ruimte is gegeven.", - "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" - }, - "type": { - "$ref": "#/components/schemas/TypeOpenbareRuimteEnum" - }, - "status": { - "$ref": "#/components/schemas/StatusNaamgevingEnum" - }, - "korteNaam": { - "maxLength": 24, - "type": "string", - "description": "De officiële openbareruimtenaam of een verkorte versie. Beiden hebben maximaal 24 tekens.", - "example": "Ln vd l D-Westervoort" - }, - "geconstateerd": { - "type": "boolean", - "description": "Indicator dat een openbare ruimte in de registratie is opgenomen door een feitelijke constatering, zonder dat er een brondocument aan ten grondslag ligt. De openbare ruimte is mogelijk illegaal." - }, - "documentdatum": { - "type": "string", - "description": "De vaststellingsdatum van het brondocument dat de basis is voor opname, wijziging of een verwijdering van een object.", - "format": "date", - "example": "2010-02-09T00:00:00.000Z" - }, - "documentnummer": { - "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": "BAG-21" - }, - "woonplaatsIdentificatie": { - "type": "string", - "description": "Een openbare ruimte ligt in een woonplaats.", - "example": "2096" - }, - "mogelijkOnjuist": { - "$ref": "#/components/schemas/OpenbareRuimteMogelijkOnjuist" - } - }, - "description": "Een buitenruimte met een naam die binnen één woonplaats ligt, bijvoorbeeld een straat of een plein." - }, - "OpenbareRuimteMogelijkOnjuist": { - "type": "object", - "properties": { - "naam": { - "type": "boolean" - }, - "korteNaam": { - "type": "boolean" - }, - "type": { - "type": "boolean" - }, - "status": { - "type": "boolean" - }, - "woonplaatsIdentificatie": { - "type": "boolean" - }, - "toelichting": { - "type": "array", - "items": { - "type": "string", - "example": "Openbare ruimtenaam komt mogelijk niet overeen met de vermelding in het straatnaambesluit." - } - } - }, - "description": "Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting." - }, - "OpenbareRuimteHalBasis": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenbareRuimte" - }, - { - "properties": { - "_links": { - "$ref": "#/components/schemas/OpenbareRuimteLinks" - } - } - } - ] - }, - "OpenbareRuimteLinks": { - "type": "object", - "properties": { - "self": { - "$ref": "#/components/schemas/HalLink" - }, - "woonplaats": { - "$ref": "#/components/schemas/HalLink" - } - } - }, - "Nummeraanduiding": { - "type": "object", - "properties": { - "identificatie": { - "type": "string" - }, - "domein": { - "type": "string", - "description": "Het domein waartoe de identificatie behoort." - }, - "huisnummer": { - "type": "integer", - "description": "Nummer dat door de gemeente aan een adresseerbaar object is gegeven.", - "example": 1 - }, - "huisletter": { - "type": "string", - "description": "Toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven.", - "example": "A" - }, - "huisnummertoevoeging": { - "type": "string", - "description": "Toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven.", - "example": "bis" - }, - "postcode": { - "type": "string", - "description": "Door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort.", - "example": "6922KZ" - }, - "status": { - "$ref": "#/components/schemas/StatusNaamgevingEnum" - }, - "geconstateerd": { - "type": "boolean", - "description": "Indicator dat de nummeraanduiding in de registratie is opgenomen door een feitelijke constatering, zonder dat er sprake was van een brondocument/vergunning. De nummeraanduiding is mogelijk illegaal." - }, - "documentdatum": { - "type": "string", - "description": "De vaststellingsdatum van het brondocument dat de basis is voor opname, wijziging of een verwijdering van een object.", - "format": "date", - "example": "2019-11-25T00:00:00.000Z" - }, - "documentnummer": { - "type": "string", - "description": "Identificatie van het brondocument dat ten grondslag ligt aan de opname, mutatie of een verwijdering van gegevens.", - "example": "Duiven 25112019" - }, - "woonplaatsIdentificatie": { - "type": "string", - "description": "Een nummeraanduiding ligt in een woonplaats.", - "example": "2096" - }, - "openbareRuimteIdentificatie": { - "type": "string", - "description": "Een nummeraanduiding ligt aan een openbare ruimte.", - "example": "0226300000136166" - }, - "mogelijkOnjuist": { - "$ref": "#/components/schemas/NummeraanduidingMogelijkOnjuist" - } - }, - "description": "Een postcode, huisnummer met mogelijk een huisletter en huisnummertoevoeging die hoort bij een verblijfsobject, een standplaats of een ligplaats." - }, - "NummeraanduidingIdentificatiesArray": { - "type": "object", - "properties": { - "nummeraanduidingIdentificatie": { - "type": "string", - "example": "0226200000038923" - }, - "isNevenadres": { - "type": "boolean" - } - } - }, - "NummeraanduidingMogelijkOnjuist": { - "type": "object", - "properties": { - "huisnummer": { - "type": "boolean" - }, - "huisletter": { - "type": "boolean" - }, - "huisnummertoevoeging": { - "type": "boolean" - }, - "postcode": { - "type": "boolean" - }, - "status": { - "type": "boolean" - }, - "woonplaatsIdentificatie": { - "type": "boolean" - }, - "openbareRuimteIdentificatie": { - "type": "boolean" - }, - "toelichting": { - "type": "array", - "items": { - "type": "string", - "example": "Woonplaats bestaat mogelijk niet." - } - } - }, - "description": "Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting." - }, - "NummeraanduidingHalBasis": { - "allOf": [ - { - "$ref": "#/components/schemas/Nummeraanduiding" - }, - { - "properties": { - "_links": { - "$ref": "#/components/schemas/NummeraanduidingLinks" - } - } - } - ] - }, - "NummeraanduidingLinks": { - "type": "object", - "properties": { - "self": { - "$ref": "#/components/schemas/HalLink" - }, - "adres": { - "$ref": "#/components/schemas/HalLink" - }, - "openbareRuimte": { - "$ref": "#/components/schemas/HalLink" - }, - "woonplaats": { - "$ref": "#/components/schemas/HalLink" - } - } - }, - "Woonplaats": { - "type": "object", - "properties": { - "identificatie": { - "type": "string" - }, - "domein": { - "type": "string", - "description": "Het domein waartoe de identificatie behoort." - }, - "naam": { - "type": "string", - "description": "De naam van de woonplaats.", - "example": "Duiven" - }, - "status": { - "$ref": "#/components/schemas/StatusWoonplaatsEnum" - }, - "geconstateerd": { - "type": "boolean", - "description": "Indicator dat de woonplaats in de registratie is opgenomen door een feitelijke constatering, zonder dat er een brondocument aan ten grondslag ligt. De woonplaats is mogelijk illegaal." - }, - "documentdatum": { - "type": "string", - "description": "De vaststellingsdatum van het brondocument dat de basis is voor opname, wijziging of een verwijdering van een object.", - "format": "date", - "example": "2009-02-09T00:00:00.000Z" - }, - "documentnummer": { - "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" - }, - "mogelijkOnjuist": { - "$ref": "#/components/schemas/WoonplaatsMogelijkOnjuist" - } - }, - "description": "Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam." - }, - "WoonplaatsMogelijkOnjuist": { - "type": "object", - "properties": { - "naam": { - "type": "boolean" - }, - "geometrie": { - "type": "boolean" - }, - "status": { - "type": "boolean" - }, - "toelichting": { - "type": "array", - "items": { - "type": "string", - "example": "Woonplaats bestaat mogelijk niet." - } - } - }, - "description": "Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting." - }, - "WoonplaatsHalBasis": { - "allOf": [ - { - "$ref": "#/components/schemas/Woonplaats" - }, - { - "properties": { - "_links": { - "$ref": "#/components/schemas/WoonplaatsLinks" - } - } - } - ] - }, - "WoonplaatsHal": { - "allOf": [ - { - "$ref": "#/components/schemas/WoonplaatsHalBasis" - }, - { - "properties": { - "_embedded": { - "$ref": "#/components/schemas/WoonplaatsEmbedded" - } - } - } - ] - }, - "WoonplaatsLinks": { - "type": "object", - "properties": { - "self": { - "$ref": "#/components/schemas/HalLink" - } - } - }, - "WoonplaatsEmbedded": { - "type": "object", - "properties": { - "geometrie": { - "$ref": "#/components/schemas/VlakOfMultivlak" - } - } - }, - "Pand": { - "type": "object", - "properties": { - "identificatie": { - "type": "string", - "description": "De unieke aanduiding van een pand. Elk pand waarvan gegevens zijn opgenomen in de BAG wordt uniek aangeduid door middel van een identificatiecode." - }, - "domein": { - "type": "string", - "description": "Het domein waartoe de identificatie behoort." - }, - "geometrie": { - "$ref": "#/components/schemas/polygonGeoJSON" - }, - "oorspronkelijkBouwjaar": { - "type": "integer", - "description": "Het jaar waarin een pand oorspronkelijk als bouwkundig gereed is opgeleverd. Door de gemeente wordt een inschatting gemaakt van het bouwjaar, en aangepast als het pand wordt opgeleverd. Wijzigingen aan een pand na oplevering leiden niet tot wijziging van het bouwjaar.", - "example": 1991 - }, - "status": { - "$ref": "#/components/schemas/StatusPandEnum" - }, - "geconstateerd": { - "type": "boolean", - "description": "Indicatie dat het pand in de registratie is opgenomen door een feitelijke constatering, zonder dat er sprake was van een brondocument/vergunning. Het pand is mogelijk illegaal." - }, - "documentdatum": { - "type": "string", - "description": "De vaststellingsdatum van het brondocument dat de basis is voor opname, wijziging of een verwijdering van een object.", - "format": "date", - "example": "2009-05-12T00:00:00.000Z" - }, - "documentnummer": { - "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.BW.0273" - }, - "adresseerbaarObjectIdentificaties": { - "type": "array", - "example": [ - "0226010000038820" - ], - "items": { - "type": "string" - } - }, - "nummeraanduidingIdentificaties": { - "type": "array", - "description": "Identificatie(s) van de hoofd- en nevenadressen van het pand.", - "items": { - "$ref": "#/components/schemas/NummeraanduidingIdentificatiesArray" - } - }, - "mogelijkOnjuist": { - "$ref": "#/components/schemas/PandMogelijkOnjuist" - } - }, - "description": "Een pand is een bouwkundige, constructief zelfstandige eenheid die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar is." - }, - "PandMogelijkOnjuist": { - "type": "object", - "properties": { - "geometrie": { - "type": "boolean" - }, - "oorspronkelijkBouwjaar": { - "type": "boolean" - }, - "status": { - "type": "boolean" - }, - "toelichting": { - "type": "array", - "items": { - "type": "string", - "example": "Mogelijk is de bouw al gereed of is het pand niet gerealiseerd." - } - } - }, - "description": "Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting." - }, - "PandHalBasis": { - "allOf": [ - { - "$ref": "#/components/schemas/Pand" - }, - { - "properties": { - "_links": { - "$ref": "#/components/schemas/PandLinks" - } - } - } - ] - }, - "PandLinks": { - "type": "object", - "properties": { - "self": { - "$ref": "#/components/schemas/HalLink" - }, - "adressen": { - "type": "array", - "items": { - "$ref": "#/components/schemas/HalLink" - } - }, - "adresseerbareObjecten": { - "type": "array", - "items": { - "$ref": "#/components/schemas/HalLink" - } - } - } - }, - "PandHalCollectie": { - "type": "object", - "properties": { - "_links": { - "$ref": "#/components/schemas/HalPaginationLinksMetLast" - }, - "_embedded": { - "$ref": "#/components/schemas/PandHalCollectieEmbedded" - } - } - }, - "PandHalCollectieEmbedded": { - "type": "object", - "properties": { - "panden": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PandHalBasis" - } - } - } - }, - "StatusNaamgevingEnum": { - "type": "string", - "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of een nummeraanduiding kan aannemen.", - "enum": [ - "Naamgeving uitgegeven" - ] - }, - "StatusPandEnum": { - "type": "string", - "enum": [ - "Bouwvergunning verleend", - "Bouw gestart", - "Pand in gebruik (niet ingemeten)", - "Pand in gebruik", - "Verbouwing pand", - "Sloopvergunning verleend", - "Pand buiten gebruik" - ] - }, - "StatusWoonplaatsEnum": { - "type": "string", - "description": "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen.", - "enum": [ - "Woonplaats aangewezen" - ] - }, - "TypeAdresseerbaarObjectEnum": { - "type": "string", - "enum": [ - "verblijfsobject", - "standplaats", - "ligplaats" - ] - }, - "TypeOpenbareRuimteEnum": { - "type": "string", - "description": "Een codering van de verschillende waarden die de typering van een openbare ruimte kan aannemen.", - "enum": [ - "Weg", - "Water", - "Spoorbaan", - "Terrein", - "Kunstwerk", - "Landschappelijk gebied", - "Administratief gebied" - ] - }, - "PuntOfVlak": { - "type": "object", - "properties": { - "punt": { - "$ref": "#/components/schemas/pointGeoJSON" - }, - "vlak": { - "$ref": "#/components/schemas/polygonGeoJSON" - } - }, - "description": "Een samengesteld geometriegegevenstype waarbij wordt afgedwongen dat voor de geometrie een keuze gemaakt moet worden tussen een punt of een vlak." - }, - "VlakOfMultivlak": { - "type": "object", - "properties": { - "vlak": { - "$ref": "#/components/schemas/polygonGeoJSON" - }, - "multivlak": { - "$ref": "#/components/schemas/multipolygonGeoJSON" - } - }, - "description": "Een samengesteld geometriegegevenstype waarbij wordt afgedwongen dat voor de geometrie een keuze gemaakt moet worden tussen een vlak (GM_Surface) of een multivlak (GM_MultiSurface)." - }, - "BadRequestFoutbericht": { - "allOf": [ - { - "$ref": "#/components/schemas/Foutbericht" - }, - { - "type": "object", - "properties": { - "invalidParams": { - "type": "array", - "description": "Foutmelding per fout in een parameter. Alle gevonden fouten worden één keer teruggemeld.", - "items": { - "$ref": "#/components/schemas/InvalidParams" - } - } - } - } - ] - }, - "Foutbericht": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Link naar meer informatie over deze fout", - "format": "uri" - }, - "title": { - "type": "string", - "description": "Beschrijving van de fout" - }, - "status": { - "type": "integer", - "description": "Http status code" - }, - "detail": { - "type": "string", - "description": "Details over de fout" - }, - "instance": { - "type": "string", - "description": "Uri van de aanroep die de fout heeft veroorzaakt", - "format": "uri" - }, - "code": { - "minLength": 1, - "type": "string", - "description": "Systeemcode die het type fout aangeeft" - } - }, - "description": "Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807)." - }, - "InvalidParams": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri", - "example": "https://www.vng.nl/realisatie/api/{major-versie}/validaties/integer" - }, - "name": { - "type": "string", - "description": "Naam van de parameter", - "example": "verblijfplaats__huisnummer" - }, - "code": { - "minLength": 1, - "type": "string", - "description": "Systeemcode die het type fout aangeeft", - "example": "integer" - }, - "reason": { - "type": "string", - "description": "Beschrijving van de fout op de parameterwaarde", - "example": "Waarde is geen geldige integer." - } - }, - "description": "Details over fouten in opgegeven parameters" - }, - "CrsEnum": { - "type": "string", - "description": "CRS van geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "default": "epsg:28992", - "enum": [ - "epsg:28992" - ] - }, - "HalLink": { - "required": [ - "href" - ], - "type": "object", - "properties": { - "href": { - "$ref": "#/components/schemas/Href" - }, - "templated": { - "type": "boolean" - }, - "title": { - "type": "string", - "description": "Voor mens leesbaar label bij de link" - } - }, - "description": "De Link Object zoals gespecificeerd in https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5; Deze link kan als templated link worden aangeboden. [URI-templating is hier beschreven](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/uri-templating.feature)." - }, - "Href": { - "type": "string", - "example": "https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}" - }, - "HalPaginationLinksMetLast": { - "description": "HalPaginationLinksMetLast bevat de link properties die nodig zijn om te kunnen navigeren in een eindige collectie:\n\n- first: uri voor het opvragen van de eerste pagina van deze collectie\n- previous: uri voor het opvragen van de vorige pagina van deze collectie\n- next: uri voor het opvragen van de volgende pagina van deze collectie\n- last: uri voor het opvragen van de laatste pagina van deze collectie\n", - "example": { - "self": { - "href": "/resourcenaam?page=4" - }, - "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=8", - "title": "Laatste pagina" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/HalPaginationLinks" - }, - { - "type": "object", - "properties": { - "last": { - "$ref": "#/components/schemas/HalLink" - } - } - } - ] - }, - "HalPaginationLinks": { - "description": "HalPaginationLinks bevat de link properties die nodig zijn om te kunnen navigeren in een collectie:\n\n- first: uri voor het opvragen van de eerste pagina van deze collectie\n- previous: uri voor het opvragen van de vorige pagina van deze collectie\n- next: uri voor het opvragen van de volgende pagina van deze collectie\n", - "example": { - "self": { - "href": "/resourcenaam?page=4" - }, - "first": { - "href": "/resourcenaam?page=1", - "title": "Eerste pagina" - }, - "previous": { - "href": "/resourcenaam?page=3", - "title": "Vorige pagina" - }, - "next": { - "href": "/resourcenaam?page=5", - "title": "Volgende pagina" - } - }, - "allOf": [ - { - "$ref": "#/components/schemas/HalCollectionLinks" - }, - { - "type": "object", - "properties": { - "first": { - "$ref": "#/components/schemas/HalLink" - }, - "previous": { - "$ref": "#/components/schemas/HalLink" - }, - "next": { - "$ref": "#/components/schemas/HalLink" - } - } - } - ] - }, - "HalCollectionLinks": { - "type": "object", - "properties": { - "self": { - "$ref": "#/components/schemas/HalLink" - } - }, - "description": "HalCollectionLinks bevat de self link die elke HAL Resource minimaal moet hebben in zijn _links property\n" - }, - "polygonGeoJSON": { - "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" - } - } - } - } - } - }, - "pointGeoJSON": { - "required": [ - "coordinates", - "type" - ], - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Point" - ] - }, - "coordinates": { - "minItems": 2, - "type": "array", - "items": { - "type": "number" - } - } - } - }, - "multipolygonGeoJSON": { - "required": [ - "coordinates", - "type" - ], - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "MultiPolygon" - ] - }, - "coordinates": { - "type": "array", - "items": { - "type": "array", - "items": { - "minItems": 4, - "type": "array", - "items": { - "minItems": 2, - "type": "array", - "items": { - "type": "number" - } - } - } - } - } - } - } - }, - "parameters": { - "zoek": { - "name": "zoek", - "in": "query", - "description": "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging.", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string" - } - }, - "q": { - "name": "q", - "in": "query", - "description": "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "maxLength": 255, - "minLength": 1, - "type": "string" - } - }, - "zoekresultaatIdentificatie": { - "name": "zoekresultaatIdentificatie", - "in": "query", - "description": "De identificatie van een zoekresultaat van het endpoint get /adressen/zoek.", - "required": false, - "deprecated": true, - "style": "form", - "explode": true, - "schema": { - "type": "string" - } - }, - "locatie-query": { - "name": "locatie", - "in": "query", - "description": "Coördinaten van een locatie die als query-parameter gebruikt wordt om een object te zoeken. Let op, explode is false dus het formaat is ?locatie=196733.51,439931.89", - "required": false, - "style": "form", - "explode": false, - "schema": { - "maxItems": 2, - "minItems": 2, - "type": "array", - "example": [ - 196733.51, - 439931.89 - ], - "items": { - "type": "number" - } - } - }, - "nummeraanduidingIdentificatie-query": { - "name": "nummeraanduidingIdentificatie", - "in": "query", - "description": "Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226200000038923" - } - }, - "pandIdentificatie-query": { - "name": "pandIdentificatie", - "in": "query", - "description": "Identificatie van een pand uit de BAG. Deze is 16 cijfers lang.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226100000008856" - } - }, - "deprecated-pandIdentificatie-query": { - "name": "pandIdentificatie", - "in": "query", - "description": "Identificatie van een pand uit de BAG. Deze is 16 cijfers lang.", - "required": false, - "deprecated": true, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226100000008856" - } - }, - "adresseerbaarObjectIdentificatie-query": { - "name": "adresseerbaarObjectIdentificatie", - "in": "query", - "description": "De identificatie van een adresseerbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226010000038820" - } - }, - "postcode": { - "name": "postcode", - "in": "query", - "description": "Postcode van het adres.", - "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" - } - } - }, - "huisnummer": { - "name": "huisnummer", - "in": "query", - "description": "Huisnummer van het adres.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "maximum": 99999, - "minimum": 1, - "type": "integer", - "example": 1 - } - }, - "huisnummertoevoeging": { - "name": "huisnummertoevoeging", - "in": "query", - "description": "Een toevoeging (in de vorm van maximaal 4 cijfers of letters) aan een huisnummer of een combinatie van huisnummer en huisletter van het adres. Bijvoorbeeld: Bij het adres: Belgiëlaan 1 A2, 2391 PH HAZERSWOUDE-DORP, is 1 het huisnummer, A de huisletter en 2 de huisnummertoevoeging.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[0-9a-zA-Z]{1,4}$", - "type": "string", - "example": "bis" - } - }, - "huisletter": { - "name": "huisletter", - "in": "query", - "description": "Een toevoeging (in de vorm van een letter) aan een huisnummer van het adres. Bijvoorbeeld: Bij adres: Belgiëlaan 1 A2, 2391 PH HAZERSWOUDE-DORP, is 1 het huisnummer en A de huisletter.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "pattern": "^[a-zA-Z]{1}$", - "type": "string", - "example": "A" - } - }, - "exacteMatch": { - "name": "exacteMatch", - "in": "query", - "description": "Geeft aan of de resultaten van de zoekopdracht exact overeen moeten komen met de opgegeven parameters, zie [functionele specificatie exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature).", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "boolean", - "example": true, - "default": false - } - }, - "pandIdentificaties": { - "name": "pandIdentificaties", - "in": "query", - "description": "Een lijst met identificaties van panden uit de BAG.", - "required": false, - "style": "form", - "explode": false, - "schema": { - "minItems": 1, - "type": "array", - "example": [ - "0226100000008856" - ], - "items": { - "pattern": "^[0-9]{16}$", - "type": "string" - } - } - }, - "geconstateerd": { - "name": "geconstateerd", - "in": "query", - "description": "Geeft aan of naar geconstateerde objecten moet worden gezocht.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "boolean" - } - }, - "statusPand": { - "name": "statusPand", - "in": "query", - "description": "Status van het pand.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusPandEnum" - } - } - }, - "bouwjaar": { - "name": "bouwjaar", - "in": "query", - "description": "Bouwjaar van het pand. Geeft het minimale en/of maximale bouwjaar aan van het pand waarnaar moet worden gezocht. Een bouwjaar is een natuurlijk getal tussen 0 (minimaal) en 9999 (maximaal). Bv: bouwjaar[min]=1970&bouwjaar[max]=2010", - "required": false, - "style": "deepObject", - "explode": true, - "schema": { - "$ref": "#/components/schemas/BouwjaarFilter" - } - }, - "type": { - "name": "type", - "in": "query", - "description": "Geeft aan of het adresseerbaar object een ligplaats, standplaats of verblijfsobject is.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "$ref": "#/components/schemas/TypeAdresseerbaarObjectEnum" - } - }, - "gebruiksdoelen": { - "name": "gebruiksdoelen", - "in": "query", - "description": "De gebruiksdoelen van het verblijfsobject zoals in de vergunning is opgenomen of bij constatering is vastgesteld. Als een verblijfsobject één van de gebruiksdoelen in deze lijst heeft, dan wordt het verblijfsobject in het zoekresultaat meegenomen.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/GebruiksdoelEnum" - } - } - }, - "oppervlakte": { - "name": "oppervlakte", - "in": "query", - "description": "Geef de minimale en maximale oppervlakte op waarbinnen je wilt zoeken (in m2). Alleen verblijfsobjecten hebben een oppervlakte en kunnen met deze parameter worden gevonden. Ligplaatsen en standplaatsen hebben geen oppervlakte en kunnen met deze parameter niet worden gevonden. De oppervlakte van een verblijfsobject is een natuurlijk getal tussen 1 (minimaal) en 999999 (maximaal). Het is niet toegestaan voor min een grotere waarde op te geven dan voor max. Is min > max dan treedt een foutmelding op. Bv: oppervlakte[min]=100&oppervlakte[max]=200", - "required": false, - "style": "deepObject", - "explode": true, - "schema": { - "$ref": "#/components/schemas/OppervlakteFilter" - } - }, - "bbox": { - "name": "bbox", - "in": "query", - "description": "Rechthoek waarbinnen het object dat je zoekt valt. Objecten die de rand van de rechthoek raken of kruisen worden in het zoekresultaat meegenomen. Voor 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). In tegenstelling tot wat er in de OGC API Features specificatie staat, wordt hier geen bbox-crs parameter maar de contentCrs parameter gebruikt om aan te geven in welk CRS de coördinaten van de bbox zijn. Daarnaast kan er alleen met 2D coördinaten worden gezocht. De oppervlakte van de bounding box mag maximaal 250 duizend vierkante meter zijn.", - "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" - } - } - }, - "nummeraanduidingidentificatie": { - "name": "nummeraanduidingidentificatie", - "in": "path", - "description": "Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang.", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226200000038923" - } - }, - "adresseerbaarobjectidentificatie": { - "name": "adresseerbaarobjectidentificatie", - "in": "path", - "description": "De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn.", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226010000038820" - } - }, - "pandidentificatie": { - "name": "pandidentificatie", - "in": "path", - "description": "Identificatie van een pand uit de BAG. Deze is 16 cijfers lang.", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226100000008856" - } - }, - "woonplaatsidentificatie": { - "name": "woonplaatsidentificatie", - "in": "path", - "description": "De identificatie van een woonplaats.", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "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": "Deze wordt gebruikt in de operation, bv. /woonplaatsen/0123. Waarde: 0001-9999.", - "example": "2096" - } - }, - "openbareruimteidentificatie": { - "name": "openbareruimteidentificatie", - "in": "path", - "description": "Identificatie van een object uit de BAG. Deze is 16 cijfers lang.", - "required": true, - "style": "simple", - "explode": false, - "schema": { - "pattern": "^[0-9]{16}$", - "type": "string", - "example": "0226300000136166" - } - } - }, - "headers": { - "api_version": { - "schema": { - "type": "string", - "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", - "example": "1.0.0" - } - }, - "warning": { - "schema": { - "type": "string", - "description": "zie RFC 7234. In het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 (\"Miscellaneous Persistent Warning\") en het API end-point (inclusief versienummer) als de warn-agent van de warning, gevolgd door de warn-text met de human-readable waarschuwing", - "example": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\"." - } - }, - "X_Pagination_Page": { - "schema": { - "type": "integer", - "description": "Huidige pagina.", - "example": 3 - } - }, - "X_Pagination_Limit": { - "schema": { - "type": "integer", - "description": "Aantal resultaten per pagina.", - "example": 20 - } - }, - "contentCrs": { - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "schema": { - "$ref": "#/components/schemas/CrsEnum" - } - } - }, - "securitySchemes": { - "apiKeyBAG": { - "type": "apiKey", - "description": "De API-key die je hebt gekregen dient bij elke request via de `X-Api-Key` request header meegestuurd te worden. Indien deze niet juist wordt meegestuurd, of het een ongeldige key betreft, zul je de foutmelding `403 Forbidden` terugkrijgen.", - "name": "X-Api-Key", - "in": "header" - } - } - } -} \ No newline at end of file diff --git a/specificatie/genereervariant/openapi.yaml b/specificatie/genereervariant/openapi.yaml deleted file mode 100644 index 751b24f..0000000 --- a/specificatie/genereervariant/openapi.yaml +++ /dev/null @@ -1,3748 +0,0 @@ -openapi: 3.0.0 -info: - title: Huidige bevragingen API - description: Deze API levert actuele gegevens over adressen, adresseerbare objecten - en panden. Actueel betekent in deze API `zonder eindstatus`. De bron voor deze - API is de basisregistratie adressen en gebouwen (BAG). - termsOfService: https://zakelijk.kadaster.nl/algemene-voorwaarden - contact: - name: Kadaster - Beheerder Landelijke Voorziening BAG - url: https://zakelijk.kadaster.nl/bag - email: bag@kadaster.nl - license: - name: European Union Public License, version 1.2 (EUPL-1.2) - url: https://eupl.eu/1.2/nl/ - version: 1.5.0 -servers: -- url: https://api.bag.acceptatie.kadaster.nl/esd/huidigebevragingen/v1 - description: LVBAG - ACCEPTATIE -- url: https://api.bag.kadaster.nl/esd/huidigebevragingen/v1 - description: LVBAG - PRODUCTIE -security: -- apiKeyBAG: [] -paths: - /adressen/zoek: - get: - tags: - - Adres - summary: '"fuzzy" zoeken van adressen' - description: Free query zoeken van adressen met postcode, woonplaats, straatnaam, - huisnummer, huisletter, huisnummertoevoeging. Delen van de adressen in het - antwoord matchen exact met jouw invoer. Je vindt een adres door de zoekresultaatidentificatie - uit het antwoord te gebruiken in get/adressen - operationId: zoek - parameters: - - name: zoek - in: query - description: Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, - huisnummertoevoeging. - required: true - style: form - explode: true - schema: - type: string - - name: page - in: query - description: Pagina nummer - required: false - schema: - minimum: 1 - type: integer - default: 1 - - name: pageSize - in: query - required: false - schema: - maximum: 100 - minimum: 1 - type: integer - default: 20 - responses: - "200": - description: Geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - X-Pagination-Page: - $ref: '#/components/headers/X_Pagination_Page' - X-Pagination-Limit: - $ref: '#/components/headers/X_Pagination_Limit' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/ZoekResultaatHalCollectie' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - 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 - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr accept headers sent in the request - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAcceptable - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - 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 - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - deprecated: true - security: - - apiKeyBAG: [] - /adressen: - get: - tags: - - Adres - summary: vindt adressen - description: "Vind een actueel adres met:\n1. Een pandidentificatie of\n2. Een\ - \ adresseerbaarobjectidentificatie of\n3. Een postcode, huisnummer en optioneel\ - \ huisletter, huisnummertoevoeging en/of exacteMatch.\n4. Een zoekterm.\n\n\ - Gebruik de fields-parameter als je alleen specifieke velden in het antwoord\ - \ wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).\ - \ \nGebruik de expand-parameter als je het antwoord wil uitbreiden met (delen\ - \ van) de gerelateerde resources nummeraanduiding, woonplaats en openbare\ - \ ruimte, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature).\n\ - Gebruik de exacteMatch parameter als je alleen resultaten wilt ontvangen die\ - \ exact overeenkomen met de opgegeven zoek criteria, zie [functionele specificaties\ - \ exacteMatch-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/blob/v1.2.0/features/exacte_match.feature).\ - \ Je kunt adresseerbare objecten niet expanden als je tegelijkertijd de query\ - \ parameter adresseerbaarObjectIdentificatie gebruikt." - operationId: raadpleegAdressen - parameters: - - name: pandIdentificatie - in: query - description: Identificatie van een pand uit de BAG. Deze is 16 cijfers lang. - required: false - style: form - explode: true - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226100000008856" - - name: adresseerbaarObjectIdentificatie - in: query - description: De identificatie van een adresseerbaar object uit de BAG. Deze - is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats - zijn. - required: false - style: form - explode: true - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226010000038820" - - name: zoekresultaatIdentificatie - in: query - description: De identificatie van een zoekresultaat van het endpoint get /adressen/zoek. - required: false - deprecated: true - style: form - explode: true - schema: - type: string - - name: expand - in: query - description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd - moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of - enkele properties geef je in de expand parameter kommagescheiden op. Properties - die je wil ontvangen geef je op met de resource-naam gevolgd door de property - naam, met daartussen een punt. In de definitie van het antwoord kun je bij - _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie - [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature). - required: false - schema: - type: string - - name: fields - in: query - description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen - door een door komma's gescheiden lijst van property namen op te geven. Bij - opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. - Wanneer de fields parameter niet is opgegeven, worden alle properties met - een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) - required: false - schema: - type: string - - name: page - in: query - description: Pagina nummer - required: false - schema: - minimum: 1 - type: integer - default: 1 - - name: pageSize - in: query - required: false - schema: - maximum: 100 - minimum: 1 - type: integer - default: 20 - - name: postcode - in: query - description: Postcode van het adres. - 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 van het adres. - required: false - style: form - explode: true - schema: - maximum: 99999 - minimum: 1 - type: integer - example: 1 - - name: huisletter - in: query - description: 'Een toevoeging (in de vorm van een letter) aan een huisnummer - van het adres. Bijvoorbeeld: Bij adres: Belgiëlaan 1 A2, 2391 PH HAZERSWOUDE-DORP, - is 1 het huisnummer en A de huisletter.' - required: false - style: form - explode: true - schema: - pattern: ^[a-zA-Z]{1}$ - type: string - example: A - - name: huisnummertoevoeging - in: query - description: 'Een toevoeging (in de vorm van maximaal 4 cijfers of letters) - aan een huisnummer of een combinatie van huisnummer en huisletter van het - adres. Bijvoorbeeld: Bij het adres: Belgiëlaan 1 A2, 2391 PH HAZERSWOUDE-DORP, - is 1 het huisnummer, A de huisletter en 2 de huisnummertoevoeging.' - required: false - style: form - explode: true - schema: - pattern: ^[0-9a-zA-Z]{1,4}$ - type: string - example: bis - - name: exacteMatch - in: query - description: Geeft aan of de resultaten van de zoekopdracht exact overeen - moeten komen met de opgegeven parameters, zie [functionele specificatie - exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature). - required: false - style: form - explode: true - schema: - type: boolean - example: true - default: false - - name: q - in: query - description: Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, - huisnummertoevoeging. - required: false - style: form - explode: true - schema: - maxLength: 255 - minLength: 1 - type: string - responses: - "200": - description: Geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - X-Pagination-Page: - $ref: '#/components/headers/X_Pagination_Page' - X-Pagination-Limit: - $ref: '#/components/headers/X_Pagination_Limit' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/AdresHalCollectie' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - 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 - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr accept headers sent in the request - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAcceptable - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - 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 - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - security: - - apiKeyBAG: [] - /adressen/{nummeraanduidingidentificatie}: - get: - tags: - - Adres - summary: levert een adres - description: "Raadpleeg een actueel adres met de nummeraanduidingidentificatie.\ - \ \nGebruik de fields-parameter als je alleen specifieke velden in het antwoord\ - \ wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).\ - \ \nGebruik de expand-parameter als je het antwoord wil uitbreiden met (delen\ - \ van) de gerelateerde resources nummeraanduiding, woonplaats, openbare ruimte,\ - \ adresseerbaarobject, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature)." - operationId: raadpleegAdresMetNumId - parameters: - - name: nummeraanduidingidentificatie - in: path - description: Identificatie van een nummeraanduiding uit de BAG. Deze is 16 - cijfers lang. - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226200000038923" - - name: expand - in: query - description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd - moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of - enkele properties geef je in de expand parameter kommagescheiden op. Properties - die je wil ontvangen geef je op met de resource-naam gevolgd door de property - naam, met daartussen een punt. In de definitie van het antwoord kun je bij - _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie - [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature). - required: false - schema: - type: string - - name: fields - in: query - description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen - door een door komma's gescheiden lijst van property namen op te geven. Bij - opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. - Wanneer de fields parameter niet is opgegeven, worden alle properties met - een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) - required: false - schema: - type: string - responses: - "200": - description: Geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/AdresHal' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - 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 - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - 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: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 - title: Opgevraagde resource bestaat niet. - status: 404 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr accept headers sent in the request - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAcceptable - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - 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 - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - security: - - apiKeyBAG: [] - /adresseerbareobjecten/{adresseerbaarobjectidentificatie}: - get: - tags: - - Adresseerbaar object - summary: levert een verblijfsobject, standplaats of ligplaats - description: Raadpleeg een actueel adresseerbaar object met de identificatie. - Dit is de identificatie van een verblijfsobject, ligplaats of standplaats. - Gebruik de fields-parameter als je alleen specifieke velden in het antwoord - wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). - Gebruik de expand-parameter als je het antwoord wil uitbreiden met (delen - van) de gerelateerde resources adres en pand, zie [functionele specificaties - expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). - operationId: raadpleegAdresseerbaarobject - parameters: - - name: adresseerbaarobjectidentificatie - in: path - description: De identificatie van een adresserbaar object uit de BAG. Deze - is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats - zijn. - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226010000038820" - - name: expand - in: query - description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd - moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of - enkele properties geef je in de expand parameter kommagescheiden op. Properties - die je wil ontvangen geef je op met de resource-naam gevolgd door de property - naam, met daartussen een punt. In de definitie van het antwoord kun je bij - _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie - [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature). - required: false - schema: - type: string - - name: fields - in: query - description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen - door een door komma's gescheiden lijst van property namen op te geven. Bij - opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. - Wanneer de fields parameter niet is opgegeven, worden alle properties met - een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) - required: false - schema: - type: string - - name: Accept-Crs - in: header - description: Gewenste CRS van de coördinaten in de response. - required: false - schema: - $ref: '#/components/schemas/CrsEnum' - responses: - "200": - description: Geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - Content-Crs: - $ref: '#/components/headers/contentCrs' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/AdresseerbaarObjectHal' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - 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 - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - 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: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 - title: Opgevraagde resource bestaat niet. - status: 404 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr 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: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13 - title: Precondition Failed - status: 412 - 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 - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - 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 - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - security: - - apiKeyBAG: [] - /adresseerbareobjecten: - get: - tags: - - Adresseerbaar object - summary: vindt verblijfsobjecten, ligplaatsen, standplaatsen - description: |- - Zoek actuele adresseerbare objecten (verblijfsobjecten, standplaatsen of ligplaatsen) met: - 1. een nummeraanduidingidentificatie of - 2. een pandidentificatie of - 3. een lijst met pandidentificaties of - 4. een geometrische contour (rechthoek) in combinatie met status geconstateerd, oppervlakte, gebruiksdoel en/of type. - - Het zoeken van adresseerbare objecten met een oppervlakte en een type=ligplaats of type=standplaats wordt niet ondersteund en levert een foutmelding. - Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). - Gebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources adres en pand, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). Je kunt panden niet expanden als je tegelijkertijd de query parameter pandIdentificatie(s) gebruikt. - operationId: raadpleegAdresseerbareobjecten - parameters: - - name: nummeraanduidingIdentificatie - in: query - description: Identificatie van een nummeraanduiding uit de BAG. Deze is 16 - cijfers lang. - required: false - style: form - explode: true - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226200000038923" - - name: pandIdentificatie - in: query - description: Identificatie van een pand uit de BAG. Deze is 16 cijfers lang. - required: false - deprecated: true - style: form - explode: true - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226100000008856" - - name: expand - in: query - description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd - moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of - enkele properties geef je in de expand parameter kommagescheiden op. Properties - die je wil ontvangen geef je op met de resource-naam gevolgd door de property - naam, met daartussen een punt. In de definitie van het antwoord kun je bij - _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie - [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature). - required: false - schema: - type: string - - name: fields - in: query - description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen - door een door komma's gescheiden lijst van property namen op te geven. Bij - opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. - Wanneer de fields parameter niet is opgegeven, worden alle properties met - een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) - required: false - schema: - type: string - - name: Accept-Crs - in: header - description: Gewenste CRS van de coördinaten in de response. - required: false - schema: - $ref: '#/components/schemas/CrsEnum' - - name: page - in: query - description: Pagina nummer - required: false - schema: - minimum: 1 - type: integer - default: 1 - - name: pageSize - in: query - required: false - schema: - maximum: 100 - minimum: 1 - type: integer - default: 20 - - name: pandIdentificaties - in: query - description: Een lijst met identificaties van panden uit de BAG. - required: false - style: form - explode: false - schema: - minItems: 1 - type: array - example: - - "0226100000008856" - items: - pattern: ^[0-9]{16}$ - type: string - - name: geconstateerd - in: query - description: Geeft aan of naar geconstateerde objecten moet worden gezocht. - required: false - style: form - explode: true - schema: - type: boolean - - name: type - in: query - description: Geeft aan of het adresseerbaar object een ligplaats, standplaats - of verblijfsobject is. - required: false - style: form - explode: true - schema: - $ref: '#/components/schemas/TypeAdresseerbaarObjectEnum' - - name: gebruiksdoelen - in: query - description: De gebruiksdoelen van het verblijfsobject zoals in de vergunning - is opgenomen of bij constatering is vastgesteld. Als een verblijfsobject - één van de gebruiksdoelen in deze lijst heeft, dan wordt het verblijfsobject - in het zoekresultaat meegenomen. - required: false - style: form - explode: true - schema: - minItems: 1 - type: array - items: - $ref: '#/components/schemas/GebruiksdoelEnum' - - name: bbox - in: query - description: Rechthoek waarbinnen het object dat je zoekt valt. Objecten die - de rand van de rechthoek raken of kruisen worden in het zoekresultaat meegenomen. - Voor 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). - In tegenstelling tot wat er in de OGC API Features specificatie staat, wordt - hier geen bbox-crs parameter maar de contentCrs parameter gebruikt om aan - te geven in welk CRS de coördinaten van de bbox zijn. Daarnaast kan er alleen - met 2D coördinaten worden gezocht. De oppervlakte van de bounding box mag - maximaal 250 duizend vierkante meter zijn. - 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: oppervlakte - in: query - description: 'Geef de minimale en maximale oppervlakte op waarbinnen je wilt - zoeken (in m2). Alleen verblijfsobjecten hebben een oppervlakte en kunnen - met deze parameter worden gevonden. Ligplaatsen en standplaatsen hebben - geen oppervlakte en kunnen met deze parameter niet worden gevonden. De oppervlakte - van een verblijfsobject is een natuurlijk getal tussen 1 (minimaal) en 999999 - (maximaal). Het is niet toegestaan voor min een grotere waarde op te geven - dan voor max. Is min > max dan treedt een foutmelding op. Bv: oppervlakte[min]=100&oppervlakte[max]=200' - required: false - style: deepObject - explode: true - schema: - $ref: '#/components/schemas/OppervlakteFilter' - - name: Content-Crs - in: header - description: CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New - Nederlands coordinatenstelsel. - required: false - schema: - $ref: '#/components/schemas/CrsEnum' - responses: - "200": - description: Geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - X-Pagination-Page: - $ref: '#/components/headers/X_Pagination_Page' - X-Pagination-Limit: - $ref: '#/components/headers/X_Pagination_Limit' - Content-Crs: - $ref: '#/components/headers/contentCrs' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/AdresseerbaarobjectHalCollectie' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - 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 - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr 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: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13 - title: Precondition Failed - status: 412 - 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 - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - 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 - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - security: - - apiKeyBAG: [] - /woonplaatsen/{woonplaatsidentificatie}: - get: - tags: - - Adres - summary: levert BAG details van een woonplaats - description: Raadpleeg een actuele woonplaats met de identificatie. Een woonplaats - is een gedeelte van het grondgebied van de gemeente met een naam. Gebruik - de fields-parameter als je alleen specifieke velden in het antwoord wil zien, - zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). - Gebruik de expand-parameter als je het antwoord wil uitbreiden met de gerelateerde - resource geometrie, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). - operationId: raadpleegWoonplaats - parameters: - - name: woonplaatsidentificatie - in: path - description: De identificatie van een woonplaats. - required: true - style: simple - explode: false - schema: - 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: 'Deze wordt gebruikt in de operation, bv. /woonplaatsen/0123. - Waarde: 0001-9999.' - example: "2096" - - name: expand - in: query - description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd - moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of - enkele properties geef je in de expand parameter kommagescheiden op. Properties - die je wil ontvangen geef je op met de resource-naam gevolgd door de property - naam, met daartussen een punt. In de definitie van het antwoord kun je bij - _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie - [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature). - required: false - schema: - type: string - - name: fields - in: query - description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen - door een door komma's gescheiden lijst van property namen op te geven. Bij - opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. - Wanneer de fields parameter niet is opgegeven, worden alle properties met - een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) - required: false - schema: - type: string - - name: Accept-Crs - in: header - description: Gewenste CRS van de coördinaten in de response. - required: false - schema: - $ref: '#/components/schemas/CrsEnum' - responses: - "200": - description: Geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - Content-Crs: - $ref: '#/components/headers/contentCrs' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/WoonplaatsHal' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - 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 - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - 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: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 - title: Opgevraagde resource bestaat niet. - status: 404 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr 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: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13 - title: Precondition Failed - status: 412 - 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 - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - 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 - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - security: - - apiKeyBAG: [] - /openbareruimten/{openbareruimteidentificatie}: - get: - tags: - - Adres - summary: levert BAG detals van een openbare ruimte - description: Raadpleeg een actuele openbare ruimte met de identificatie. Een - openbare ruimte is een buitenruimte met een naam die binnen één woonplaats - ligt, bijvoorbeeld een straat of een plein. Gebruik de fields-parameter als - je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties - fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). - operationId: raadpleegOpenbareRuimte - parameters: - - name: openbareruimteidentificatie - in: path - description: Identificatie van een object uit de BAG. Deze is 16 cijfers lang. - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226300000136166" - - name: fields - in: query - description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen - door een door komma's gescheiden lijst van property namen op te geven. Bij - opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. - Wanneer de fields parameter niet is opgegeven, worden alle properties met - een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) - required: false - schema: - type: string - responses: - "200": - description: Geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/OpenbareRuimteHalBasis' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - 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 - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - 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: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 - title: Opgevraagde resource bestaat niet. - status: 404 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr accept headers sent in the request - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAcceptable - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - 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 - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - security: - - apiKeyBAG: [] - /nummeraanduidingen/{nummeraanduidingidentificatie}: - get: - tags: - - Adres - summary: levert BAG details van een nummeraanduiding - description: Raadpleeg een actuele nummeraanduiding met de identificatie. Een - nummeraanduiding is een postcode, huisnummer met evt een huisletter en huisnummertoevoeging - die hoort bij een verblijfsobject, een standplaats of een ligplaats. Gebruik - de fields-parameter als je alleen specifieke velden in het antwoord wil zien, - zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). - operationId: raadpleegNummeraanduiding - parameters: - - name: nummeraanduidingidentificatie - in: path - description: Identificatie van een nummeraanduiding uit de BAG. Deze is 16 - cijfers lang. - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226200000038923" - - name: fields - in: query - description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen - door een door komma's gescheiden lijst van property namen op te geven. Bij - opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. - Wanneer de fields parameter niet is opgegeven, worden alle properties met - een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) - required: false - schema: - type: string - responses: - "200": - description: Geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/NummeraanduidingHalBasis' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - 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 - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - 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: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 - title: Opgevraagde resource bestaat niet. - status: 404 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr accept headers sent in the request - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAcceptable - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - 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 - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - security: - - apiKeyBAG: [] - /panden/{pandidentificatie}: - get: - tags: - - Pand - summary: levert een pand - description: Raadpleeg een actueel pand met de identificatie. Een pand is een - bouwkundige, constructief zelfstandige eenheid die direct en duurzaam met - de aarde is verbonden en betreedbaar en afsluitbaar is. Gebruik de fields-parameter - als je alleen specifieke velden in het antwoord wil zien, zie [functionele - specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). - operationId: raadpleegPand - parameters: - - name: pandidentificatie - in: path - description: Identificatie van een pand uit de BAG. Deze is 16 cijfers lang. - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226100000008856" - - name: fields - in: query - description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen - door een door komma's gescheiden lijst van property namen op te geven. Bij - opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. - Wanneer de fields parameter niet is opgegeven, worden alle properties met - een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) - required: false - schema: - type: string - - name: Accept-Crs - in: header - description: Gewenste CRS van de coördinaten in de response. - required: false - schema: - $ref: '#/components/schemas/CrsEnum' - responses: - "200": - description: Geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - Content-Crs: - $ref: '#/components/headers/contentCrs' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/PandHalBasis' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - 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 - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - 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: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 - title: Opgevraagde resource bestaat niet. - status: 404 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr 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: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13 - title: Precondition Failed - status: 412 - 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 - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - 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 - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - security: - - apiKeyBAG: [] - /panden: - get: - tags: - - Pand - summary: vindt panden - description: "Zoek actuele panden:\n1. met de identificatie van een adresseerbaar\ - \ object of\n2. met de identificatie van een nummeraanduiding of\n3. met een\ - \ locatie (punt) of \n4. binnen een geometrische contour (rechthoek) die voldoen\ - \ aan de opgegeven status, geconstateerd of bouwjaar.\n\nGebruik de fields-parameter\ - \ als je alleen specifieke velden in het antwoord wil zien, zie [functionele\ - \ specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature)." - operationId: raadpleegPanden - parameters: - - name: adresseerbaarObjectIdentificatie - in: query - description: De identificatie van een adresseerbaar object uit de BAG. Deze - is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats - zijn. - required: false - style: form - explode: true - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226010000038820" - - name: nummeraanduidingIdentificatie - in: query - description: Identificatie van een nummeraanduiding uit de BAG. Deze is 16 - cijfers lang. - required: false - style: form - explode: true - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226200000038923" - - name: locatie - in: query - description: Coördinaten van een locatie die als query-parameter gebruikt - wordt om een object te zoeken. Let op, explode is false dus het formaat - is ?locatie=196733.51,439931.89 - required: false - style: form - explode: false - schema: - maxItems: 2 - minItems: 2 - type: array - example: - - 196733.51 - - 439931.89 - items: - type: number - - name: fields - in: query - description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen - door een door komma's gescheiden lijst van property namen op te geven. Bij - opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. - Wanneer de fields parameter niet is opgegeven, worden alle properties met - een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) - required: false - schema: - type: string - - name: Accept-Crs - in: header - description: Gewenste CRS van de coördinaten in de response. - required: false - schema: - $ref: '#/components/schemas/CrsEnum' - - name: Content-Crs - in: header - description: CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New - Nederlands coordinatenstelsel. - required: false - schema: - $ref: '#/components/schemas/CrsEnum' - - name: bbox - in: query - description: Rechthoek waarbinnen het object dat je zoekt valt. Objecten die - de rand van de rechthoek raken of kruisen worden in het zoekresultaat meegenomen. - Voor 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). - In tegenstelling tot wat er in de OGC API Features specificatie staat, wordt - hier geen bbox-crs parameter maar de contentCrs parameter gebruikt om aan - te geven in welk CRS de coördinaten van de bbox zijn. Daarnaast kan er alleen - met 2D coördinaten worden gezocht. De oppervlakte van de bounding box mag - maximaal 250 duizend vierkante meter zijn. - 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: statusPand - in: query - description: Status van het pand. - required: false - style: form - explode: true - schema: - minItems: 1 - type: array - items: - $ref: '#/components/schemas/StatusPandEnum' - - name: geconstateerd - in: query - description: Geeft aan of naar geconstateerde objecten moet worden gezocht. - required: false - style: form - explode: true - schema: - type: boolean - - name: bouwjaar - in: query - description: 'Bouwjaar van het pand. Geeft het minimale en/of maximale bouwjaar - aan van het pand waarnaar moet worden gezocht. Een bouwjaar is een natuurlijk - getal tussen 0 (minimaal) en 9999 (maximaal). Bv: bouwjaar[min]=1970&bouwjaar[max]=2010' - required: false - style: deepObject - explode: true - schema: - $ref: '#/components/schemas/BouwjaarFilter' - - name: page - in: query - description: Pagina nummer - required: false - schema: - minimum: 1 - type: integer - default: 1 - - name: pageSize - in: query - required: false - schema: - maximum: 100 - minimum: 1 - type: integer - default: 20 - responses: - "200": - description: Geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - X-Pagination-Page: - $ref: '#/components/headers/X_Pagination_Page' - X-Pagination-Limit: - $ref: '#/components/headers/X_Pagination_Limit' - Content-Crs: - $ref: '#/components/headers/contentCrs' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/PandHalCollectie' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - 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 - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr 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: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13 - title: Precondition Failed - status: 412 - 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 - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - 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 - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - 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 - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - security: - - apiKeyBAG: [] -components: - schemas: - ZoekResultaat: - 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 - ZoekResultaatHal: - deprecated: true - allOf: - - $ref: '#/components/schemas/ZoekResultaat' - - properties: - _links: - $ref: '#/components/schemas/ZoekResultaatLinks' - ZoekResultaatLinks: - type: object - properties: - adres: - $ref: '#/components/schemas/HalLink' - deprecated: true - ZoekResultaatHalCollectie: - type: object - properties: - _links: - $ref: '#/components/schemas/HalPaginationLinksMetLast' - _embedded: - $ref: '#/components/schemas/ZoekResultaatHalCollectieEmbedded' - description: Resultaten als lijst. - deprecated: true - ZoekResultaatHalCollectieEmbedded: - type: object - properties: - zoekresultaten: - type: array - items: - $ref: '#/components/schemas/ZoekResultaatHal' - deprecated: true - BouwjaarFilter: - type: object - properties: - min: - maximum: 9999 - minimum: 0 - type: integer - description: Zoek naar waarden groter of gelijk aan de opgegeven waarde. - max: - maximum: 9999 - minimum: 0 - 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" - OppervlakteFilter: - 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" - Adres: - type: object - properties: - straat: - title: openbareruimte naam - type: string - description: Een naam die door de gemeente aan een openbare ruimte is gegeven. - example: Laan van de landinrichtingscommissie Duiven-Westervoort - huisnummer: - type: integer - description: Een nummer dat door de gemeente aan een adresseerbaar object - is gegeven. - example: 1 - huisletter: - type: string - description: Een toevoeging aan een huisnummer in de vorm van een letter - die door de gemeente aan een adresseerbaar object is gegeven. - example: A - huisnummertoevoeging: - type: string - description: Een toevoeging aan een huisnummer of een combinatie van huisnummer - en huisletter die door de gemeente aan een adresseerbaar object is gegeven. - example: bis - postcode: - type: string - description: De door PostNL vastgestelde code die bij een bepaalde combinatie - van een straatnaam en een huisnummer hoort. - example: 6922KZ - woonplaats: - title: woonplaats naam - type: string - description: Een woonplaats is een gedeelte van het grondgebied van de gemeente - met een naam. - example: Duiven - description: Eigenschappen van het adres die kunnen worden hergebruikt in andere - API's met adresgegevens. - AdresUitgebreid: - allOf: - - $ref: '#/components/schemas/Adres' - - properties: - adresregel1: - type: string - description: De eerste regel van het adres zoals deze gebruikt kan worden - in postadressering. - example: Ln vd l D-Westervoort 1 - adresregel2: - type: string - description: De tweede regel van het adres zoals deze gebruikt kan worden - in postadressering. - example: 6922 KZ DUIVEN - korteNaam: - maxLength: 24 - type: string - description: De officiële openbareruimtenaam of een verkorte versie. Beiden - hebben maximaal 24 tekens. - example: Ln vd l D-Westervoort - nummeraanduidingIdentificatie: - type: string - description: Fungeert ook als identificatie van het adres. - example: "0226200000038923" - openbareRuimteIdentificatie: - type: string - example: "0226300000136166" - woonplaatsIdentificatie: - type: string - example: "2096" - adresseerbaarObjectIdentificatie: - type: string - example: "0226010000038820" - pandIdentificaties: - type: array - description: Identificatie(s) van het pand of de panden waar het verblijfsobject - deel van is. - example: - - "0226100000008856" - items: - type: string - isNevenadres: - 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. - geconstateerd: - type: boolean - description: Indicatie dat dit adres in de registratie is opgenomen door - een feitelijke constatering, zonder dat er sprake was van een brondocument/vergunning. - Het adres is mogelijk illegaal. - mogelijkOnjuist: - $ref: '#/components/schemas/AdresMogelijkOnjuist' - description: Het adres is de benaming van een locatie bestaande uit straatnaam, - huisnummer, (mogelijk met huisletter, huisnummertoevoeging, postcode) en - woonplaatsnaam. Dit is de vereenvoudigde samenstelling van de officiële - naamgeving gebaseerd op woonplaats, openbare ruimte en nummeraanduiding. - AdresMogelijkOnjuist: - type: object - properties: - adresregel1: - type: boolean - adresregel2: - type: boolean - korteNaam: - type: boolean - straat: - type: boolean - huisnummer: - type: boolean - huisletter: - type: boolean - huisnummertoevoeging: - type: boolean - postcode: - type: boolean - woonplaats: - type: boolean - nummeraanduidingIdentificatie: - type: boolean - openbareRuimteIdentificatie: - type: boolean - woonplaatsIdentificatie: - type: boolean - toelichting: - type: array - items: - type: string - example: Geometrie of woonplaatsgrens is mogelijk onjuist, waardoor gaten - of overlappingen ontstaan in de registratie van woonplaatsen. Gevolg - kan zijn dat een object in een verkeerde woonplaats, in twee woonplaatsen, - of in geen enkele woonplaats ligt. - description: Wanneer true is de waarde mogelijk onjuist en wordt juistheid op - dit moment onderzocht. Zie toelichting. - AdresHal: - allOf: - - $ref: '#/components/schemas/AdresHalBasis' - - properties: - _embedded: - $ref: '#/components/schemas/AdresEmbedded' - AdresHalBasis: - allOf: - - $ref: '#/components/schemas/AdresUitgebreid' - - properties: - _links: - $ref: '#/components/schemas/AdresLinks' - AdresHalCollectie: - type: object - properties: - _links: - $ref: '#/components/schemas/HalPaginationLinksMetLast' - _embedded: - $ref: '#/components/schemas/AdresHalCollectieEmbedded' - AdresHalCollectieEmbedded: - type: object - properties: - adressen: - type: array - items: - $ref: '#/components/schemas/AdresHal' - AdresLinks: - type: object - properties: - self: - $ref: '#/components/schemas/HalLink' - openbareRuimte: - $ref: '#/components/schemas/HalLink' - nummeraanduiding: - $ref: '#/components/schemas/HalLink' - woonplaats: - $ref: '#/components/schemas/HalLink' - adresseerbaarObject: - $ref: '#/components/schemas/HalLink' - panden: - type: array - description: Het/de aan het adres gerelateerde pand(en). - items: - $ref: '#/components/schemas/HalLink' - AdresEmbedded: - type: object - properties: - openbareRuimte: - $ref: '#/components/schemas/OpenbareRuimteHalBasis' - nummeraanduiding: - $ref: '#/components/schemas/NummeraanduidingHalBasis' - woonplaats: - $ref: '#/components/schemas/WoonplaatsHalBasis' - adresseerbaarObject: - $ref: '#/components/schemas/AdresseerbaarObjectHalBasis' - AdresseerbaarObject: - type: object - properties: - identificatie: - type: string - description: Dit is de identificatie van een verblijfsobject, standplaats - of ligplaats. - example: "0226010000038820" - domein: - type: string - description: Het domein waartoe de identificatie behoort. - type: - $ref: '#/components/schemas/TypeAdresseerbaarObjectEnum' - documentdatum: - type: string - description: De vaststellingsdatum van het brondocument dat de basis is - voor opname, wijziging of een verwijdering van een object. - format: date - example: 2019-11-22 - documentnummer: - 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: 19SZ2048 - gebruiksdoelen: - type: array - items: - $ref: '#/components/schemas/GebruiksdoelEnum' - geconstateerd: - type: boolean - description: Indicatie dat een standplaats, ligplaats of verblijfsobject - in de registratie is opgenomen door een feitelijke constatering, zonder - dat er een brondocument aan ten grondslag ligt. Het adresseerbaar object - is mogelijk illegaal. - geometrie: - $ref: '#/components/schemas/PuntOfVlak' - pandIdentificaties: - type: array - description: Identificatie(s) van het pand of de panden waar het verblijfsobject - deel van is. - example: - - "0226100000008856" - items: - type: string - nummeraanduidingIdentificaties: - type: array - description: Identificatie(s) van de hoofd- en nevenadressen van de standplaats, - ligplaats of verblijfsobject. - items: - $ref: '#/components/schemas/NummeraanduidingIdentificatiesArray' - oppervlakte: - type: integer - status: - $ref: '#/components/schemas/AdresseerbaarObjectStatusEnum' - mogelijkOnjuist: - $ref: '#/components/schemas/AdresseerbaarObjectMogelijkOnjuist' - description: Een adresseerbaarobject is een standplaats, ligplaats of verblijfsobject. - AdresseerbaarObjectHal: - allOf: - - $ref: '#/components/schemas/AdresseerbaarObjectHalBasis' - - properties: - _embedded: - $ref: '#/components/schemas/AdresseerbaarObjectEmbedded' - AdresseerbaarObjectHalBasis: - allOf: - - $ref: '#/components/schemas/AdresseerbaarObject' - - properties: - _links: - $ref: '#/components/schemas/AdresseerbaarObjectLinks' - AdresseerbaarObjectMogelijkOnjuist: - type: object - properties: - gebruiksdoelen: - type: boolean - geometrie: - type: boolean - nummeraanduidingIdentificaties: - type: boolean - pandIdentificaties: - type: boolean - oppervlakte: - type: boolean - status: - type: boolean - toelichting: - type: array - items: - type: string - example: Locatie/contour mogelijk onjuist. - description: Wanneer true is de waarde mogelijk onjuist en wordt juistheid op - dit moment onderzocht. Zie toelichting. - AdresseerbaarObjectEmbedded: - type: object - properties: - adressen: - type: array - items: - $ref: '#/components/schemas/AdresHalBasis' - panden: - type: array - items: - $ref: '#/components/schemas/PandHalBasis' - AdresseerbaarObjectLinks: - type: object - properties: - adressen: - type: array - description: Link(s) naar het hoofdadres en waar van toepassing de nevenadressen - van het adresseerbaar object. - items: - $ref: '#/components/schemas/HalLink' - panden: - type: array - description: Link(s) naar het pand of de panden waar het adresseerbaar object - deel van uitmaakt. - items: - $ref: '#/components/schemas/HalLink' - self: - $ref: '#/components/schemas/HalLink' - AdresseerbaarobjectHalCollectie: - type: object - properties: - _embedded: - $ref: '#/components/schemas/AdresseerbaarobjectHalCollectieEmbedded' - _links: - $ref: '#/components/schemas/HalPaginationLinksMetLast' - AdresseerbaarobjectHalCollectieEmbedded: - type: object - properties: - adresseerbareObjecten: - type: array - items: - $ref: '#/components/schemas/AdresseerbaarObjectHal' - AdresseerbaarObjectStatusEnum: - type: string - enum: - - Plaats aangewezen - - Verblijfsobject gevormd - - Verblijfsobject in gebruik (niet ingemeten) - - Verblijfsobject in gebruik - - Verbouwing verblijfsobject - - Verblijfsobject buiten gebruik - GebruiksdoelEnum: - type: string - enum: - - woonfunctie - - bijeenkomstfunctie - - celfunctie - - gezondheidszorgfunctie - - industriefunctie - - kantoorfunctie - - logiesfunctie - - onderwijsfunctie - - sportfunctie - - winkelfunctie - - overige gebruiksfunctie - OpenbareRuimte: - type: object - properties: - identificatie: - type: string - domein: - type: string - description: Het domein waartoe de identificatie behoort. - naam: - title: openbare ruimte naam - type: string - description: De naam die door de gemeente aan een openbare ruimte is gegeven. - example: Laan van de landinrichtingscommissie Duiven-Westervoort - type: - $ref: '#/components/schemas/TypeOpenbareRuimteEnum' - status: - $ref: '#/components/schemas/StatusNaamgevingEnum' - korteNaam: - maxLength: 24 - type: string - description: De officiële openbareruimtenaam of een verkorte versie. Beiden - hebben maximaal 24 tekens. - example: Ln vd l D-Westervoort - geconstateerd: - type: boolean - description: Indicator dat een openbare ruimte in de registratie is opgenomen - door een feitelijke constatering, zonder dat er een brondocument aan ten - grondslag ligt. De openbare ruimte is mogelijk illegaal. - documentdatum: - type: string - description: De vaststellingsdatum van het brondocument dat de basis is - voor opname, wijziging of een verwijdering van een object. - format: date - example: 2010-02-09 - documentnummer: - 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: BAG-21 - woonplaatsIdentificatie: - type: string - description: Een openbare ruimte ligt in een woonplaats. - example: "2096" - mogelijkOnjuist: - $ref: '#/components/schemas/OpenbareRuimteMogelijkOnjuist' - description: Een buitenruimte met een naam die binnen één woonplaats ligt, bijvoorbeeld - een straat of een plein. - OpenbareRuimteMogelijkOnjuist: - type: object - properties: - naam: - type: boolean - korteNaam: - type: boolean - type: - type: boolean - status: - type: boolean - woonplaatsIdentificatie: - type: boolean - toelichting: - type: array - items: - type: string - example: Openbare ruimtenaam komt mogelijk niet overeen met de vermelding - in het straatnaambesluit. - description: Wanneer true is de waarde mogelijk onjuist en wordt juistheid op - dit moment onderzocht. Zie toelichting. - OpenbareRuimteHalBasis: - allOf: - - $ref: '#/components/schemas/OpenbareRuimte' - - properties: - _links: - $ref: '#/components/schemas/OpenbareRuimteLinks' - OpenbareRuimteLinks: - type: object - properties: - self: - $ref: '#/components/schemas/HalLink' - woonplaats: - $ref: '#/components/schemas/HalLink' - Nummeraanduiding: - type: object - properties: - identificatie: - type: string - domein: - type: string - description: Het domein waartoe de identificatie behoort. - huisnummer: - type: integer - description: Nummer dat door de gemeente aan een adresseerbaar object is - gegeven. - example: 1 - huisletter: - type: string - description: Toevoeging aan een huisnummer in de vorm van een letter die - door de gemeente aan een adresseerbaar object is gegeven. - example: A - huisnummertoevoeging: - type: string - description: Toevoeging aan een huisnummer of een combinatie van huisnummer - en huisletter die door de gemeente aan een adresseerbaar object is gegeven. - example: bis - postcode: - type: string - description: Door PostNL vastgestelde code die bij een bepaalde combinatie - van een straatnaam en een huisnummer hoort. - example: 6922KZ - status: - $ref: '#/components/schemas/StatusNaamgevingEnum' - geconstateerd: - type: boolean - description: Indicator dat de nummeraanduiding in de registratie is opgenomen - door een feitelijke constatering, zonder dat er sprake was van een brondocument/vergunning. - De nummeraanduiding is mogelijk illegaal. - documentdatum: - type: string - description: De vaststellingsdatum van het brondocument dat de basis is - voor opname, wijziging of een verwijdering van een object. - format: date - example: 2019-11-25 - documentnummer: - type: string - description: Identificatie van het brondocument dat ten grondslag ligt aan - de opname, mutatie of een verwijdering van gegevens. - example: Duiven 25112019 - woonplaatsIdentificatie: - type: string - description: Een nummeraanduiding ligt in een woonplaats. - example: "2096" - openbareRuimteIdentificatie: - type: string - description: Een nummeraanduiding ligt aan een openbare ruimte. - example: "0226300000136166" - mogelijkOnjuist: - $ref: '#/components/schemas/NummeraanduidingMogelijkOnjuist' - description: Een postcode, huisnummer met mogelijk een huisletter en huisnummertoevoeging - die hoort bij een verblijfsobject, een standplaats of een ligplaats. - NummeraanduidingIdentificatiesArray: - type: object - properties: - nummeraanduidingIdentificatie: - type: string - example: "0226200000038923" - isNevenadres: - type: boolean - NummeraanduidingMogelijkOnjuist: - type: object - properties: - huisnummer: - type: boolean - huisletter: - type: boolean - huisnummertoevoeging: - type: boolean - postcode: - type: boolean - status: - type: boolean - woonplaatsIdentificatie: - type: boolean - openbareRuimteIdentificatie: - type: boolean - toelichting: - type: array - items: - type: string - example: Woonplaats bestaat mogelijk niet. - description: Wanneer true is de waarde mogelijk onjuist en wordt juistheid op - dit moment onderzocht. Zie toelichting. - NummeraanduidingHalBasis: - allOf: - - $ref: '#/components/schemas/Nummeraanduiding' - - properties: - _links: - $ref: '#/components/schemas/NummeraanduidingLinks' - NummeraanduidingLinks: - type: object - properties: - self: - $ref: '#/components/schemas/HalLink' - adres: - $ref: '#/components/schemas/HalLink' - openbareRuimte: - $ref: '#/components/schemas/HalLink' - woonplaats: - $ref: '#/components/schemas/HalLink' - Woonplaats: - type: object - properties: - identificatie: - type: string - domein: - type: string - description: Het domein waartoe de identificatie behoort. - naam: - type: string - description: De naam van de woonplaats. - example: Duiven - status: - $ref: '#/components/schemas/StatusWoonplaatsEnum' - geconstateerd: - type: boolean - description: Indicator dat de woonplaats in de registratie is opgenomen - door een feitelijke constatering, zonder dat er een brondocument aan ten - grondslag ligt. De woonplaats is mogelijk illegaal. - documentdatum: - type: string - description: De vaststellingsdatum van het brondocument dat de basis is - voor opname, wijziging of een verwijdering van een object. - format: date - example: 2009-02-09 - documentnummer: - 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" - mogelijkOnjuist: - $ref: '#/components/schemas/WoonplaatsMogelijkOnjuist' - description: Een woonplaats is een gedeelte van het grondgebied van de gemeente - met een naam. - WoonplaatsMogelijkOnjuist: - type: object - properties: - naam: - type: boolean - geometrie: - type: boolean - status: - type: boolean - toelichting: - type: array - items: - type: string - example: Woonplaats bestaat mogelijk niet. - description: Wanneer true is de waarde mogelijk onjuist en wordt juistheid op - dit moment onderzocht. Zie toelichting. - WoonplaatsHalBasis: - allOf: - - $ref: '#/components/schemas/Woonplaats' - - properties: - _links: - $ref: '#/components/schemas/WoonplaatsLinks' - WoonplaatsHal: - allOf: - - $ref: '#/components/schemas/WoonplaatsHalBasis' - - properties: - _embedded: - $ref: '#/components/schemas/WoonplaatsEmbedded' - WoonplaatsLinks: - type: object - properties: - self: - $ref: '#/components/schemas/HalLink' - WoonplaatsEmbedded: - type: object - properties: - geometrie: - $ref: '#/components/schemas/VlakOfMultivlak' - Pand: - type: object - properties: - identificatie: - type: string - description: De unieke aanduiding van een pand. Elk pand waarvan gegevens - zijn opgenomen in de BAG wordt uniek aangeduid door middel van een identificatiecode. - domein: - type: string - description: Het domein waartoe de identificatie behoort. - geometrie: - $ref: '#/components/schemas/polygonGeoJSON' - oorspronkelijkBouwjaar: - type: integer - description: Het jaar waarin een pand oorspronkelijk als bouwkundig gereed - is opgeleverd. Door de gemeente wordt een inschatting gemaakt van het - bouwjaar, en aangepast als het pand wordt opgeleverd. Wijzigingen aan - een pand na oplevering leiden niet tot wijziging van het bouwjaar. - example: 1991 - status: - $ref: '#/components/schemas/StatusPandEnum' - geconstateerd: - type: boolean - description: Indicatie dat het pand in de registratie is opgenomen door - een feitelijke constatering, zonder dat er sprake was van een brondocument/vergunning. - Het pand is mogelijk illegaal. - documentdatum: - type: string - description: De vaststellingsdatum van het brondocument dat de basis is - voor opname, wijziging of een verwijdering van een object. - format: date - example: 2009-05-12 - documentnummer: - 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.BW.0273 - adresseerbaarObjectIdentificaties: - type: array - example: - - "0226010000038820" - items: - type: string - nummeraanduidingIdentificaties: - type: array - description: Identificatie(s) van de hoofd- en nevenadressen van het pand. - items: - $ref: '#/components/schemas/NummeraanduidingIdentificatiesArray' - mogelijkOnjuist: - $ref: '#/components/schemas/PandMogelijkOnjuist' - description: Een pand is een bouwkundige, constructief zelfstandige eenheid - die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar - is. - PandMogelijkOnjuist: - type: object - properties: - geometrie: - type: boolean - oorspronkelijkBouwjaar: - type: boolean - status: - type: boolean - toelichting: - type: array - items: - type: string - example: Mogelijk is de bouw al gereed of is het pand niet gerealiseerd. - description: Wanneer true is de waarde mogelijk onjuist en wordt juistheid op - dit moment onderzocht. Zie toelichting. - PandHalBasis: - allOf: - - $ref: '#/components/schemas/Pand' - - properties: - _links: - $ref: '#/components/schemas/PandLinks' - PandLinks: - type: object - properties: - self: - $ref: '#/components/schemas/HalLink' - adressen: - type: array - items: - $ref: '#/components/schemas/HalLink' - adresseerbareObjecten: - type: array - items: - $ref: '#/components/schemas/HalLink' - PandHalCollectie: - type: object - properties: - _links: - $ref: '#/components/schemas/HalPaginationLinksMetLast' - _embedded: - $ref: '#/components/schemas/PandHalCollectieEmbedded' - PandHalCollectieEmbedded: - type: object - properties: - panden: - type: array - items: - $ref: '#/components/schemas/PandHalBasis' - StatusNaamgevingEnum: - type: string - description: Een aanduiding van alle waarden die de status van een openbare - ruimte of een nummeraanduiding kan aannemen. - enum: - - Naamgeving uitgegeven - StatusPandEnum: - type: string - enum: - - Bouwvergunning verleend - - Bouw gestart - - Pand in gebruik (niet ingemeten) - - Pand in gebruik - - Verbouwing pand - - Sloopvergunning verleend - - Pand buiten gebruik - StatusWoonplaatsEnum: - type: string - description: Een aanduiding van alle waarden die de status van een woonplaats - kan aannemen. - enum: - - Woonplaats aangewezen - TypeAdresseerbaarObjectEnum: - type: string - enum: - - verblijfsobject - - standplaats - - ligplaats - TypeOpenbareRuimteEnum: - type: string - description: Een codering van de verschillende waarden die de typering van een - openbare ruimte kan aannemen. - enum: - - Weg - - Water - - Spoorbaan - - Terrein - - Kunstwerk - - Landschappelijk gebied - - Administratief gebied - PuntOfVlak: - type: object - properties: - punt: - $ref: '#/components/schemas/pointGeoJSON' - vlak: - $ref: '#/components/schemas/polygonGeoJSON' - description: Een samengesteld geometriegegevenstype waarbij wordt afgedwongen - dat voor de geometrie een keuze gemaakt moet worden tussen een punt of een - vlak. - VlakOfMultivlak: - type: object - properties: - vlak: - $ref: '#/components/schemas/polygonGeoJSON' - multivlak: - $ref: '#/components/schemas/multipolygonGeoJSON' - description: Een samengesteld geometriegegevenstype waarbij wordt afgedwongen - dat voor de geometrie een keuze gemaakt moet worden tussen een vlak (GM_Surface) - of een multivlak (GM_MultiSurface). - BadRequestFoutbericht: - allOf: - - $ref: '#/components/schemas/Foutbericht' - - type: object - properties: - invalidParams: - type: array - description: Foutmelding per fout in een parameter. Alle gevonden fouten - worden één keer teruggemeld. - items: - $ref: '#/components/schemas/InvalidParams' - Foutbericht: - type: object - properties: - type: - type: string - description: Link naar meer informatie over deze fout - format: uri - title: - type: string - description: Beschrijving van de fout - status: - type: integer - description: Http status code - detail: - type: string - description: Details over de fout - instance: - type: string - description: Uri van de aanroep die de fout heeft veroorzaakt - format: uri - code: - minLength: 1 - type: string - description: Systeemcode die het type fout aangeeft - description: Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807). - InvalidParams: - type: object - properties: - type: - type: string - format: uri - example: https://www.vng.nl/realisatie/api/{major-versie}/validaties/integer - name: - type: string - description: Naam van de parameter - example: verblijfplaats__huisnummer - code: - minLength: 1 - type: string - description: Systeemcode die het type fout aangeeft - example: integer - reason: - type: string - description: Beschrijving van de fout op de parameterwaarde - example: Waarde is geen geldige integer. - description: Details over fouten in opgegeven parameters - CrsEnum: - type: string - description: CRS van geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel. - default: epsg:28992 - enum: - - epsg:28992 - HalLink: - required: - - href - type: object - properties: - href: - $ref: '#/components/schemas/Href' - templated: - type: boolean - title: - type: string - description: Voor mens leesbaar label bij de link - description: De Link Object zoals gespecificeerd in https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5; - Deze link kan als templated link worden aangeboden. [URI-templating is hier - beschreven](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/uri-templating.feature). - Href: - type: string - example: https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie} - HalPaginationLinksMetLast: - description: | - HalPaginationLinksMetLast bevat de link properties die nodig zijn om te kunnen navigeren in een eindige collectie: - - - first: uri voor het opvragen van de eerste pagina van deze collectie - - previous: uri voor het opvragen van de vorige pagina van deze collectie - - next: uri voor het opvragen van de volgende pagina van deze collectie - - last: uri voor het opvragen van de laatste pagina van deze collectie - example: - self: - href: /resourcenaam?page=4 - 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=8 - title: Laatste pagina - allOf: - - $ref: '#/components/schemas/HalPaginationLinks' - - type: object - properties: - last: - $ref: '#/components/schemas/HalLink' - HalPaginationLinks: - description: | - HalPaginationLinks bevat de link properties die nodig zijn om te kunnen navigeren in een collectie: - - - first: uri voor het opvragen van de eerste pagina van deze collectie - - previous: uri voor het opvragen van de vorige pagina van deze collectie - - next: uri voor het opvragen van de volgende pagina van deze collectie - example: - self: - href: /resourcenaam?page=4 - first: - href: /resourcenaam?page=1 - title: Eerste pagina - previous: - href: /resourcenaam?page=3 - title: Vorige pagina - next: - href: /resourcenaam?page=5 - title: Volgende pagina - allOf: - - $ref: '#/components/schemas/HalCollectionLinks' - - type: object - properties: - first: - $ref: '#/components/schemas/HalLink' - previous: - $ref: '#/components/schemas/HalLink' - next: - $ref: '#/components/schemas/HalLink' - HalCollectionLinks: - type: object - properties: - self: - $ref: '#/components/schemas/HalLink' - description: | - HalCollectionLinks bevat de self link die elke HAL Resource minimaal moet hebben in zijn _links property - polygonGeoJSON: - 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 - pointGeoJSON: - required: - - coordinates - - type - type: object - properties: - type: - type: string - enum: - - Point - coordinates: - minItems: 2 - type: array - items: - type: number - multipolygonGeoJSON: - required: - - coordinates - - type - type: object - properties: - type: - type: string - enum: - - MultiPolygon - coordinates: - type: array - items: - type: array - items: - minItems: 4 - type: array - items: - minItems: 2 - type: array - items: - type: number - parameters: - zoek: - name: zoek - in: query - description: Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, - huisnummertoevoeging. - required: true - style: form - explode: true - schema: - type: string - q: - name: q - in: query - description: Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, - huisnummertoevoeging. - required: false - style: form - explode: true - schema: - maxLength: 255 - minLength: 1 - type: string - zoekresultaatIdentificatie: - name: zoekresultaatIdentificatie - in: query - description: De identificatie van een zoekresultaat van het endpoint get /adressen/zoek. - required: false - deprecated: true - style: form - explode: true - schema: - type: string - locatie-query: - name: locatie - in: query - description: Coördinaten van een locatie die als query-parameter gebruikt wordt - om een object te zoeken. Let op, explode is false dus het formaat is ?locatie=196733.51,439931.89 - required: false - style: form - explode: false - schema: - maxItems: 2 - minItems: 2 - type: array - example: - - 196733.51 - - 439931.89 - items: - type: number - nummeraanduidingIdentificatie-query: - name: nummeraanduidingIdentificatie - in: query - description: Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers - lang. - required: false - style: form - explode: true - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226200000038923" - pandIdentificatie-query: - name: pandIdentificatie - in: query - description: Identificatie van een pand uit de BAG. Deze is 16 cijfers lang. - required: false - style: form - explode: true - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226100000008856" - deprecated-pandIdentificatie-query: - name: pandIdentificatie - in: query - description: Identificatie van een pand uit de BAG. Deze is 16 cijfers lang. - required: false - deprecated: true - style: form - explode: true - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226100000008856" - adresseerbaarObjectIdentificatie-query: - name: adresseerbaarObjectIdentificatie - in: query - description: De identificatie van een adresseerbaar object uit de BAG. Deze - is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats - zijn. - required: false - style: form - explode: true - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226010000038820" - postcode: - name: postcode - in: query - description: Postcode van het adres. - 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 - huisnummer: - name: huisnummer - in: query - description: Huisnummer van het adres. - required: false - style: form - explode: true - schema: - maximum: 99999 - minimum: 1 - type: integer - example: 1 - huisnummertoevoeging: - name: huisnummertoevoeging - in: query - description: 'Een toevoeging (in de vorm van maximaal 4 cijfers of letters) - aan een huisnummer of een combinatie van huisnummer en huisletter van het - adres. Bijvoorbeeld: Bij het adres: Belgiëlaan 1 A2, 2391 PH HAZERSWOUDE-DORP, - is 1 het huisnummer, A de huisletter en 2 de huisnummertoevoeging.' - required: false - style: form - explode: true - schema: - pattern: ^[0-9a-zA-Z]{1,4}$ - type: string - example: bis - huisletter: - name: huisletter - in: query - description: 'Een toevoeging (in de vorm van een letter) aan een huisnummer - van het adres. Bijvoorbeeld: Bij adres: Belgiëlaan 1 A2, 2391 PH HAZERSWOUDE-DORP, - is 1 het huisnummer en A de huisletter.' - required: false - style: form - explode: true - schema: - pattern: ^[a-zA-Z]{1}$ - type: string - example: A - exacteMatch: - name: exacteMatch - in: query - description: Geeft aan of de resultaten van de zoekopdracht exact overeen moeten - komen met de opgegeven parameters, zie [functionele specificatie exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature). - required: false - style: form - explode: true - schema: - type: boolean - example: true - default: false - pandIdentificaties: - name: pandIdentificaties - in: query - description: Een lijst met identificaties van panden uit de BAG. - required: false - style: form - explode: false - schema: - minItems: 1 - type: array - example: - - "0226100000008856" - items: - pattern: ^[0-9]{16}$ - type: string - geconstateerd: - name: geconstateerd - in: query - description: Geeft aan of naar geconstateerde objecten moet worden gezocht. - required: false - style: form - explode: true - schema: - type: boolean - statusPand: - name: statusPand - in: query - description: Status van het pand. - required: false - style: form - explode: true - schema: - minItems: 1 - type: array - items: - $ref: '#/components/schemas/StatusPandEnum' - bouwjaar: - name: bouwjaar - in: query - description: 'Bouwjaar van het pand. Geeft het minimale en/of maximale bouwjaar - aan van het pand waarnaar moet worden gezocht. Een bouwjaar is een natuurlijk - getal tussen 0 (minimaal) en 9999 (maximaal). Bv: bouwjaar[min]=1970&bouwjaar[max]=2010' - required: false - style: deepObject - explode: true - schema: - $ref: '#/components/schemas/BouwjaarFilter' - type: - name: type - in: query - description: Geeft aan of het adresseerbaar object een ligplaats, standplaats - of verblijfsobject is. - required: false - style: form - explode: true - schema: - $ref: '#/components/schemas/TypeAdresseerbaarObjectEnum' - gebruiksdoelen: - name: gebruiksdoelen - in: query - description: De gebruiksdoelen van het verblijfsobject zoals in de vergunning - is opgenomen of bij constatering is vastgesteld. Als een verblijfsobject één - van de gebruiksdoelen in deze lijst heeft, dan wordt het verblijfsobject in - het zoekresultaat meegenomen. - required: false - style: form - explode: true - schema: - minItems: 1 - type: array - items: - $ref: '#/components/schemas/GebruiksdoelEnum' - oppervlakte: - name: oppervlakte - in: query - description: 'Geef de minimale en maximale oppervlakte op waarbinnen je wilt - zoeken (in m2). Alleen verblijfsobjecten hebben een oppervlakte en kunnen - met deze parameter worden gevonden. Ligplaatsen en standplaatsen hebben geen - oppervlakte en kunnen met deze parameter niet worden gevonden. De oppervlakte - van een verblijfsobject is een natuurlijk getal tussen 1 (minimaal) en 999999 - (maximaal). Het is niet toegestaan voor min een grotere waarde op te geven - dan voor max. Is min > max dan treedt een foutmelding op. Bv: oppervlakte[min]=100&oppervlakte[max]=200' - required: false - style: deepObject - explode: true - schema: - $ref: '#/components/schemas/OppervlakteFilter' - bbox: - name: bbox - in: query - description: Rechthoek waarbinnen het object dat je zoekt valt. Objecten die - de rand van de rechthoek raken of kruisen worden in het zoekresultaat meegenomen. - Voor 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). - In tegenstelling tot wat er in de OGC API Features specificatie staat, wordt - hier geen bbox-crs parameter maar de contentCrs parameter gebruikt om aan - te geven in welk CRS de coördinaten van de bbox zijn. Daarnaast kan er alleen - met 2D coördinaten worden gezocht. De oppervlakte van de bounding box mag - maximaal 250 duizend vierkante meter zijn. - 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 - nummeraanduidingidentificatie: - name: nummeraanduidingidentificatie - in: path - description: Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers - lang. - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226200000038923" - adresseerbaarobjectidentificatie: - name: adresseerbaarobjectidentificatie - in: path - description: De identificatie van een adresserbaar object uit de BAG. Deze is - 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats - zijn. - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226010000038820" - pandidentificatie: - name: pandidentificatie - in: path - description: Identificatie van een pand uit de BAG. Deze is 16 cijfers lang. - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226100000008856" - woonplaatsidentificatie: - name: woonplaatsidentificatie - in: path - description: De identificatie van een woonplaats. - required: true - style: simple - explode: false - schema: - 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: 'Deze wordt gebruikt in de operation, bv. /woonplaatsen/0123. - Waarde: 0001-9999.' - example: "2096" - openbareruimteidentificatie: - name: openbareruimteidentificatie - in: path - description: Identificatie van een object uit de BAG. Deze is 16 cijfers lang. - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{16}$ - type: string - example: "0226300000136166" - headers: - api_version: - schema: - type: string - description: Geeft een specifieke API-versie aan in de context van een specifieke - aanroep. - example: 1.0.0 - warning: - schema: - type: string - description: zie RFC 7234. In het geval een major versie wordt uitgefaseerd, - gebruiken we warn-code 299 ("Miscellaneous Persistent Warning") en het API - end-point (inclusief versienummer) als de warn-agent van de warning, gevolgd - door de warn-text met de human-readable waarschuwing - example: '299 https://service.../api/.../v1 "Deze versie van de API is verouderd - en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie - hier de documentatie: https://omgevingswet.../api/.../v1".' - X_Pagination_Page: - schema: - type: integer - description: Huidige pagina. - example: 3 - X_Pagination_Limit: - schema: - type: integer - description: Aantal resultaten per pagina. - example: 20 - contentCrs: - description: CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New - Nederlands coordinatenstelsel. - schema: - $ref: '#/components/schemas/CrsEnum' - securitySchemes: - apiKeyBAG: - type: apiKey - description: De API-key die je hebt gekregen dient bij elke request via de `X-Api-Key` - request header meegestuurd te worden. Indien deze niet juist wordt meegestuurd, - of het een ongeldige key betreft, zul je de foutmelding `403 Forbidden` terugkrijgen. - name: X-Api-Key - in: header diff --git a/specificatie/openapi.yaml b/specificatie/openapi.yaml deleted file mode 100644 index 219f6fc..0000000 --- a/specificatie/openapi.yaml +++ /dev/null @@ -1,1675 +0,0 @@ -openapi: 3.0.0 - -# Server specificatie -servers: - - description: LVBAG - ACCEPTATIE - url: https://api.bag.acceptatie.kadaster.nl/esd/huidigebevragingen/v1 - - description: LVBAG - PRODUCTIE - url: https://api.bag.kadaster.nl/esd/huidigebevragingen/v1 - -# API specificatie - algemeen -info: - title: Huidige bevragingen API - description: "Deze API levert actuele gegevens over adressen, adresseerbare objecten en panden. Actueel betekent in deze API `zonder eindstatus`. De bron voor deze API is de basisregistratie adressen en gebouwen (BAG)." - version: "1.5.0" - termsOfService: https://zakelijk.kadaster.nl/algemene-voorwaarden - contact: - name: Kadaster - Beheerder Landelijke Voorziening BAG - email: bag@kadaster.nl - 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/ - -security: - - apiKeyBAG: [] - -paths: - - /adressen/zoek: - get: - deprecated: true - security: - - apiKeyBAG: [] - operationId: zoek - tags: - - Adres - summary: '"fuzzy" zoeken van adressen' - description: "Free query zoeken van adressen met postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging. Delen van de adressen in het antwoord matchen exact met jouw invoer. Je vindt een adres door de zoekresultaatidentificatie uit het antwoord te gebruiken in get/adressen" - parameters: - - $ref: '#/components/parameters/zoek' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/page' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/pageSize' - responses: - '200': - description: "Geslaagd" - headers: - api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/api_version' - warning: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/warning' - X-Pagination-Page: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/X_Pagination_Page' - X-Pagination-Limit: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/X_Pagination_Limit' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/ZoekResultaatHalCollectie' - '400': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/400' - '401': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/401' - '403': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/403' - '406': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/406' - '500': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/500' - '503': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/503' - default: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' - - /adressen: - get: - security: - - apiKeyBAG: [] - operationId: raadpleegAdressen - tags: - - Adres - summary: "vindt adressen" - description: >- - Vind een actueel adres met: - - 1. Een pandidentificatie of - - 2. Een adresseerbaarobjectidentificatie of - - 3. Een postcode, huisnummer en optioneel huisletter, huisnummertoevoeging en/of exacteMatch. - - 4. Een zoekterm. - - - Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, - zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). - - Gebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources nummeraanduiding, woonplaats en openbare ruimte, - zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). - - Gebruik de exacteMatch parameter als je alleen resultaten wilt ontvangen die exact overeenkomen met de opgegeven zoek criteria, - zie [functionele specificaties exacteMatch-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/blob/v1.2.0/features/exacte_match.feature). - Je kunt adresseerbare objecten niet expanden als je tegelijkertijd de query parameter adresseerbaarObjectIdentificatie gebruikt. - parameters: - - $ref: '#/components/parameters/pandIdentificatie-query' - - $ref: '#/components/parameters/adresseerbaarObjectIdentificatie-query' - - $ref: '#/components/parameters/zoekresultaatIdentificatie' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/expand' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/fields' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/page' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/pageSize' - - $ref: '#/components/parameters/postcode' - - $ref: '#/components/parameters/huisnummer' - - $ref: '#/components/parameters/huisletter' - - $ref: '#/components/parameters/huisnummertoevoeging' - - $ref: '#/components/parameters/exacteMatch' - - $ref: '#/components/parameters/q' - responses: - '200': - description: "Geslaagd" - headers: - api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/api_version' - warning: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/warning' - X-Pagination-Page: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/X_Pagination_Page' - X-Pagination-Limit: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/X_Pagination_Limit' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/AdresHalCollectie' - '400': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/400' - '401': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/401' - '403': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/403' - '406': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/406' - '500': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/500' - '503': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/503' - default: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' - - /adressen/{nummeraanduidingidentificatie}: - get: - security: - - apiKeyBAG: [] - operationId: raadpleegAdresMetNumId - tags: - - Adres - summary: "levert een adres" - description: >- - Raadpleeg een actueel adres met de nummeraanduidingidentificatie. - - Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, - zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). - - Gebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources nummeraanduiding, woonplaats, openbare ruimte, adresseerbaarobject, - zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). - parameters: - - $ref: '#/components/parameters/nummeraanduidingidentificatie' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/expand' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/fields' - responses: - '200': - description: "Geslaagd" - headers: - api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/api_version' - warning: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/warning' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/AdresHal' - '400': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/400' - '401': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/401' - '403': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/403' - '404': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/404' - '406': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/406' - '500': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/500' - '503': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/503' - default: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' - - /adresseerbareobjecten/{adresseerbaarobjectidentificatie}: - get: - security: - - apiKeyBAG: [] - operationId: raadpleegAdresseerbaarobject - tags: - - Adresseerbaar object - summary: "levert een verblijfsobject, standplaats of ligplaats" - description: "Raadpleeg een actueel adresseerbaar object met de identificatie. Dit is de identificatie van een verblijfsobject, ligplaats of standplaats. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). Gebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources adres en pand, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature)." - parameters: - - $ref: '#/components/parameters/adresseerbaarobjectidentificatie' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/expand' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/fields' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/acceptCrs' - responses: - '200': - description: "Geslaagd" - headers: - api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/api_version' - warning: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/warning' - Content-Crs: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/contentCrs' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/AdresseerbaarObjectHal' - '400': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/400' - '401': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/401' - '403': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/403' - '404': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/404' - '406': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/406' - '412': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/412' - '500': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/500' - '503': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/503' - default: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' - - /adresseerbareobjecten: - get: - security: - - apiKeyBAG: [] - operationId: raadpleegAdresseerbareobjecten - tags: - - Adresseerbaar object - summary: "vindt verblijfsobjecten, ligplaatsen, standplaatsen" - description: >- - Zoek actuele adresseerbare objecten (verblijfsobjecten, standplaatsen of ligplaatsen) met: - - 1. een nummeraanduidingidentificatie of - - 2. een pandidentificatie of - - 3. een lijst met pandidentificaties of - - 4. een geometrische contour (rechthoek) in combinatie met status geconstateerd, oppervlakte, gebruiksdoel en/of type. - - - Het zoeken van adresseerbare objecten met een oppervlakte en een type=ligplaats of type=standplaats wordt niet ondersteund en levert een foutmelding. - - Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie - [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). - - Gebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources adres en pand, zie - [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). - Je kunt panden niet expanden als je tegelijkertijd de query parameter pandIdentificatie(s) gebruikt. - parameters: - - $ref: '#/components/parameters/nummeraanduidingIdentificatie-query' - - $ref: '#/components/parameters/deprecated-pandIdentificatie-query' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/expand' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/fields' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/acceptCrs' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/page' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/pageSize' - - $ref: '#/components/parameters/pandIdentificaties' - - $ref: '#/components/parameters/geconstateerd' - - $ref: '#/components/parameters/type' - - $ref: '#/components/parameters/gebruiksdoelen' - - $ref: '#/components/parameters/bbox' - - $ref: '#/components/parameters/oppervlakte' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/contentCrs' - responses: - '200': - description: "Geslaagd" - headers: - api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/api_version' - warning: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/warning' - X-Pagination-Page: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/X_Pagination_Page' - X-Pagination-Limit: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/X_Pagination_Limit' - Content-Crs: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/contentCrs' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/AdresseerbaarobjectHalCollectie' - '400': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/400' - '401': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/401' - '403': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/403' - '406': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/406' - '412': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/412' - '500': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/500' - '503': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/503' - default: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' - - /woonplaatsen/{woonplaatsidentificatie}: - get: - security: - - apiKeyBAG: [] - operationId: raadpleegWoonplaats - tags: - - Adres - summary: "levert BAG details van een woonplaats" - description: "Raadpleeg een actuele woonplaats met de identificatie. Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). Gebruik de expand-parameter als je het antwoord wil uitbreiden met de gerelateerde resource geometrie, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature)." - parameters: - - $ref: '#/components/parameters/woonplaatsidentificatie' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/expand' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/fields' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/acceptCrs' - responses: - '200': - description: "Geslaagd" - headers: - api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/api_version' - warning: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/warning' - Content-Crs: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/contentCrs' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/WoonplaatsHal' - '400': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/400' - '401': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/401' - '403': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/403' - '404': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/404' - '406': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/406' - '412': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/412' - '500': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/500' - '503': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/503' - default: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' - - /openbareruimten/{openbareruimteidentificatie}: - get: - security: - - apiKeyBAG: [] - operationId: raadpleegOpenbareRuimte - tags: - - Adres - summary: "levert BAG detals van een openbare ruimte" - description: "Raadpleeg een actuele openbare ruimte met de identificatie. Een openbare ruimte is een buitenruimte met een naam die binnen één woonplaats ligt, bijvoorbeeld een straat of een plein. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature)." - parameters: - - $ref: '#/components/parameters/openbareruimteidentificatie' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/fields' - responses: - '200': - description: "Geslaagd" - headers: - api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/api_version' - warning: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/warning' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/OpenbareRuimteHalBasis' - '400': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/400' - '401': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/401' - '403': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/403' - '404': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/404' - '406': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/406' - '500': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/500' - '503': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/503' - default: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' - - /nummeraanduidingen/{nummeraanduidingidentificatie}: - get: - security: - - apiKeyBAG: [] - operationId: raadpleegNummeraanduiding - tags: - - Adres - summary: "levert BAG details van een nummeraanduiding" - description: "Raadpleeg een actuele nummeraanduiding met de identificatie. Een nummeraanduiding is een postcode, huisnummer met evt een huisletter en huisnummertoevoeging die hoort bij een verblijfsobject, een standplaats of een ligplaats. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature)." - parameters: - - $ref: '#/components/parameters/nummeraanduidingidentificatie' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/fields' - responses: - '200': - description: "Geslaagd" - headers: - api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/api_version' - warning: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/warning' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/NummeraanduidingHalBasis' - '400': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/400' - '401': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/401' - '403': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/403' - '404': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/404' - '406': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/406' - '500': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/500' - '503': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/503' - default: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' - - /panden/{pandidentificatie}: - get: - security: - - apiKeyBAG: [] - operationId: raadpleegPand - tags: - - Pand - summary: "levert een pand" - description: "Raadpleeg een actueel pand met de identificatie. Een pand is een bouwkundige, constructief zelfstandige eenheid die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar is. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature)." - parameters: - - $ref: '#/components/parameters/pandidentificatie' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/fields' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/acceptCrs' - responses: - '200': - description: "Geslaagd" - headers: - api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/api_version' - warning: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/warning' - Content-Crs: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/contentCrs' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/PandHalBasis' - '400': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/400' - '401': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/401' - '403': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/403' - '404': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/404' - '406': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/406' - '412': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/412' - '500': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/500' - '503': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/503' - default: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' - - /panden: - get: - security: - - apiKeyBAG: [] - operationId: raadpleegPanden - tags: - - Pand - summary: "vindt panden" - description: >- - Zoek actuele panden: - - 1. met de identificatie van een adresseerbaar object of - - 2. met de identificatie van een nummeraanduiding of - - 3. met een locatie (punt) of - - 4. binnen een geometrische contour (rechthoek) die voldoen aan de opgegeven status, geconstateerd of bouwjaar. - - - Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie - [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). - parameters: - - $ref: '#/components/parameters/adresseerbaarObjectIdentificatie-query' - - $ref: '#/components/parameters/nummeraanduidingIdentificatie-query' - - $ref: '#/components/parameters/locatie-query' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/fields' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/acceptCrs' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/contentCrs' - - $ref: '#/components/parameters/bbox' - - $ref: '#/components/parameters/statusPand' - - $ref: '#/components/parameters/geconstateerd' - - $ref: '#/components/parameters/bouwjaar' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/page' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/parameters/pageSize' - responses: - '200': - description: "Geslaagd" - headers: - api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/api_version' - warning: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/warning' - X-Pagination-Page: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/X_Pagination_Page' - X-Pagination-Limit: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/X_Pagination_Limit' - Content-Crs: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/headers/contentCrs' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/PandHalCollectie' - '400': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/400' - '401': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/401' - '403': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/403' - '406': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/406' - '412': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/412' - '500': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/500' - '503': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/503' - default: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' - -components: - - securitySchemes: - - apiKeyBAG: - type: apiKey - name: X-Api-Key - in: header - description: "De API-key die je hebt gekregen dient bij elke request via de `X-Api-Key` request header meegestuurd te worden. Indien deze niet juist wordt meegestuurd, of het een ongeldige key betreft, zul je de foutmelding `403 Forbidden` terugkrijgen." - - parameters: - - # Opsomming van request parameters - ?='...' parameters (by name) - specificatie bij operation zelf. - zoek: - description: "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging." - name: zoek - in: query - required: true - schema: - type: string - - q: - description: "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging." - name: q - in: query - required: false - schema: - type: string - minLength: 1 - maxLength: 255 - - zoekresultaatIdentificatie: - deprecated: true - description: "De identificatie van een zoekresultaat van het endpoint get /adressen/zoek." - name: zoekresultaatIdentificatie - in: query - required: false - schema: - type: string - - locatie-query: - description: >- - Coördinaten van een locatie die als query-parameter gebruikt wordt om een object te zoeken. - Let op, explode is false dus het formaat is ?locatie=196733.51,439931.89 - name: locatie - in: query - required: false - explode: false - schema: - type: array - minItems: 2 - maxItems: 2 - items: - type: number - example: [196733.51, 439931.89] - - nummeraanduidingIdentificatie-query: - description: "Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - name: nummeraanduidingIdentificatie - in: query - required: false - schema: - type: string - pattern: '^[0-9]{16}$' - example: '0226200000038923' - - pandIdentificatie-query: - description: "Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - name: pandIdentificatie - in: query - required: false - schema: - type: string - pattern: '^[0-9]{16}$' - example: '0226100000008856' - - deprecated-pandIdentificatie-query: - deprecated: true - description: "Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - name: pandIdentificatie - in: query - required: false - schema: - type: string - pattern: '^[0-9]{16}$' - example: '0226100000008856' - - adresseerbaarObjectIdentificatie-query: - description: "De identificatie van een adresseerbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - name: adresseerbaarObjectIdentificatie - in: query - required: false - schema: - type: string - pattern: '^[0-9]{16}$' - example: '0226010000038820' - - postcode: - description: "Postcode van het adres." - name: postcode - in: query - required: false - schema: - type: string - pattern: '^[1-9]{1}[0-9]{3}[ ]{0,1}[a-zA-Z]{2}$' - examples: - zonderSpatie: - value: '6922KZ' - metSpatie: - value: '6922 KZ' - - huisnummer: - description: "Huisnummer van het adres." - name: huisnummer - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 99999 - example: 1 - - huisnummertoevoeging: - description: >- - Een toevoeging (in de vorm van maximaal 4 cijfers of letters) aan een huisnummer of een combinatie van huisnummer en huisletter van het adres. - Bijvoorbeeld: - Bij het adres: Belgiëlaan 1 A2, 2391 PH HAZERSWOUDE-DORP, is 1 het huisnummer, A de huisletter en 2 de huisnummertoevoeging. - name: huisnummertoevoeging - in: query - required: false - schema: - type: string - pattern: '^[0-9a-zA-Z]{1,4}$' - example: 'bis' - - huisletter: - description: >- - Een toevoeging (in de vorm van een letter) aan een huisnummer van het adres. - Bijvoorbeeld: - Bij adres: Belgiëlaan 1 A2, 2391 PH HAZERSWOUDE-DORP, is 1 het huisnummer en A de huisletter. - name: huisletter - in: query - required: false - schema: - type: string - pattern: '^[a-zA-Z]{1}$' - example: 'A' - - exacteMatch: - description: >- - Geeft aan of de resultaten van de zoekopdracht exact overeen moeten komen met de opgegeven parameters, - zie [functionele specificatie exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature). - name: exacteMatch - in: query - required: false - schema: - type: boolean - example: true - default: false - - pandIdentificaties: - description: "Een lijst met identificaties van panden uit de BAG." - name: pandIdentificaties - in: query - required: false - schema: - type: array - minItems: 1 - items: - type: string - pattern: '^[0-9]{16}$' - example: ['0226100000008856'] - explode: false - - geconstateerd: - description: 'Geeft aan of naar geconstateerde objecten moet worden gezocht.' - name: geconstateerd - in: query - required: false - schema: - type: boolean - - statusPand: - description: "Status van het pand." - name: statusPand - in: query - required: false - schema: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/StatusPandEnum' - - bouwjaar: - description: >- - Bouwjaar van het pand. - Geeft het minimale en/of maximale bouwjaar aan van het pand waarnaar moet worden gezocht. - Een bouwjaar is een natuurlijk getal tussen 0 (minimaal) en 9999 (maximaal). - Bv: bouwjaar[min]=1970&bouwjaar[max]=2010 - name: bouwjaar - in: query - required: false - schema: - $ref: '#/components/schemas/BouwjaarFilter' - explode: true - style: deepObject - - type: - description: "Geeft aan of het adresseerbaar object een ligplaats, standplaats of verblijfsobject is." - name: type - in: query - required: false - schema: - $ref: '#/components/schemas/TypeAdresseerbaarObjectEnum' - - gebruiksdoelen: - description: >- - De gebruiksdoelen van het verblijfsobject zoals in de vergunning is opgenomen of bij constatering is vastgesteld. - Als een verblijfsobject één van de gebruiksdoelen in deze lijst heeft, dan wordt het verblijfsobject in het zoekresultaat meegenomen. - name: gebruiksdoelen - in: query - required: false - schema: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/GebruiksdoelEnum' - - oppervlakte: - name: oppervlakte - description: >- - Geef de minimale en maximale oppervlakte op waarbinnen je wilt zoeken (in m2). - Alleen verblijfsobjecten hebben een oppervlakte en kunnen met deze parameter worden gevonden. - Ligplaatsen en standplaatsen hebben geen oppervlakte en kunnen met deze parameter niet worden gevonden. - De oppervlakte van een verblijfsobject is een natuurlijk getal tussen 1 (minimaal) en 999999 (maximaal). - Het is niet toegestaan voor min een grotere waarde op te geven dan voor max. - Is min > max dan treedt een foutmelding op. - Bv: oppervlakte[min]=100&oppervlakte[max]=200 - in: query - required: false - schema: - $ref: '#/components/schemas/OppervlakteFilter' - style: deepObject - explode: true - - bbox: - description: >- - Rechthoek waarbinnen het object dat je zoekt valt. - Objecten die de rand van de rechthoek raken of kruisen worden in het zoekresultaat meegenomen. - Voor 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). - In tegenstelling tot wat er in de OGC API Features specificatie staat, wordt hier geen bbox-crs parameter maar de contentCrs parameter gebruikt om aan te geven in welk CRS de coördinaten van de bbox zijn. - Daarnaast kan er alleen met 2D coördinaten worden gezocht. - De oppervlakte van de bounding box mag maximaal 250 duizend vierkante meter zijn. - name: bbox - in: query - required: false - schema: - type: array - minItems: 4 - maxItems: 4 - items: - type: number - example: [196733.510, 439931.890, 196833.510, 440031.890] - explode: false - - # Opsomming van path parameters - /{...} - specificatie bij operation zelf. - nummeraanduidingidentificatie: - description: "Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - name: nummeraanduidingidentificatie - in: path - required: true - schema: - type: string - pattern: '^[0-9]{16}$' - example: '0226200000038923' - - adresseerbaarobjectidentificatie: - description: "De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - name: adresseerbaarobjectidentificatie - in: path - required: true - schema: - type: string - pattern: '^[0-9]{16}$' - example: '0226010000038820' - - pandidentificatie: - description: "Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - name: pandidentificatie - in: path - required: true - schema: - type: string - pattern: '^[0-9]{16}$' - example: '0226100000008856' - - woonplaatsidentificatie: - description: "De identificatie van een woonplaats." - name: woonplaatsidentificatie - in: path - required: true - schema: - description: "Deze wordt gebruikt in de operation, bv. /woonplaatsen/0123. Waarde: 0001-9999." - type: string - 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}$' - example: '2096' - - openbareruimteidentificatie: - description: "Identificatie van een object uit de BAG. Deze is 16 cijfers lang." - name: openbareruimteidentificatie - in: path - required: true - schema: - type: string - pattern: '^[0-9]{16}$' - example: '0226300000136166' - - schemas: - - ZoekResultaat: - deprecated: true - type: object - description: "Resultaat van een zoekoperatie dat je kunt gebruiken om een adres te vinden met /adressen." - properties: - omschrijving: - description: "Omschrijving van het zoekresultaat" - type: string - identificatie: - description: "Identificatie van het zoekresultaat" - type: string - - ZoekResultaatHal: - deprecated: true - allOf: - - $ref: '#/components/schemas/ZoekResultaat' - - properties: - _links: - $ref: '#/components/schemas/ZoekResultaatLinks' - ZoekResultaatLinks: - deprecated: true - type: object - properties: - adres: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - ZoekResultaatHalCollectie: - deprecated: true - type: object - description: "Resultaten als lijst." - properties: - _links: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalPaginationLinksMetLast' - _embedded: - $ref: '#/components/schemas/ZoekResultaatHalCollectieEmbedded' - ZoekResultaatHalCollectieEmbedded: - deprecated: true - type: object - properties: - zoekresultaten: - type: array - items: - $ref: '#/components/schemas/ZoekResultaatHal' - - BouwjaarFilter: - type: object - description: | - "Zoek binnen een bereik van de opgegeven minimumwaarde tot maximumwaarde. - De opgegeven minimumwaarde moet lager zijn dan de opgegeven maximumwaarde." - properties: - min: - type: integer - minimum: 0 - maximum: 9999 - description: "Zoek naar waarden groter of gelijk aan de opgegeven waarde." - max: - type: integer - minimum: 0 - maximum: 9999 - description: "Zoek naar waarden kleiner dan de opgegeven waarde." - - OppervlakteFilter: - type: object - description: | - "Zoek binnen een bereik van de opgegeven minimumwaarde tot maximumwaarde. - De opgegeven minimumwaarde moet lager zijn dan de opgegeven maximumwaarde." - properties: - min: - type: integer - minimum: 1 - maximum: 999999 - description: "Zoek naar waarden groter of gelijk aan de opgegeven waarde." - max: - type: integer - minimum: 1 - maximum: 999999 - description: "Zoek naar waarden kleiner dan de opgegeven waarde." - - Adres: - type: object - description: "Eigenschappen van het adres die kunnen worden hergebruikt in andere API's met adresgegevens." - properties: - straat: - title: openbareruimte naam - description: "Een naam die door de gemeente aan een openbare ruimte is gegeven." - type: string - example: 'Laan van de landinrichtingscommissie Duiven-Westervoort' - huisnummer: - description: "Een nummer dat door de gemeente aan een adresseerbaar object is gegeven." - type: integer - example: 1 - huisletter: - description: "Een toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven." - type: string - example: 'A' - huisnummertoevoeging: - description: "Een toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven." - type: string - example: 'bis' - postcode: - description: "De door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort." - type: string - example: '6922KZ' - woonplaats: - description: "Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam." - title: woonplaats naam - type: string - example: 'Duiven' - AdresUitgebreid: - allOf: - - $ref: "#/components/schemas/Adres" - - description: "Het adres is de benaming van een locatie bestaande uit straatnaam, huisnummer, (mogelijk met huisletter, huisnummertoevoeging, postcode) en woonplaatsnaam. Dit is de vereenvoudigde samenstelling van de officiële naamgeving gebaseerd op woonplaats, openbare ruimte en nummeraanduiding." - properties: - adresregel1: - type: "string" - description: "De eerste regel van het adres zoals deze gebruikt kan worden in postadressering." - example: "Ln vd l D-Westervoort 1" - adresregel2: - type: "string" - description: "De tweede regel van het adres zoals deze gebruikt kan worden in postadressering." - example: "6922 KZ DUIVEN" - korteNaam: - description: "De officiële openbareruimtenaam of een verkorte versie. Beiden hebben maximaal 24 tekens." - type: string - maxLength: 24 - example: 'Ln vd l D-Westervoort' - nummeraanduidingIdentificatie: - type: string - description: "Fungeert ook als identificatie van het adres." - example: '0226200000038923' - openbareRuimteIdentificatie: - type: string - example: '0226300000136166' - woonplaatsIdentificatie: - type: string - example: '2096' - adresseerbaarObjectIdentificatie: - type: string - example: '0226010000038820' - pandIdentificaties: - description: "Identificatie(s) van het pand of de panden waar het verblijfsobject deel van is." - type: array - items: - type: string - example: ['0226100000008856'] - isNevenadres: - description: "Indicatie dat dit adres een nevenadres is van een adresseerbaar object. Het adres is een hoofdadres als deze indicatie niet wordt meegeleverd." - type: boolean - geconstateerd: - description: "Indicatie dat dit adres in de registratie is opgenomen door een feitelijke constatering, zonder dat er sprake was van een brondocument/vergunning. Het adres is mogelijk illegaal." - type: boolean - mogelijkOnjuist: - $ref: '#/components/schemas/AdresMogelijkOnjuist' - description: "Bij het controleren of een property mogelijkOnjuist is kan het zijn dat er meerdere indicaties voor een property opgenomen zijn. In dat geval zijn er meerdere indicaties waarvan de naam begint met de property-naam." - AdresMogelijkOnjuist: - type: object - description: "Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting." - properties: - adresregel1: - type: boolean - adresregel2: - type: boolean - korteNaam: - type: boolean - straat: - type: boolean - huisnummer: - type: boolean - huisletter: - type: boolean - huisnummertoevoeging: - type: boolean - postcode: - type: boolean - woonplaats: - type: boolean - nummeraanduidingIdentificatie: - type: boolean - openbareRuimteIdentificatie: - type: boolean - woonplaatsIdentificatie: - type: boolean - toelichting: - type: array - items: - type: string - example: "Geometrie of woonplaatsgrens is mogelijk onjuist, waardoor gaten of overlappingen ontstaan in de registratie van woonplaatsen. Gevolg kan zijn dat een object in een verkeerde woonplaats, in twee woonplaatsen, of in geen enkele woonplaats ligt." - AdresHal: - allOf: - - $ref: '#/components/schemas/AdresHalBasis' - - properties: - _embedded: - $ref: '#/components/schemas/AdresEmbedded' - AdresHalBasis: - allOf: - - $ref: '#/components/schemas/AdresUitgebreid' - - properties: - _links: - $ref: '#/components/schemas/AdresLinks' - AdresHalCollectie: - type: object - properties: - _links: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalPaginationLinksMetLast' - _embedded: - $ref: '#/components/schemas/AdresHalCollectieEmbedded' - AdresHalCollectieEmbedded: - type: object - properties: - adressen: - items: - $ref: '#/components/schemas/AdresHal' - type: array - AdresLinks: - type: object - properties: - self: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - openbareRuimte: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - description: "De aan het adres gerelateerde openbare ruimte." - nummeraanduiding: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - description: "De aan het adres gerelateerde nummeraanduiding. Het (boolean) attribuut nevenadres van Adres geeft aan of het hier een hoofd- of nevenadres betreft." - woonplaats: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - description: "De aan het adres gerelateerde woonplaats." - adresseerbaarObject: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - description: "De aan het adres gerelateerde ligplaats, standplaats of verblijfsobject." - panden: - description: "Het/de aan het adres gerelateerde pand(en)." - type: array - items: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - AdresEmbedded: - type: object - properties: - openbareRuimte: - $ref: '#/components/schemas/OpenbareRuimteHalBasis' - nummeraanduiding: - $ref: '#/components/schemas/NummeraanduidingHalBasis' - woonplaats: - $ref: '#/components/schemas/WoonplaatsHalBasis' - adresseerbaarObject: - $ref: '#/components/schemas/AdresseerbaarObjectHalBasis' - - AdresseerbaarObject: - type: object - description: "Een adresseerbaarobject is een standplaats, ligplaats of verblijfsobject." - properties: - identificatie: - description: "Dit is de identificatie van een verblijfsobject, standplaats of ligplaats." - type: string - example: "0226010000038820" - domein: - type: "string" - description: "Het domein waartoe de identificatie behoort." - type: - $ref: '#/components/schemas/TypeAdresseerbaarObjectEnum' - title: adresseerbaarObjectType - documentdatum: - description: "De vaststellingsdatum van het brondocument dat de basis is voor opname, wijziging of een verwijdering van een object." - example: "2019-11-22" - format: date - type: string - documentnummer: - 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: "19SZ2048" - type: string - gebruiksdoelen: - items: - $ref: '#/components/schemas/GebruiksdoelEnum' - type: array - geconstateerd: - description: "Indicatie dat een standplaats, ligplaats of verblijfsobject in de registratie is opgenomen door een feitelijke constatering, zonder dat er een brondocument aan ten grondslag ligt. Het adresseerbaar object is mogelijk illegaal." - type: boolean - geometrie: - $ref: '#/components/schemas/PuntOfVlak' - pandIdentificaties: - description: "Identificatie(s) van het pand of de panden waar het verblijfsobject deel van is." - type: array - items: - type: string - example: ['0226100000008856'] - nummeraanduidingIdentificaties: - description: "Identificatie(s) van de hoofd- en nevenadressen van de standplaats, ligplaats of verblijfsobject." - type: array - items: - $ref: "#/components/schemas/NummeraanduidingIdentificatiesArray" - oppervlakte: - type: integer - status: - $ref: '#/components/schemas/AdresseerbaarObjectStatusEnum' - mogelijkOnjuist: - $ref: '#/components/schemas/AdresseerbaarObjectMogelijkOnjuist' - AdresseerbaarObjectHal: - allOf: - - $ref: '#/components/schemas/AdresseerbaarObjectHalBasis' - - properties: - _embedded: - $ref: '#/components/schemas/AdresseerbaarObjectEmbedded' - AdresseerbaarObjectHalBasis: - allOf: - - $ref: '#/components/schemas/AdresseerbaarObject' - - properties: - _links: - $ref: '#/components/schemas/AdresseerbaarObjectLinks' - AdresseerbaarObjectMogelijkOnjuist: - type: object - description: "Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting." - properties: - gebruiksdoelen: - type: boolean - geometrie: - type: boolean - nummeraanduidingIdentificaties: - type: boolean - pandIdentificaties: - type: boolean - oppervlakte: - type: boolean - status: - type: boolean - toelichting: - type: array - items: - type: string - example: "Locatie/contour mogelijk onjuist." - AdresseerbaarObjectEmbedded: - type: object - properties: - adressen: - type: "array" - items: - $ref: '#/components/schemas/AdresHalBasis' - panden: - type: "array" - items: - $ref: '#/components/schemas/PandHalBasis' - AdresseerbaarObjectLinks: - type: object - properties: - adressen: - description: "Link(s) naar het hoofdadres en waar van toepassing de nevenadressen van het adresseerbaar object." - items: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - type: array - panden: - description: "Link(s) naar het pand of de panden waar het adresseerbaar object deel van uitmaakt." - items: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - type: array - self: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - AdresseerbaarobjectHalCollectie: - type: object - properties: - _embedded: - $ref: '#/components/schemas/AdresseerbaarobjectHalCollectieEmbedded' - _links: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalPaginationLinksMetLast' - AdresseerbaarobjectHalCollectieEmbedded: - type: object - properties: - adresseerbareObjecten: - items: - $ref: '#/components/schemas/AdresseerbaarObjectHal' - type: array - AdresseerbaarObjectStatusEnum: - type: string - enum: - # Ligplaats / standplaats huidige statussen - - 'Plaats aangewezen' - # Verblijfsobject huidige statussen - - 'Verblijfsobject gevormd' - - 'Verblijfsobject in gebruik (niet ingemeten)' - - 'Verblijfsobject in gebruik' - - 'Verbouwing verblijfsobject' - - 'Verblijfsobject buiten gebruik' - GebruiksdoelEnum: - type: string - enum: - - 'woonfunctie' - - 'bijeenkomstfunctie' - - 'celfunctie' - - 'gezondheidszorgfunctie' - - 'industriefunctie' - - 'kantoorfunctie' - - 'logiesfunctie' - - 'onderwijsfunctie' - - 'sportfunctie' - - 'winkelfunctie' - - 'overige gebruiksfunctie' - - OpenbareRuimte: - type: object - description: "Een buitenruimte met een naam die binnen één woonplaats ligt, bijvoorbeeld een straat of een plein." - properties: - identificatie: - type: string - domein: - type: "string" - description: "Het domein waartoe de identificatie behoort." - naam: - title: openbare ruimte naam - description: "De naam die door de gemeente aan een openbare ruimte is gegeven." - type: string - example: 'Laan van de landinrichtingscommissie Duiven-Westervoort' - type: - $ref: '#/components/schemas/TypeOpenbareRuimteEnum' - status: - $ref: '#/components/schemas/StatusNaamgevingEnum' - korteNaam: - description: "De officiële openbareruimtenaam of een verkorte versie. Beiden hebben maximaal 24 tekens." - type: string - maxLength: 24 - example: 'Ln vd l D-Westervoort' - geconstateerd: - description: "Indicator dat een openbare ruimte in de registratie is opgenomen door een feitelijke constatering, zonder dat er een brondocument aan ten grondslag ligt. De openbare ruimte is mogelijk illegaal." - type: boolean - documentdatum: - description: "De vaststellingsdatum van het brondocument dat de basis is voor opname, wijziging of een verwijdering van een object." - type: string - format: date - example: '2010-02-09' - documentnummer: - 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." - type: string - example: 'BAG-21' - woonplaatsIdentificatie: - type: string - description: "Een openbare ruimte ligt in een woonplaats." - example: '2096' - mogelijkOnjuist: - $ref: '#/components/schemas/OpenbareRuimteMogelijkOnjuist' - OpenbareRuimteMogelijkOnjuist: - type: object - description: "Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting." - properties: - naam: - type: boolean - korteNaam: - type: boolean - type: - type: boolean - status: - type: boolean - woonplaatsIdentificatie: - type: boolean - toelichting: - type: array - items: - type: string - example: "Openbare ruimtenaam komt mogelijk niet overeen met de vermelding in het straatnaambesluit." - OpenbareRuimteHalBasis: - allOf: - - $ref: '#/components/schemas/OpenbareRuimte' - - properties: - _links: - $ref: '#/components/schemas/OpenbareRuimteLinks' - - OpenbareRuimteLinks: - type: object - properties: - self: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - woonplaats: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - description: "De aan de openbare ruimte gerelateerde woonplaats (link)." - - Nummeraanduiding: - type: object - description: "Een postcode, huisnummer met mogelijk een huisletter en huisnummertoevoeging die hoort bij een verblijfsobject, een standplaats of een ligplaats." - properties: - identificatie: - type: string - domein: - type: "string" - description: "Het domein waartoe de identificatie behoort." - huisnummer: - description: "Nummer dat door de gemeente aan een adresseerbaar object is gegeven." - type: integer - example: 1 - huisletter: - description: "Toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven." - type: string - example: 'A' - huisnummertoevoeging: - description: "Toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven." - type: string - example: 'bis' - postcode: - description: "Door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort." - type: string - example: '6922KZ' - status: - $ref: '#/components/schemas/StatusNaamgevingEnum' - geconstateerd: - description: "Indicator dat de nummeraanduiding in de registratie is opgenomen door een feitelijke constatering, zonder dat er sprake was van een brondocument/vergunning. De nummeraanduiding is mogelijk illegaal." - type: boolean - documentdatum: - description: "De vaststellingsdatum van het brondocument dat de basis is voor opname, wijziging of een verwijdering van een object." - type: string - format: date - example: '2019-11-25' - documentnummer: - description: "Identificatie van het brondocument dat ten grondslag ligt aan de opname, mutatie of een verwijdering van gegevens." - type: string - example: 'Duiven 25112019' - woonplaatsIdentificatie: - type: string - description: "Een nummeraanduiding ligt in een woonplaats." - example: '2096' - openbareRuimteIdentificatie: - type: string - description: "Een nummeraanduiding ligt aan een openbare ruimte." - example: '0226300000136166' - mogelijkOnjuist: - $ref: '#/components/schemas/NummeraanduidingMogelijkOnjuist' - NummeraanduidingIdentificatiesArray: - type: object - properties: - nummeraanduidingIdentificatie: - type: string - example: '0226200000038923' - isNevenadres: - type: boolean - NummeraanduidingMogelijkOnjuist: - type: object - description: "Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting." - properties: - huisnummer: - type: boolean - huisletter: - type: boolean - huisnummertoevoeging: - type: boolean - postcode: - type: boolean - status: - type: boolean - woonplaatsIdentificatie: - type: boolean - openbareRuimteIdentificatie: - type: boolean - toelichting: - type: array - items: - type: string - example: "Woonplaats bestaat mogelijk niet." - NummeraanduidingHalBasis: - allOf: - - $ref: '#/components/schemas/Nummeraanduiding' - - properties: - _links: - $ref: '#/components/schemas/NummeraanduidingLinks' - - NummeraanduidingLinks: - type: object - properties: - self: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - adres: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - description: "Het aan de nummeraanduiding gerelateerde adres (link)." - openbareRuimte: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - description: "De aan de nummeraanduiding gerelateerde openbareruimte (link)." - woonplaats: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - description: "De aan het openbareruimte gerelateerde woonplaats (link)." - - Woonplaats: - type: object - description: "Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam." - properties: - identificatie: - type: string - domein: - type: "string" - description: "Het domein waartoe de identificatie behoort." - naam: - description: "De naam van de woonplaats." - type: string - example: 'Duiven' - status: - $ref: '#/components/schemas/StatusWoonplaatsEnum' - description: "De fase van de levenscyclus van een woonplaats, waarin de betreffende woonplaats zich bevindt." - geconstateerd: - description: "Indicator dat de woonplaats in de registratie is opgenomen door een feitelijke constatering, zonder dat er een brondocument aan ten grondslag ligt. De woonplaats is mogelijk illegaal." - type: boolean - documentdatum: - description: "De vaststellingsdatum van het brondocument dat de basis is voor opname, wijziging of een verwijdering van een object." - type: string - format: date - example: '2009-02-09' - documentnummer: - 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." - type: string - example: '09.0898' - mogelijkOnjuist: - $ref: "#/components/schemas/WoonplaatsMogelijkOnjuist" - WoonplaatsMogelijkOnjuist: - type: object - description: "Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting." - properties: - naam: - type: boolean - geometrie: - type: boolean - status: - type: boolean - toelichting: - type: array - items: - type: string - example: "Woonplaats bestaat mogelijk niet." - WoonplaatsHalBasis: - allOf: - - $ref: '#/components/schemas/Woonplaats' - - properties: - _links: - $ref: '#/components/schemas/WoonplaatsLinks' - WoonplaatsHal: - allOf: - - $ref: '#/components/schemas/WoonplaatsHalBasis' - - properties: - _embedded: - $ref: '#/components/schemas/WoonplaatsEmbedded' - WoonplaatsLinks: - type: object - properties: - self: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - - WoonplaatsEmbedded: - type: object - properties: - geometrie: - $ref: '#/components/schemas/VlakOfMultivlak' - - Pand: - type: object - description: "Een pand is een bouwkundige, constructief zelfstandige eenheid die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar is." - properties: - identificatie: - type: string - description: "De unieke aanduiding van een pand. Elk pand waarvan gegevens zijn opgenomen in de BAG wordt uniek aangeduid door middel van een identificatiecode." - domein: - type: "string" - description: "Het domein waartoe de identificatie behoort." - geometrie: - $ref: 'http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/polygonGeoJSON.yaml' - description: "De minimaal tweedimensionale geometrische representatie van het bovenzicht van de omtrekken van een pand." - oorspronkelijkBouwjaar: - description: "Het jaar waarin een pand oorspronkelijk als bouwkundig gereed is opgeleverd. Door de gemeente wordt een inschatting gemaakt van het bouwjaar, en aangepast als het pand wordt opgeleverd. Wijzigingen aan een pand na oplevering leiden niet tot wijziging van het bouwjaar." - type: integer - example: 1991 - status: - $ref: '#/components/schemas/StatusPandEnum' - description: "Een codering van de verschillende waarden die de status van een pand kan aannemen." - geconstateerd: - description: "Indicatie dat het pand in de registratie is opgenomen door een feitelijke constatering, zonder dat er sprake was van een brondocument/vergunning. Het pand is mogelijk illegaal." - type: boolean - documentdatum: - description: "De vaststellingsdatum van het brondocument dat de basis is voor opname, wijziging of een verwijdering van een object." - type: string - format: date - example: '2009-05-12' - documentnummer: - 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." - type: string - example: '09.BW.0273' - adresseerbaarObjectIdentificaties: - type: array - items: - type: string - example: ['0226010000038820'] - nummeraanduidingIdentificaties: - description: "Identificatie(s) van de hoofd- en nevenadressen van het pand." - items: - $ref: "#/components/schemas/NummeraanduidingIdentificatiesArray" - type: array - mogelijkOnjuist: - $ref: '#/components/schemas/PandMogelijkOnjuist' - PandMogelijkOnjuist: - type: object - description: "Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting." - properties: - geometrie: - type: boolean - oorspronkelijkBouwjaar: - type: boolean - status: - type: boolean - toelichting: - type: array - items: - type: string - example: "Mogelijk is de bouw al gereed of is het pand niet gerealiseerd." - PandHalBasis: - allOf: - - $ref: '#/components/schemas/Pand' - - properties: - _links: - $ref: '#/components/schemas/PandLinks' - - PandLinks: - type: object - properties: - self: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - adressen: - type: array - items: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - adresseerbareObjecten: - type: array - items: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - - PandHalCollectie: - type: object - properties: - _links: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalPaginationLinksMetLast' - _embedded: - $ref: '#/components/schemas/PandHalCollectieEmbedded' - PandHalCollectieEmbedded: - type: object - properties: - panden: - type: array - items: - $ref: '#/components/schemas/PandHalBasis' - - StatusNaamgevingEnum: - description: "Een aanduiding van alle waarden die de status van een openbare ruimte of een nummeraanduiding kan aannemen." - type: string - enum: - - 'Naamgeving uitgegeven' - StatusPandEnum: - type: string - enum: - - 'Bouwvergunning verleend' - - 'Bouw gestart' - - 'Pand in gebruik (niet ingemeten)' - - 'Pand in gebruik' - - 'Verbouwing pand' - - 'Sloopvergunning verleend' - - 'Pand buiten gebruik' - StatusWoonplaatsEnum: - description: "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen." - type: string - enum: - - 'Woonplaats aangewezen' - TypeAdresseerbaarObjectEnum: - type: string - enum: - - 'verblijfsobject' - - 'standplaats' - - 'ligplaats' - TypeOpenbareRuimteEnum: - description: "Een codering van de verschillende waarden die de typering van een openbare ruimte kan aannemen." - type: string - enum: - - 'Weg' - - 'Water' - - 'Spoorbaan' - - 'Terrein' - - 'Kunstwerk' - - 'Landschappelijk gebied' - - 'Administratief gebied' - - PuntOfVlak: - type: object - description: "Een samengesteld geometriegegevenstype waarbij wordt afgedwongen dat voor de geometrie een keuze gemaakt moet worden tussen een punt of een vlak." - properties: - punt: - $ref: 'http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/pointGeoJSON.yaml' - vlak: - $ref: 'http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/polygonGeoJSON.yaml' - VlakOfMultivlak: - type: object - description: "Een samengesteld geometriegegevenstype waarbij wordt afgedwongen dat voor de geometrie een keuze gemaakt moet worden tussen een vlak (GM_Surface) of een multivlak (GM_MultiSurface)." - properties: - vlak: - $ref: 'http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/polygonGeoJSON.yaml' - multivlak: - $ref: 'http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/multipolygonGeoJSON.yaml' \ No newline at end of file diff --git a/test/BAG-Bevragen-postman-collection.json b/test/BAG-Bevragen-postman-collection.json deleted file mode 100644 index 5c72b82..0000000 --- a/test/BAG-Bevragen-postman-collection.json +++ /dev/null @@ -1,7847 +0,0 @@ -{ - "item": [ - { - "id": "4fc12e04-f814-4744-adfb-829ec7e5565f", - "name": "adressen", - "item": [ - { - "id": "2bf6ffac-b885-4ad1-a982-7af81e632a2e", - "name": "vindt adressen", - "request": { - "name": "vindt adressen", - "description": { - "content": "Vind een actueel adres met:\n1. Een pandidentificatie of\n2. Een adresseerbaarobjectidentificatie of\n3. Een postcode, huisnummer en optioneel huisletter, huisnummertoevoeging en/of exacteMatch.\n4. Een zoekterm.\n\nGebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). \nGebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources nummeraanduiding, woonplaats en openbare ruimte, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature).\nGebruik de exacteMatch parameter als je alleen resultaten wilt ontvangen die exact overeenkomen met de opgegeven zoek criteria, zie [functionele specificaties exacteMatch-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/blob/v1.2.0/features/exacte_match.feature). Je kunt adresseerbare objecten niet expanden als je tegelijkertijd de query parameter adresseerbaarObjectIdentificatie gebruikt.", - "type": "text/plain" - }, - "url": { - "path": [ - "adressen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "key": "pandIdentificatie", - "value": "", - "description": "Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - }, - { - "disabled": false, - "key": "adresseerbaarObjectIdentificatie", - "value": "", - "description": "De identificatie van een adresseerbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - }, - { - "disabled": false, - "key": "zoekresultaatIdentificatie", - "value": "", - "description": "De identificatie van een zoekresultaat van het endpoint get /adressen/zoek." - }, - { - "disabled": false, - "key": "expand", - "value": "", - "description": "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature)." - }, - { - "disabled": false, - "key": "fields", - "value": "", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)" - }, - { - "disabled": false, - "key": "page", - "value": "1", - "description": "Pagina nummer" - }, - { - "disabled": false, - "key": "pageSize", - "value": "20" - }, - { - "disabled": false, - "key": "postcode", - "value": "", - "description": "Postcode van het adres." - }, - { - "disabled": false, - "key": "huisnummer", - "value": "", - "description": "Huisnummer van het adres." - }, - { - "disabled": false, - "key": "huisletter", - "value": "", - "description": "Een toevoeging (in de vorm van een letter) aan een huisnummer van het adres. Bijvoorbeeld: Bij adres: Belgiëlaan 1 A2, 2391 PH HAZERSWOUDE-DORP, is 1 het huisnummer en A de huisletter." - }, - { - "disabled": false, - "key": "huisnummertoevoeging", - "value": "", - "description": "Een toevoeging (in de vorm van maximaal 4 cijfers of letters) aan een huisnummer of een combinatie van huisnummer en huisletter van het adres. Bijvoorbeeld: Bij het adres: Belgiëlaan 1 A2, 2391 PH HAZERSWOUDE-DORP, is 1 het huisnummer, A de huisletter en 2 de huisnummertoevoeging." - }, - { - "disabled": false, - "key": "exacteMatch", - "value": "false", - "description": "Geeft aan of de resultaten van de zoekopdracht exact overeen moeten komen met de opgegeven parameters, zie [functionele specificatie exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature)." - }, - { - "disabled": false, - "key": "q", - "value": "", - "description": "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging." - } - ], - "variable": [] - }, - "method": "GET", - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "X-Api-Key" - }, - { - "key": "value", - "value": "" - }, - { - "key": "in", - "value": "header" - } - ] - } - }, - "response": [ - { - "id": "7b42a585-bccf-401f-b4cd-649783c4ba55", - "name": "Geslaagd", - "originalRequest": { - "url": { - "path": [ - "adressen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "zoekresultaatIdentificatie", - "value": "" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "postcode", - "value": "6922KZ" - }, - { - "key": "huisnummer", - "value": "1" - }, - { - "key": "huisletter", - "value": "A" - }, - { - "key": "huisnummertoevoeging", - "value": "bis" - }, - { - "key": "exacteMatch", - "value": "true" - }, - { - "key": "q", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "disabled": false, - "key": "X-Pagination-Page", - "value": "3", - "description": "" - }, - { - "disabled": false, - "key": "X-Pagination-Limit", - "value": "20", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"_links\": {\n \"self\": {\n \"href\": {\n \"value\": \"\"\n },\n \"templated\": true,\n \"title\": \"minim in ex\"\n },\n \"first\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"enim incididunt\"\n },\n \"previous\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"proident ad\"\n },\n \"next\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"cupidatat ut mollit proident\"\n },\n \"last\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"mollit dolore sunt\"\n }\n },\n \"_embedded\": {\n \"adressen\": [\n {\n \"_links\": {\n \"value\": \"\"\n },\n \"_embedded\": {\n \"openbareRuimte\": {\n \"value\": \"\"\n },\n \"nummeraanduiding\": {\n \"value\": \"\"\n },\n \"woonplaats\": {\n \"value\": \"\"\n },\n \"adresseerbaarObject\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"_links\": {\n \"value\": \"\"\n },\n \"_embedded\": {\n \"openbareRuimte\": {\n \"value\": \"\"\n },\n \"nummeraanduiding\": {\n \"value\": \"\"\n },\n \"woonplaats\": {\n \"value\": \"\"\n },\n \"adresseerbaarObject\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "4db0df0b-27cb-47cd-8b3e-e279a279f39e", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "adressen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "zoekresultaatIdentificatie", - "value": "" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "postcode", - "value": "6922KZ" - }, - { - "key": "huisnummer", - "value": "1" - }, - { - "key": "huisletter", - "value": "A" - }, - { - "key": "huisnummertoevoeging", - "value": "bis" - }, - { - "key": "exacteMatch", - "value": "true" - }, - { - "key": "q", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "c3999952-4503-4edd-9dd8-1d1f92b34e73", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "adressen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "zoekresultaatIdentificatie", - "value": "" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "postcode", - "value": "6922KZ" - }, - { - "key": "huisnummer", - "value": "1" - }, - { - "key": "huisletter", - "value": "A" - }, - { - "key": "huisnummertoevoeging", - "value": "bis" - }, - { - "key": "exacteMatch", - "value": "true" - }, - { - "key": "q", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"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.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "b4c27c45-8bec-4a72-b035-b0bfdb221fa9", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "adressen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "zoekresultaatIdentificatie", - "value": "" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "postcode", - "value": "6922KZ" - }, - { - "key": "huisnummer", - "value": "1" - }, - { - "key": "huisletter", - "value": "A" - }, - { - "key": "huisnummertoevoeging", - "value": "bis" - }, - { - "key": "exacteMatch", - "value": "true" - }, - { - "key": "q", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "26bcb0f8-ee57-4712-af72-eb2afea2e0bb", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "adressen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "zoekresultaatIdentificatie", - "value": "" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "postcode", - "value": "6922KZ" - }, - { - "key": "huisnummer", - "value": "1" - }, - { - "key": "huisletter", - "value": "A" - }, - { - "key": "huisnummertoevoeging", - "value": "bis" - }, - { - "key": "exacteMatch", - "value": "true" - }, - { - "key": "q", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "1b8c0aa3-d8fa-491d-96ca-a07805a38921", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "adressen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "zoekresultaatIdentificatie", - "value": "" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "postcode", - "value": "6922KZ" - }, - { - "key": "huisnummer", - "value": "1" - }, - { - "key": "huisletter", - "value": "A" - }, - { - "key": "huisnummertoevoeging", - "value": "bis" - }, - { - "key": "exacteMatch", - "value": "true" - }, - { - "key": "q", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "211578db-967a-42fd-8c93-0cea4aebfa8d", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "adressen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "zoekresultaatIdentificatie", - "value": "" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "postcode", - "value": "6922KZ" - }, - { - "key": "huisnummer", - "value": "1" - }, - { - "key": "huisletter", - "value": "A" - }, - { - "key": "huisnummertoevoeging", - "value": "bis" - }, - { - "key": "exacteMatch", - "value": "true" - }, - { - "key": "q", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "6e8d6b30-d89e-4560-b75d-b6baebb6f717", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "adressen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "zoekresultaatIdentificatie", - "value": "" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "postcode", - "value": "6922KZ" - }, - { - "key": "huisnummer", - "value": "1" - }, - { - "key": "huisletter", - "value": "A" - }, - { - "key": "huisnummertoevoeging", - "value": "bis" - }, - { - "key": "exacteMatch", - "value": "true" - }, - { - "key": "q", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"http://ifgfzjkLxFOtwWOCgCs.lsqPXNjyKQsryzYfL7D\",\n \"title\": \"ex\",\n \"status\": -62408852,\n \"detail\": \"dolor ad\",\n \"instance\": \"https://GkMDQWZiYItdkUMeIAHnBkJhqBAuhJhWq.pscAOX5Eey8IhuySMMXgTRVYvDoJZlC9YuoEvckd7hLZhriY+F97NuY\",\n \"code\": \"ut\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - }, - { - "id": "f94612c5-a035-4176-982c-0803cd0a092d", - "name": "\"fuzzy\" zoeken van adressen", - "request": { - "name": "\"fuzzy\" zoeken van adressen", - "description": { - "content": "Free query zoeken van adressen met postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging. Delen van de adressen in het antwoord matchen exact met jouw invoer. Je vindt een adres door de zoekresultaatidentificatie uit het antwoord te gebruiken in get/adressen", - "type": "text/plain" - }, - "url": { - "path": [ - "adressen", - "zoek" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "key": "zoek", - "value": "", - "description": "(Required) Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging." - }, - { - "disabled": false, - "key": "page", - "value": "1", - "description": "Pagina nummer" - }, - { - "disabled": false, - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "method": "GET", - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "X-Api-Key" - }, - { - "key": "value", - "value": "" - }, - { - "key": "in", - "value": "header" - } - ] - } - }, - "response": [ - { - "id": "8e438f20-da64-403c-9791-e8efb19655e2", - "name": "Geslaagd", - "originalRequest": { - "url": { - "path": [ - "adressen", - "zoek" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "zoek", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "disabled": false, - "key": "X-Pagination-Page", - "value": "3", - "description": "" - }, - { - "disabled": false, - "key": "X-Pagination-Limit", - "value": "20", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"_links\": {\n \"self\": {\n \"href\": {\n \"value\": \"\"\n },\n \"templated\": false,\n \"title\": \"pariatur veniam Duis al\"\n },\n \"first\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"sed consequat qui ipsum in\"\n },\n \"previous\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"dolor fugiat consequat\"\n },\n \"next\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"velit quis in sit consequat\"\n },\n \"last\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"deserunt eu\"\n }\n },\n \"_embedded\": {\n \"zoekresultaten\": [\n {\n \"omschrijving\": \"proident esse anim\",\n \"identificatie\": \"ea\",\n \"_links\": {\n \"adres\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"ex anim cupidatat Ut\"\n }\n }\n },\n {\n \"omschrijving\": \"Lorem tempor\",\n \"identificatie\": \"ut id\",\n \"_links\": {\n \"adres\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"cillum minim\"\n }\n }\n }\n ]\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "cd04cb70-c9d7-4ce7-ac88-b07b100b909b", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "adressen", - "zoek" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "zoek", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "128af71b-592a-451b-9970-8723c9f34771", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "adressen", - "zoek" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "zoek", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"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.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "1f5bb149-7536-420c-a4d7-1ef9095f42c6", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "adressen", - "zoek" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "zoek", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "8643e27b-5f49-4c72-a912-2f4fd479b4fc", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "adressen", - "zoek" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "zoek", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "e9eebedb-37fc-4d0b-8852-c2574b204979", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "adressen", - "zoek" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "zoek", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "02b8e153-ab8e-4667-bcf1-ab0e66f9431f", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "adressen", - "zoek" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "zoek", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "8ccc8ac4-07b4-41c4-964d-7c2c5cf29c36", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "adressen", - "zoek" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "zoek", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"http://ifgfzjkLxFOtwWOCgCs.lsqPXNjyKQsryzYfL7D\",\n \"title\": \"ex\",\n \"status\": -62408852,\n \"detail\": \"dolor ad\",\n \"instance\": \"https://GkMDQWZiYItdkUMeIAHnBkJhqBAuhJhWq.pscAOX5Eey8IhuySMMXgTRVYvDoJZlC9YuoEvckd7hLZhriY+F97NuY\",\n \"code\": \"ut\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - }, - { - "id": "4fae2876-c706-4546-9034-b8239007c039", - "name": "levert een adres", - "request": { - "name": "levert een adres", - "description": { - "content": "Raadpleeg een actueel adres met de nummeraanduidingidentificatie. \nGebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). \nGebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources nummeraanduiding, woonplaats, openbare ruimte, adresseerbaarobject, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature).", - "type": "text/plain" - }, - "url": { - "path": [ - "adressen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "key": "expand", - "value": "", - "description": "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature)." - }, - { - "disabled": false, - "key": "fields", - "value": "", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "method": "GET", - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "X-Api-Key" - }, - { - "key": "value", - "value": "" - }, - { - "key": "in", - "value": "header" - } - ] - } - }, - "response": [ - { - "id": "3a23f926-d203-4af6-8594-3df88debf9e4", - "name": "Geslaagd", - "originalRequest": { - "url": { - "path": [ - "adressen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"straat\": \"Laan van de landinrichtingscommissie Duiven-Westervoort\",\n \"huisnummer\": 1,\n \"huisletter\": \"A\",\n \"huisnummertoevoeging\": \"bis\",\n \"postcode\": \"6922KZ\",\n \"woonplaats\": \"Duiven\",\n \"adresregel1\": \"Ln vd l D-Westervoort 1\",\n \"adresregel2\": \"6922 KZ DUIVEN\",\n \"korteNaam\": \"Ln vd l D-Westervoort\",\n \"nummeraanduidingIdentificatie\": \"0226200000038923\",\n \"openbareRuimteIdentificatie\": \"0226300000136166\",\n \"woonplaatsIdentificatie\": \"2096\",\n \"adresseerbaarObjectIdentificatie\": \"0226010000038820\",\n \"pandIdentificaties\": [\n \"0226100000008856\"\n ],\n \"isNevenadres\": true,\n \"geconstateerd\": true,\n \"mogelijkOnjuist\": {\n \"adresregel1\": false,\n \"adresregel2\": false,\n \"korteNaam\": false,\n \"straat\": false,\n \"huisnummer\": true,\n \"huisletter\": true,\n \"huisnummertoevoeging\": true,\n \"postcode\": true,\n \"woonplaats\": false,\n \"nummeraanduidingIdentificatie\": false,\n \"openbareRuimteIdentificatie\": false,\n \"woonplaatsIdentificatie\": false,\n \"toelichting\": [\n \"Geometrie of woonplaatsgrens is mogelijk onjuist, waardoor gaten of overlappingen ontstaan in de registratie van woonplaatsen. Gevolg kan zijn dat een object in een verkeerde woonplaats, in twee woonplaatsen, of in geen enkele woonplaats ligt.\",\n \"Geometrie of woonplaatsgrens is mogelijk onjuist, waardoor gaten of overlappingen ontstaan in de registratie van woonplaatsen. Gevolg kan zijn dat een object in een verkeerde woonplaats, in twee woonplaatsen, of in geen enkele woonplaats ligt.\"\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"qui sit Lorem co\"\n },\n \"openbareRuimte\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"in officia\"\n },\n \"nummeraanduiding\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"minim nulla fugiat\"\n },\n \"woonplaats\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"in\"\n },\n \"adresseerbaarObject\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"anim ut ipsum\"\n },\n \"panden\": [\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"reprehenderit non ipsum\"\n },\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"consectetur do deserunt qui\"\n }\n ]\n },\n \"_embedded\": {\n \"openbareRuimte\": {\n \"identificatie\": \"voluptate dolor\",\n \"domein\": \"Ut aliquip dolore tempor\",\n \"naam\": \"Laan van de landinrichtingscommissie Duiven-Westervoort\",\n \"type\": \"Weg\",\n \"status\": \"Naamgeving uitgegeven\",\n \"korteNaam\": \"Ln vd l D-Westervoort\",\n \"geconstateerd\": false,\n \"documentdatum\": \"1982-09-17\",\n \"documentnummer\": \"BAG-21\",\n \"woonplaatsIdentificatie\": \"2096\",\n \"mogelijkOnjuist\": {\n \"naam\": {\n \"value\": \"\"\n },\n \"korteNaam\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"woonplaatsIdentificatie\": {\n \"value\": \"\"\n },\n \"toelichting\": {\n \"value\": \"\"\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"ad\"\n },\n \"woonplaats\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"tempor ea sunt quis\"\n }\n }\n },\n \"nummeraanduiding\": {\n \"identificatie\": \"proident Duis id irure\",\n \"domein\": \"cillum exercitation\",\n \"huisnummer\": 1,\n \"huisletter\": \"A\",\n \"huisnummertoevoeging\": \"bis\",\n \"postcode\": \"6922KZ\",\n \"status\": \"Naamgeving uitgegeven\",\n \"geconstateerd\": true,\n \"documentdatum\": \"1970-11-02\",\n \"documentnummer\": \"Duiven 25112019\",\n \"woonplaatsIdentificatie\": \"2096\",\n \"openbareRuimteIdentificatie\": \"0226300000136166\",\n \"mogelijkOnjuist\": {\n \"huisnummer\": {\n \"value\": \"\"\n },\n \"huisletter\": {\n \"value\": \"\"\n },\n \"huisnummertoevoeging\": {\n \"value\": \"\"\n },\n \"postcode\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"woonplaatsIdentificatie\": {\n \"value\": \"\"\n },\n \"openbareRuimteIdentificatie\": {\n \"value\": \"\"\n },\n \"toelichting\": {\n \"value\": \"\"\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"ad ut\"\n },\n \"adres\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"et labore proident\"\n },\n \"openbareRuimte\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"dolore pariatur\"\n },\n \"woonplaats\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"mollit amet\"\n }\n }\n },\n \"woonplaats\": {\n \"identificatie\": \"consequat commodo ad\",\n \"domein\": \"voluptate sed\",\n \"naam\": \"Duiven\",\n \"status\": \"Woonplaats aangewezen\",\n \"geconstateerd\": false,\n \"documentdatum\": \"1945-01-11\",\n \"documentnummer\": \"09.0898\",\n \"mogelijkOnjuist\": {\n \"naam\": {\n \"value\": \"\"\n },\n \"geometrie\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"toelichting\": {\n \"value\": \"\"\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"sed in mollit\"\n }\n }\n },\n \"adresseerbaarObject\": {\n \"identificatie\": \"0226010000038820\",\n \"domein\": \"nostrud et\",\n \"type\": \"ligplaats\",\n \"documentdatum\": \"1998-06-25\",\n \"documentnummer\": \"19SZ2048\",\n \"gebruiksdoelen\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"geconstateerd\": true,\n \"geometrie\": {\n \"punt\": {\n \"value\": \"\"\n },\n \"vlak\": {\n \"value\": \"\"\n }\n },\n \"pandIdentificaties\": [\n \"0226100000008856\"\n ],\n \"nummeraanduidingIdentificaties\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"oppervlakte\": 9796463,\n \"status\": \"Plaats aangewezen\",\n \"mogelijkOnjuist\": {\n \"gebruiksdoelen\": {\n \"value\": \"\"\n },\n \"geometrie\": {\n \"value\": \"\"\n },\n \"nummeraanduidingIdentificaties\": {\n \"value\": \"\"\n },\n \"pandIdentificaties\": {\n \"value\": \"\"\n },\n \"oppervlakte\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"toelichting\": {\n \"value\": \"\"\n }\n },\n \"_links\": {\n \"adressen\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"panden\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"magna irure laborum officia\"\n }\n }\n }\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "4d08df59-1291-457a-b6f4-fc17e9f19053", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "adressen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "ee8c1f5d-073b-4834-8078-13c251c73dfe", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "adressen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"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.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "8d860cf4-033a-43a4-85d0-0c07aea16322", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "adressen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "b5bc871d-13a6-4a69-8ef1-ce636ddc2095", - "name": "Not Found", - "originalRequest": { - "url": { - "path": [ - "adressen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5\",\n \"title\": \"Opgevraagde resource bestaat niet.\",\n \"status\": 404,\n \"detail\": \"The server has not found anything matching the Request-URI.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notFound\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "858ed3ed-cf10-49e4-84c1-e7747a4258b7", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "adressen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "1264e39e-7af8-4ca8-9ffd-6699e312a45c", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "adressen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "e94fc538-e751-4268-b488-75ecb6cde7e2", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "adressen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "362a5b45-e909-43d4-897e-c4247d279a23", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "adressen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"http://ifgfzjkLxFOtwWOCgCs.lsqPXNjyKQsryzYfL7D\",\n \"title\": \"ex\",\n \"status\": -62408852,\n \"detail\": \"dolor ad\",\n \"instance\": \"https://GkMDQWZiYItdkUMeIAHnBkJhqBAuhJhWq.pscAOX5Eey8IhuySMMXgTRVYvDoJZlC9YuoEvckd7hLZhriY+F97NuY\",\n \"code\": \"ut\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - } - ], - "event": [] - }, - { - "id": "9eaa8825-e552-4a5b-bd61-2bc4ac6a3dd5", - "name": "adresseerbareobjecten", - "item": [ - { - "id": "997158e8-b854-45ce-8178-0bff7322971d", - "name": "vindt verblijfsobjecten, ligplaatsen, standplaatsen", - "request": { - "name": "vindt verblijfsobjecten, ligplaatsen, standplaatsen", - "description": { - "content": "Zoek actuele adresseerbare objecten (verblijfsobjecten, standplaatsen of ligplaatsen) met:\n1. een nummeraanduidingidentificatie of\n2. een pandidentificatie of\n3. een lijst met pandidentificaties of\n4. een geometrische contour (rechthoek) in combinatie met status geconstateerd, oppervlakte, gebruiksdoel en/of type.\n\nHet zoeken van adresseerbare objecten met een oppervlakte en een type=ligplaats of type=standplaats wordt niet ondersteund en levert een foutmelding.\nGebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).\nGebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources adres en pand, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). Je kunt panden niet expanden als je tegelijkertijd de query parameter pandIdentificatie(s) gebruikt.", - "type": "text/plain" - }, - "url": { - "path": [ - "adresseerbareobjecten" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "key": "nummeraanduidingIdentificatie", - "value": "", - "description": "Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - }, - { - "disabled": false, - "key": "pandIdentificatie", - "value": "", - "description": "Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - }, - { - "disabled": false, - "key": "expand", - "value": "", - "description": "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature)." - }, - { - "disabled": false, - "key": "fields", - "value": "", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)" - }, - { - "disabled": false, - "key": "page", - "value": "1", - "description": "Pagina nummer" - }, - { - "disabled": false, - "key": "pageSize", - "value": "20" - }, - { - "disabled": false, - "key": "pandIdentificaties", - "value": "", - "description": "Een lijst met identificaties van panden uit de BAG." - }, - { - "disabled": false, - "key": "geconstateerd", - "value": "", - "description": "Geeft aan of naar geconstateerde objecten moet worden gezocht." - }, - { - "disabled": false, - "key": "type", - "value": "", - "description": "Geeft aan of het adresseerbaar object een ligplaats, standplaats of verblijfsobject is." - }, - { - "disabled": false, - "key": "gebruiksdoelen", - "value": "", - "description": "De gebruiksdoelen van het verblijfsobject zoals in de vergunning is opgenomen of bij constatering is vastgesteld. Als een verblijfsobject één van de gebruiksdoelen in deze lijst heeft, dan wordt het verblijfsobject in het zoekresultaat meegenomen." - }, - { - "disabled": false, - "key": "bbox", - "value": ",,,", - "description": "Rechthoek waarbinnen het object dat je zoekt valt. Objecten die de rand van de rechthoek raken of kruisen worden in het zoekresultaat meegenomen. Voor 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). In tegenstelling tot wat er in de OGC API Features specificatie staat, wordt hier geen bbox-crs parameter maar de contentCrs parameter gebruikt om aan te geven in welk CRS de coördinaten van de bbox zijn. Daarnaast kan er alleen met 2D coördinaten worden gezocht. De oppervlakte van de bounding box mag maximaal 250 duizend vierkante meter zijn." - }, - { - "disabled": false, - "key": "oppervlakte[min]", - "value": "", - "description": "Geef de minimale en maximale oppervlakte op waarbinnen je wilt zoeken (in m2). Alleen verblijfsobjecten hebben een oppervlakte en kunnen met deze parameter worden gevonden. Ligplaatsen en standplaatsen hebben geen oppervlakte en kunnen met deze parameter niet worden gevonden. De oppervlakte van een verblijfsobject is een natuurlijk getal tussen 1 (minimaal) en 999999 (maximaal). Het is niet toegestaan voor min een grotere waarde op te geven dan voor max. Is min > max dan treedt een foutmelding op. Bv: oppervlakte[min]=100&oppervlakte[max]=200" - }, - { - "disabled": false, - "key": "oppervlakte[max]", - "value": "", - "description": "Geef de minimale en maximale oppervlakte op waarbinnen je wilt zoeken (in m2). Alleen verblijfsobjecten hebben een oppervlakte en kunnen met deze parameter worden gevonden. Ligplaatsen en standplaatsen hebben geen oppervlakte en kunnen met deze parameter niet worden gevonden. De oppervlakte van een verblijfsobject is een natuurlijk getal tussen 1 (minimaal) en 999999 (maximaal). Het is niet toegestaan voor min een grotere waarde op te geven dan voor max. Is min > max dan treedt een foutmelding op. Bv: oppervlakte[min]=100&oppervlakte[max]=200" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "X-Api-Key" - }, - { - "key": "value", - "value": "" - }, - { - "key": "in", - "value": "header" - } - ] - } - }, - "response": [ - { - "id": "046b330e-1032-46c2-9ec3-b904cb6dc74f", - "name": "Geslaagd", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "pandIdentificaties", - "value": "0226100000008856" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "type", - "value": "" - }, - { - "key": "gebruiksdoelen", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "oppervlakte[min]", - "value": "" - }, - { - "key": "oppervlakte[max]", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "disabled": false, - "key": "X-Pagination-Page", - "value": "3", - "description": "" - }, - { - "disabled": false, - "key": "X-Pagination-Limit", - "value": "20", - "description": "" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"_embedded\": {\n \"adresseerbareObjecten\": [\n {\n \"identificatie\": \"0226010000038820\",\n \"domein\": \"fugiat\",\n \"type\": \"ligplaats\",\n \"documentdatum\": \"1978-03-30\",\n \"documentnummer\": \"19SZ2048\",\n \"gebruiksdoelen\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"geconstateerd\": true,\n \"geometrie\": {\n \"punt\": {\n \"value\": \"\"\n },\n \"vlak\": {\n \"value\": \"\"\n }\n },\n \"pandIdentificaties\": [\n \"0226100000008856\"\n ],\n \"nummeraanduidingIdentificaties\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"oppervlakte\": -46651375,\n \"status\": \"Verblijfsobject in gebruik (niet ingemeten)\",\n \"mogelijkOnjuist\": {\n \"gebruiksdoelen\": {\n \"value\": \"\"\n },\n \"geometrie\": {\n \"value\": \"\"\n },\n \"nummeraanduidingIdentificaties\": {\n \"value\": \"\"\n },\n \"pandIdentificaties\": {\n \"value\": \"\"\n },\n \"oppervlakte\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"toelichting\": {\n \"value\": \"\"\n }\n },\n \"_links\": {\n \"adressen\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"panden\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"commodo Excepteur dolore Lorem\"\n }\n },\n \"_embedded\": {\n \"adressen\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"panden\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"identificatie\": \"0226010000038820\",\n \"domein\": \"in dolor cupidatat veniam dolore\",\n \"type\": \"verblijfsobject\",\n \"documentdatum\": \"1983-08-15\",\n \"documentnummer\": \"19SZ2048\",\n \"gebruiksdoelen\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"geconstateerd\": true,\n \"geometrie\": {\n \"punt\": {\n \"value\": \"\"\n },\n \"vlak\": {\n \"value\": \"\"\n }\n },\n \"pandIdentificaties\": [\n \"0226100000008856\"\n ],\n \"nummeraanduidingIdentificaties\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"oppervlakte\": 73421697,\n \"status\": \"Verblijfsobject buiten gebruik\",\n \"mogelijkOnjuist\": {\n \"gebruiksdoelen\": {\n \"value\": \"\"\n },\n \"geometrie\": {\n \"value\": \"\"\n },\n \"nummeraanduidingIdentificaties\": {\n \"value\": \"\"\n },\n \"pandIdentificaties\": {\n \"value\": \"\"\n },\n \"oppervlakte\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"toelichting\": {\n \"value\": \"\"\n }\n },\n \"_links\": {\n \"adressen\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"panden\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"esse voluptate dolor\"\n }\n },\n \"_embedded\": {\n \"adressen\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"panden\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n }\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": {\n \"value\": \"\"\n },\n \"templated\": false,\n \"title\": \"nisi sed sint et minim\"\n },\n \"first\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"ipsum ullamco Ut\"\n },\n \"previous\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"exercitation et\"\n },\n \"next\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"fugiat incididunt est\"\n },\n \"last\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"laborum cupidatat cillum\"\n }\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "08ade218-c974-4506-8890-1f10951992dc", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "pandIdentificaties", - "value": "0226100000008856" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "type", - "value": "" - }, - { - "key": "gebruiksdoelen", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "oppervlakte[min]", - "value": "" - }, - { - "key": "oppervlakte[max]", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "0ddcaf36-89ea-44a5-a42d-d0fa1c3d027b", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "pandIdentificaties", - "value": "0226100000008856" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "type", - "value": "" - }, - { - "key": "gebruiksdoelen", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "oppervlakte[min]", - "value": "" - }, - { - "key": "oppervlakte[max]", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"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.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "4e87411e-4fe9-4126-8667-227011d34856", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "pandIdentificaties", - "value": "0226100000008856" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "type", - "value": "" - }, - { - "key": "gebruiksdoelen", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "oppervlakte[min]", - "value": "" - }, - { - "key": "oppervlakte[max]", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "c80beddd-af89-422c-a32f-989af3b45188", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "pandIdentificaties", - "value": "0226100000008856" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "type", - "value": "" - }, - { - "key": "gebruiksdoelen", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "oppervlakte[min]", - "value": "" - }, - { - "key": "oppervlakte[max]", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "5708ad35-1e21-4492-9f88-5c6cdc649ecf", - "name": "Precondition failed", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "pandIdentificaties", - "value": "0226100000008856" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "type", - "value": "" - }, - { - "key": "gebruiksdoelen", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "oppervlakte[min]", - "value": "" - }, - { - "key": "oppervlakte[max]", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Precondition Failed", - "code": 412, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13\",\n \"title\": \"Precondition Failed\",\n \"status\": 412,\n \"detail\": \"The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"preconditionFailed\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "451960d1-ed97-4504-bf9c-048ec12b6072", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "pandIdentificaties", - "value": "0226100000008856" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "type", - "value": "" - }, - { - "key": "gebruiksdoelen", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "oppervlakte[min]", - "value": "" - }, - { - "key": "oppervlakte[max]", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "be644375-3dca-4e97-ad92-964a0b2e0cf3", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "pandIdentificaties", - "value": "0226100000008856" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "type", - "value": "" - }, - { - "key": "gebruiksdoelen", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "oppervlakte[min]", - "value": "" - }, - { - "key": "oppervlakte[max]", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "72c3eee5-e7d4-41b3-9ca4-feba77aeb3e9", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "pandIdentificatie", - "value": "0226100000008856" - }, - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - }, - { - "key": "pandIdentificaties", - "value": "0226100000008856" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "type", - "value": "" - }, - { - "key": "gebruiksdoelen", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "oppervlakte[min]", - "value": "" - }, - { - "key": "oppervlakte[max]", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"http://ifgfzjkLxFOtwWOCgCs.lsqPXNjyKQsryzYfL7D\",\n \"title\": \"ex\",\n \"status\": -62408852,\n \"detail\": \"dolor ad\",\n \"instance\": \"https://GkMDQWZiYItdkUMeIAHnBkJhqBAuhJhWq.pscAOX5Eey8IhuySMMXgTRVYvDoJZlC9YuoEvckd7hLZhriY+F97NuY\",\n \"code\": \"ut\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - }, - { - "id": "42fc597b-e25b-4225-b639-f845cac989cc", - "name": "levert een verblijfsobject, standplaats of ligplaats", - "request": { - "name": "levert een verblijfsobject, standplaats of ligplaats", - "description": { - "content": "Raadpleeg een actueel adresseerbaar object met de identificatie. Dit is de identificatie van een verblijfsobject, ligplaats of standplaats. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). Gebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources adres en pand, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature).", - "type": "text/plain" - }, - "url": { - "path": [ - "adresseerbareobjecten", - ":adresseerbaarobjectidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "key": "expand", - "value": "", - "description": "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature)." - }, - { - "disabled": false, - "key": "fields", - "value": "", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "adresseerbaarobjectidentificatie", - "description": "(Required) De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - } - ] - }, - "header": [ - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "X-Api-Key" - }, - { - "key": "value", - "value": "" - }, - { - "key": "in", - "value": "header" - } - ] - } - }, - "response": [ - { - "id": "159ca359-80da-4568-90bc-6aa156a551c4", - "name": "Geslaagd", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten", - ":adresseerbaarobjectidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "adresseerbaarobjectidentificatie", - "description": "(Required) De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"identificatie\": \"0226010000038820\",\n \"domein\": \"sed commodo id mollit\",\n \"type\": \"\",\n \"documentdatum\": \"1988-05-04\",\n \"documentnummer\": \"19SZ2048\",\n \"gebruiksdoelen\": [\n \"\",\n \"\"\n ],\n \"geconstateerd\": true,\n \"geometrie\": {\n \"punt\": {\n \"coordinates\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"Point\"\n },\n \"vlak\": {\n \"coordinates\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"Polygon\"\n }\n },\n \"pandIdentificaties\": [\n \"0226100000008856\"\n ],\n \"nummeraanduidingIdentificaties\": [\n {\n \"nummeraanduidingIdentificatie\": \"0226200000038923\",\n \"isNevenadres\": true\n },\n {\n \"nummeraanduidingIdentificatie\": \"0226200000038923\",\n \"isNevenadres\": true\n }\n ],\n \"oppervlakte\": -39911415,\n \"status\": \"Verblijfsobject gevormd\",\n \"mogelijkOnjuist\": {\n \"gebruiksdoelen\": true,\n \"geometrie\": false,\n \"nummeraanduidingIdentificaties\": false,\n \"pandIdentificaties\": false,\n \"oppervlakte\": true,\n \"status\": false,\n \"toelichting\": [\n \"Locatie/contour mogelijk onjuist.\",\n \"Locatie/contour mogelijk onjuist.\"\n ]\n },\n \"_links\": {\n \"adressen\": [\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"deserunt sunt consectetur Duis\"\n },\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"elit dolor\"\n }\n ],\n \"panden\": [\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"ipsum tempor reprehenderit ullamco\"\n },\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"\"\n }\n ],\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"officia Ut non\"\n }\n },\n \"_embedded\": {\n \"adressen\": [\n {\n \"straat\": \"Laan van de landinrichtingscommissie Duiven-Westervoort\",\n \"huisnummer\": 1,\n \"huisletter\": \"A\",\n \"huisnummertoevoeging\": \"bis\",\n \"postcode\": \"6922KZ\",\n \"woonplaats\": \"Duiven\",\n \"adresregel1\": \"Ln vd l D-Westervoort 1\",\n \"adresregel2\": \"6922 KZ DUIVEN\",\n \"korteNaam\": \"Ln vd l D-Westervoort\",\n \"nummeraanduidingIdentificatie\": \"0226200000038923\",\n \"openbareRuimteIdentificatie\": \"0226300000136166\",\n \"woonplaatsIdentificatie\": \"2096\",\n \"adresseerbaarObjectIdentificatie\": \"0226010000038820\",\n \"pandIdentificaties\": [\n \"0226100000008856\"\n ],\n \"isNevenadres\": true,\n \"geconstateerd\": false,\n \"mogelijkOnjuist\": {\n \"adresregel1\": true,\n \"adresregel2\": true,\n \"korteNaam\": false,\n \"straat\": false,\n \"huisnummer\": true,\n \"huisletter\": true,\n \"huisnummertoevoeging\": true,\n \"postcode\": false,\n \"woonplaats\": false,\n \"nummeraanduidingIdentificatie\": false,\n \"openbareRuimteIdentificatie\": false,\n \"woonplaatsIdentificatie\": false,\n \"toelichting\": [\n \"Geometrie of woonplaatsgrens is mogelijk onjuist, waardoor gaten of overlappingen ontstaan in de registratie van woonplaatsen. Gevolg kan zijn dat een object in een verkeerde woonplaats, in twee woonplaatsen, of in geen enkele woonplaats ligt.\",\n \"Geometrie of woonplaatsgrens is mogelijk onjuist, waardoor gaten of overlappingen ontstaan in de registratie van woonplaatsen. Gevolg kan zijn dat een object in een verkeerde woonplaats, in twee woonplaatsen, of in geen enkele woonplaats ligt.\"\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"adipisicing incididunt \"\n },\n \"openbareRuimte\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"ad Ut consequat\"\n },\n \"nummeraanduiding\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"et\"\n },\n \"woonplaats\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"Lorem et eiusmod\"\n },\n \"adresseerbaarObject\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"ullamco dolor non adipisicing\"\n },\n \"panden\": [\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"est consequat voluptate\"\n },\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"Excepteur mollit officia Lorem\"\n }\n ]\n }\n },\n {\n \"straat\": \"Laan van de landinrichtingscommissie Duiven-Westervoort\",\n \"huisnummer\": 1,\n \"huisletter\": \"A\",\n \"huisnummertoevoeging\": \"bis\",\n \"postcode\": \"6922KZ\",\n \"woonplaats\": \"Duiven\",\n \"adresregel1\": \"Ln vd l D-Westervoort 1\",\n \"adresregel2\": \"6922 KZ DUIVEN\",\n \"korteNaam\": \"Ln vd l D-Westervoort\",\n \"nummeraanduidingIdentificatie\": \"0226200000038923\",\n \"openbareRuimteIdentificatie\": \"0226300000136166\",\n \"woonplaatsIdentificatie\": \"2096\",\n \"adresseerbaarObjectIdentificatie\": \"0226010000038820\",\n \"pandIdentificaties\": [\n \"0226100000008856\"\n ],\n \"isNevenadres\": true,\n \"geconstateerd\": false,\n \"mogelijkOnjuist\": {\n \"adresregel1\": false,\n \"adresregel2\": true,\n \"korteNaam\": false,\n \"straat\": true,\n \"huisnummer\": false,\n \"huisletter\": false,\n \"huisnummertoevoeging\": false,\n \"postcode\": false,\n \"woonplaats\": false,\n \"nummeraanduidingIdentificatie\": true,\n \"openbareRuimteIdentificatie\": false,\n \"woonplaatsIdentificatie\": false,\n \"toelichting\": [\n \"Geometrie of woonplaatsgrens is mogelijk onjuist, waardoor gaten of overlappingen ontstaan in de registratie van woonplaatsen. Gevolg kan zijn dat een object in een verkeerde woonplaats, in twee woonplaatsen, of in geen enkele woonplaats ligt.\",\n \"Geometrie of woonplaatsgrens is mogelijk onjuist, waardoor gaten of overlappingen ontstaan in de registratie van woonplaatsen. Gevolg kan zijn dat een object in een verkeerde woonplaats, in twee woonplaatsen, of in geen enkele woonplaats ligt.\"\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"aliquip consectetur\"\n },\n \"openbareRuimte\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"Duis dolor in\"\n },\n \"nummeraanduiding\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"mollit quis\"\n },\n \"woonplaats\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"culpa cupidatat\"\n },\n \"adresseerbaarObject\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"nisi sit\"\n },\n \"panden\": [\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"culpa\"\n },\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"ut incididunt ullamco dolor non\"\n }\n ]\n }\n }\n ],\n \"panden\": [\n {\n \"identificatie\": \"dolore\",\n \"domein\": \"laborum nostrud\",\n \"geometrie\": {\n \"coordinates\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"Polygon\"\n },\n \"oorspronkelijkBouwjaar\": 1991,\n \"status\": {\n \"value\": \"\"\n },\n \"geconstateerd\": true,\n \"documentdatum\": \"1978-03-03\",\n \"documentnummer\": \"09.BW.0273\",\n \"adresseerbaarObjectIdentificaties\": [\n \"0226010000038820\"\n ],\n \"nummeraanduidingIdentificaties\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"mogelijkOnjuist\": {\n \"value\": \"\"\n },\n \"_links\": {\n \"self\": {\n \"value\": \"\"\n },\n \"adressen\": {\n \"value\": \"\"\n },\n \"adresseerbareObjecten\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"identificatie\": \"nulla fugiat eiu\",\n \"domein\": \"non ipsum officia ut\",\n \"geometrie\": {\n \"coordinates\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": \"Polygon\"\n },\n \"oorspronkelijkBouwjaar\": 1991,\n \"status\": {\n \"value\": \"\"\n },\n \"geconstateerd\": true,\n \"documentdatum\": \"1960-04-13\",\n \"documentnummer\": \"09.BW.0273\",\n \"adresseerbaarObjectIdentificaties\": [\n \"0226010000038820\"\n ],\n \"nummeraanduidingIdentificaties\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"mogelijkOnjuist\": {\n \"value\": \"\"\n },\n \"_links\": {\n \"self\": {\n \"value\": \"\"\n },\n \"adressen\": {\n \"value\": \"\"\n },\n \"adresseerbareObjecten\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "2977ec94-5712-4896-a718-68589f710dfc", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten", - ":adresseerbaarobjectidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "adresseerbaarobjectidentificatie", - "description": "(Required) De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "4eb56939-11c0-47db-88a5-ed179341f9d9", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten", - ":adresseerbaarobjectidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "adresseerbaarobjectidentificatie", - "description": "(Required) De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"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.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "fce8740a-31e4-4c93-8041-b29587cb553a", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten", - ":adresseerbaarobjectidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "adresseerbaarobjectidentificatie", - "description": "(Required) De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "c973f1b0-9c50-4aec-a260-f5621e4023f2", - "name": "Not Found", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten", - ":adresseerbaarobjectidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "adresseerbaarobjectidentificatie", - "description": "(Required) De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5\",\n \"title\": \"Opgevraagde resource bestaat niet.\",\n \"status\": 404,\n \"detail\": \"The server has not found anything matching the Request-URI.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notFound\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "c7186203-9bd8-4e07-9a75-8c2e5e14a08d", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten", - ":adresseerbaarobjectidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "adresseerbaarobjectidentificatie", - "description": "(Required) De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "9e9f8f23-80b4-4c5f-960c-60eb892897ef", - "name": "Precondition failed", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten", - ":adresseerbaarobjectidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "adresseerbaarobjectidentificatie", - "description": "(Required) De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Precondition Failed", - "code": 412, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13\",\n \"title\": \"Precondition Failed\",\n \"status\": 412,\n \"detail\": \"The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"preconditionFailed\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "07e97de5-9fec-43f8-b8e5-d04a4c66c63e", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten", - ":adresseerbaarobjectidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "adresseerbaarobjectidentificatie", - "description": "(Required) De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "07a0c1d8-58ba-4af7-b442-022a29045e04", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten", - ":adresseerbaarobjectidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "adresseerbaarobjectidentificatie", - "description": "(Required) De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "5d76ef61-bd55-47ef-8538-642e9385556a", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "adresseerbareobjecten", - ":adresseerbaarobjectidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "adresseerbaarobjectidentificatie", - "description": "(Required) De identificatie van een adresserbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"http://ifgfzjkLxFOtwWOCgCs.lsqPXNjyKQsryzYfL7D\",\n \"title\": \"ex\",\n \"status\": -62408852,\n \"detail\": \"dolor ad\",\n \"instance\": \"https://GkMDQWZiYItdkUMeIAHnBkJhqBAuhJhWq.pscAOX5Eey8IhuySMMXgTRVYvDoJZlC9YuoEvckd7hLZhriY+F97NuY\",\n \"code\": \"ut\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - } - ], - "event": [] - }, - { - "id": "86cb8b1e-cd6d-4ec2-a90a-64e752d411a5", - "name": "levert BAG details van een woonplaats", - "request": { - "name": "levert BAG details van een woonplaats", - "description": { - "content": "Raadpleeg een actuele woonplaats met de identificatie. Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). Gebruik de expand-parameter als je het antwoord wil uitbreiden met de gerelateerde resource geometrie, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature).", - "type": "text/plain" - }, - "url": { - "path": [ - "woonplaatsen", - ":woonplaatsidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "key": "expand", - "value": "", - "description": "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature)." - }, - { - "disabled": false, - "key": "fields", - "value": "", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "woonplaatsidentificatie", - "description": "(Required) De identificatie van een woonplaats." - } - ] - }, - "header": [ - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "X-Api-Key" - }, - { - "key": "value", - "value": "" - }, - { - "key": "in", - "value": "header" - } - ] - } - }, - "response": [ - { - "id": "fa74d080-ecb8-440c-a4b8-a1dd192d77d3", - "name": "Geslaagd", - "originalRequest": { - "url": { - "path": [ - "woonplaatsen", - ":woonplaatsidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "woonplaatsidentificatie", - "description": "(Required) De identificatie van een woonplaats." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"identificatie\": \"sunt et qu\",\n \"domein\": \"in\",\n \"naam\": \"Duiven\",\n \"status\": \"Woonplaats aangewezen\",\n \"geconstateerd\": true,\n \"documentdatum\": \"1984-06-16\",\n \"documentnummer\": \"09.0898\",\n \"mogelijkOnjuist\": {\n \"naam\": true,\n \"geometrie\": false,\n \"status\": true,\n \"toelichting\": [\n \"Woonplaats bestaat mogelijk niet.\",\n \"Woonplaats bestaat mogelijk niet.\"\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"reprehenderit\"\n }\n },\n \"_embedded\": {\n \"geometrie\": {\n \"vlak\": {\n \"coordinates\": [\n [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n ],\n \"type\": \"Polygon\"\n },\n \"multivlak\": {\n \"coordinates\": [\n [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n ],\n \"type\": \"MultiPolygon\"\n }\n }\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "fd98d312-984f-4bc7-a94b-f765972854b6", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "woonplaatsen", - ":woonplaatsidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "woonplaatsidentificatie", - "description": "(Required) De identificatie van een woonplaats." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "db427bde-d31f-4fc8-97d1-6c14c9fd052a", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "woonplaatsen", - ":woonplaatsidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "woonplaatsidentificatie", - "description": "(Required) De identificatie van een woonplaats." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"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.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "69d05da9-2e6e-42f2-bd7d-753eaea8f50a", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "woonplaatsen", - ":woonplaatsidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "woonplaatsidentificatie", - "description": "(Required) De identificatie van een woonplaats." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "409967de-9f0f-409a-b430-2689c9cde6ea", - "name": "Not Found", - "originalRequest": { - "url": { - "path": [ - "woonplaatsen", - ":woonplaatsidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "woonplaatsidentificatie", - "description": "(Required) De identificatie van een woonplaats." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5\",\n \"title\": \"Opgevraagde resource bestaat niet.\",\n \"status\": 404,\n \"detail\": \"The server has not found anything matching the Request-URI.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notFound\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "d7ac95d3-19ba-40eb-a7bf-b953a8ae2784", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "woonplaatsen", - ":woonplaatsidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "woonplaatsidentificatie", - "description": "(Required) De identificatie van een woonplaats." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "b72076f0-d7fa-48b5-8402-c040f4de9a40", - "name": "Precondition failed", - "originalRequest": { - "url": { - "path": [ - "woonplaatsen", - ":woonplaatsidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "woonplaatsidentificatie", - "description": "(Required) De identificatie van een woonplaats." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Precondition Failed", - "code": 412, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13\",\n \"title\": \"Precondition Failed\",\n \"status\": 412,\n \"detail\": \"The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"preconditionFailed\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "2119df4f-8415-4105-8c1c-ebcd5e066ea9", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "woonplaatsen", - ":woonplaatsidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "woonplaatsidentificatie", - "description": "(Required) De identificatie van een woonplaats." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "d2e375be-2fc2-40f2-9ec2-2a60b4f716bb", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "woonplaatsen", - ":woonplaatsidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "woonplaatsidentificatie", - "description": "(Required) De identificatie van een woonplaats." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "b279a394-8062-4998-8da3-febc54d9f649", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "woonplaatsen", - ":woonplaatsidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "woonplaatsidentificatie", - "description": "(Required) De identificatie van een woonplaats." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"http://ifgfzjkLxFOtwWOCgCs.lsqPXNjyKQsryzYfL7D\",\n \"title\": \"ex\",\n \"status\": -62408852,\n \"detail\": \"dolor ad\",\n \"instance\": \"https://GkMDQWZiYItdkUMeIAHnBkJhqBAuhJhWq.pscAOX5Eey8IhuySMMXgTRVYvDoJZlC9YuoEvckd7hLZhriY+F97NuY\",\n \"code\": \"ut\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - }, - { - "id": "c1829d81-64e2-4d15-8d6d-71eac8939258", - "name": "levert BAG detals van een openbare ruimte", - "request": { - "name": "levert BAG detals van een openbare ruimte", - "description": { - "content": "Raadpleeg een actuele openbare ruimte met de identificatie. Een openbare ruimte is een buitenruimte met een naam die binnen één woonplaats ligt, bijvoorbeeld een straat of een plein. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).", - "type": "text/plain" - }, - "url": { - "path": [ - "openbareruimten", - ":openbareruimteidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "key": "fields", - "value": "", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "openbareruimteidentificatie", - "description": "(Required) Identificatie van een object uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "method": "GET", - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "X-Api-Key" - }, - { - "key": "value", - "value": "" - }, - { - "key": "in", - "value": "header" - } - ] - } - }, - "response": [ - { - "id": "dcd6d870-cda7-4a8b-9813-cc3f98d47115", - "name": "Geslaagd", - "originalRequest": { - "url": { - "path": [ - "openbareruimten", - ":openbareruimteidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "openbareruimteidentificatie", - "description": "(Required) Identificatie van een object uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"identificatie\": \"culpa adipisicing sint occaecat\",\n \"domein\": \"officia Duis cupidatat id\",\n \"naam\": \"Laan van de landinrichtingscommissie Duiven-Westervoort\",\n \"type\": \"Kunstwerk\",\n \"status\": \"Naamgeving uitgegeven\",\n \"korteNaam\": \"Ln vd l D-Westervoort\",\n \"geconstateerd\": true,\n \"documentdatum\": \"1975-09-13\",\n \"documentnummer\": \"BAG-21\",\n \"woonplaatsIdentificatie\": \"2096\",\n \"mogelijkOnjuist\": {\n \"naam\": true,\n \"korteNaam\": true,\n \"type\": true,\n \"status\": true,\n \"woonplaatsIdentificatie\": false,\n \"toelichting\": [\n \"Openbare ruimtenaam komt mogelijk niet overeen met de vermelding in het straatnaambesluit.\",\n \"Openbare ruimtenaam komt mogelijk niet overeen met de vermelding in het straatnaambesluit.\"\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"Excepteur eiusmod amet culpa\"\n },\n \"woonplaats\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"ut velit esse\"\n }\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "87e04e1d-4ce6-4e7f-81f4-2a35d6894e90", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "openbareruimten", - ":openbareruimteidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "openbareruimteidentificatie", - "description": "(Required) Identificatie van een object uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "6bcd6687-debe-4032-ac16-29a8db81f2d1", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "openbareruimten", - ":openbareruimteidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "openbareruimteidentificatie", - "description": "(Required) Identificatie van een object uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"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.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "b93e122b-188b-480b-b680-abe1c66d75b0", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "openbareruimten", - ":openbareruimteidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "openbareruimteidentificatie", - "description": "(Required) Identificatie van een object uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "72d28345-5055-4068-8629-7e2472bcee74", - "name": "Not Found", - "originalRequest": { - "url": { - "path": [ - "openbareruimten", - ":openbareruimteidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "openbareruimteidentificatie", - "description": "(Required) Identificatie van een object uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5\",\n \"title\": \"Opgevraagde resource bestaat niet.\",\n \"status\": 404,\n \"detail\": \"The server has not found anything matching the Request-URI.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notFound\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "886cbf05-e5a3-4f9b-bf0c-cec71eb89612", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "openbareruimten", - ":openbareruimteidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "openbareruimteidentificatie", - "description": "(Required) Identificatie van een object uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "55f82a96-752c-4495-8cd9-6ba2ab4b32d9", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "openbareruimten", - ":openbareruimteidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "openbareruimteidentificatie", - "description": "(Required) Identificatie van een object uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "00736381-7919-4645-81ad-834e1a4d812a", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "openbareruimten", - ":openbareruimteidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "openbareruimteidentificatie", - "description": "(Required) Identificatie van een object uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "e1018756-77ff-4929-9426-b7f94b8cd154", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "openbareruimten", - ":openbareruimteidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "openbareruimteidentificatie", - "description": "(Required) Identificatie van een object uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"http://ifgfzjkLxFOtwWOCgCs.lsqPXNjyKQsryzYfL7D\",\n \"title\": \"ex\",\n \"status\": -62408852,\n \"detail\": \"dolor ad\",\n \"instance\": \"https://GkMDQWZiYItdkUMeIAHnBkJhqBAuhJhWq.pscAOX5Eey8IhuySMMXgTRVYvDoJZlC9YuoEvckd7hLZhriY+F97NuY\",\n \"code\": \"ut\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - }, - { - "id": "cb0867b8-094d-4593-9ff6-0d089500d2b8", - "name": "levert BAG details van een nummeraanduiding", - "request": { - "name": "levert BAG details van een nummeraanduiding", - "description": { - "content": "Raadpleeg een actuele nummeraanduiding met de identificatie. Een nummeraanduiding is een postcode, huisnummer met evt een huisletter en huisnummertoevoeging die hoort bij een verblijfsobject, een standplaats of een ligplaats. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).", - "type": "text/plain" - }, - "url": { - "path": [ - "nummeraanduidingen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "key": "fields", - "value": "", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "method": "GET", - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "X-Api-Key" - }, - { - "key": "value", - "value": "" - }, - { - "key": "in", - "value": "header" - } - ] - } - }, - "response": [ - { - "id": "feaadc54-80ed-437c-aad1-944695b63b82", - "name": "Geslaagd", - "originalRequest": { - "url": { - "path": [ - "nummeraanduidingen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"identificatie\": \"ad id Excepteur\",\n \"domein\": \"dolor mollit commodo in voluptate\",\n \"huisnummer\": 1,\n \"huisletter\": \"A\",\n \"huisnummertoevoeging\": \"bis\",\n \"postcode\": \"6922KZ\",\n \"status\": \"Naamgeving uitgegeven\",\n \"geconstateerd\": false,\n \"documentdatum\": \"1965-03-11\",\n \"documentnummer\": \"Duiven 25112019\",\n \"woonplaatsIdentificatie\": \"2096\",\n \"openbareRuimteIdentificatie\": \"0226300000136166\",\n \"mogelijkOnjuist\": {\n \"huisnummer\": false,\n \"huisletter\": true,\n \"huisnummertoevoeging\": false,\n \"postcode\": true,\n \"status\": false,\n \"woonplaatsIdentificatie\": false,\n \"openbareRuimteIdentificatie\": true,\n \"toelichting\": [\n \"Woonplaats bestaat mogelijk niet.\",\n \"Woonplaats bestaat mogelijk niet.\"\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"nisi\"\n },\n \"adres\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"Lor\"\n },\n \"openbareRuimte\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"officia proident ut sit tempor\"\n },\n \"woonplaats\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"sint cillum deserunt\"\n }\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "6a47a339-489f-4c3d-b29e-6a4cf5f945ce", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "nummeraanduidingen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "5a7db414-479f-4279-865d-ea40d5b7c063", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "nummeraanduidingen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"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.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "81c328f1-d701-4649-a0a5-6781e4da5d50", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "nummeraanduidingen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "feb60cee-abeb-4b1c-9e01-3cd13d45e0f1", - "name": "Not Found", - "originalRequest": { - "url": { - "path": [ - "nummeraanduidingen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5\",\n \"title\": \"Opgevraagde resource bestaat niet.\",\n \"status\": 404,\n \"detail\": \"The server has not found anything matching the Request-URI.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notFound\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "08f96c67-7991-429f-88c3-fa68fe6cf689", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "nummeraanduidingen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "e1c809f7-dc2b-4808-80a1-76d7d5a54683", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "nummeraanduidingen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "c29cb98f-dabd-4956-9e1d-68134a4fd87a", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "nummeraanduidingen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "f82d60bb-ef53-4f3e-8d69-48e16a6688ba", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "nummeraanduidingen", - ":nummeraanduidingidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "nummeraanduidingidentificatie", - "description": "(Required) Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"http://ifgfzjkLxFOtwWOCgCs.lsqPXNjyKQsryzYfL7D\",\n \"title\": \"ex\",\n \"status\": -62408852,\n \"detail\": \"dolor ad\",\n \"instance\": \"https://GkMDQWZiYItdkUMeIAHnBkJhqBAuhJhWq.pscAOX5Eey8IhuySMMXgTRVYvDoJZlC9YuoEvckd7hLZhriY+F97NuY\",\n \"code\": \"ut\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - }, - { - "id": "e1c29fa7-dac1-407e-ba8a-b5f9dd96d55b", - "name": "panden", - "item": [ - { - "id": "4e2e20b6-2ec2-4f0d-b357-b6f0044d00b2", - "name": "vindt panden", - "request": { - "name": "vindt panden", - "description": { - "content": "Zoek actuele panden:\n1. met de identificatie van een adresseerbaar object of\n2. met de identificatie van een nummeraanduiding of\n3. met een locatie (punt) of \n4. binnen een geometrische contour (rechthoek) die voldoen aan de opgegeven status, geconstateerd of bouwjaar.\n\nGebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).", - "type": "text/plain" - }, - "url": { - "path": [ - "panden" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "key": "adresseerbaarObjectIdentificatie", - "value": "", - "description": "De identificatie van een adresseerbaar object uit de BAG. Deze is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats zijn." - }, - { - "disabled": false, - "key": "nummeraanduidingIdentificatie", - "value": "", - "description": "Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang." - }, - { - "disabled": false, - "key": "locatie", - "value": ",", - "description": "Coördinaten van een locatie die als query-parameter gebruikt wordt om een object te zoeken. Let op, explode is false dus het formaat is ?locatie=196733.51,439931.89" - }, - { - "disabled": false, - "key": "fields", - "value": "", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)" - }, - { - "disabled": false, - "key": "bbox", - "value": ",,,", - "description": "Rechthoek waarbinnen het object dat je zoekt valt. Objecten die de rand van de rechthoek raken of kruisen worden in het zoekresultaat meegenomen. Voor 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). In tegenstelling tot wat er in de OGC API Features specificatie staat, wordt hier geen bbox-crs parameter maar de contentCrs parameter gebruikt om aan te geven in welk CRS de coördinaten van de bbox zijn. Daarnaast kan er alleen met 2D coördinaten worden gezocht. De oppervlakte van de bounding box mag maximaal 250 duizend vierkante meter zijn." - }, - { - "disabled": false, - "key": "statusPand", - "value": "", - "description": "Status van het pand." - }, - { - "disabled": false, - "key": "geconstateerd", - "value": "", - "description": "Geeft aan of naar geconstateerde objecten moet worden gezocht." - }, - { - "disabled": false, - "key": "bouwjaar[min]", - "value": "", - "description": "Bouwjaar van het pand. Geeft het minimale en/of maximale bouwjaar aan van het pand waarnaar moet worden gezocht. Een bouwjaar is een natuurlijk getal tussen 0 (minimaal) en 9999 (maximaal). Bv: bouwjaar[min]=1970&bouwjaar[max]=2010" - }, - { - "disabled": false, - "key": "bouwjaar[max]", - "value": "", - "description": "Bouwjaar van het pand. Geeft het minimale en/of maximale bouwjaar aan van het pand waarnaar moet worden gezocht. Een bouwjaar is een natuurlijk getal tussen 0 (minimaal) en 9999 (maximaal). Bv: bouwjaar[min]=1970&bouwjaar[max]=2010" - }, - { - "disabled": false, - "key": "page", - "value": "1", - "description": "Pagina nummer" - }, - { - "disabled": false, - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "X-Api-Key" - }, - { - "key": "value", - "value": "" - }, - { - "key": "in", - "value": "header" - } - ] - } - }, - "response": [ - { - "id": "856aa90b-dacb-4504-b262-ca53851c3995", - "name": "Geslaagd", - "originalRequest": { - "url": { - "path": [ - "panden" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "locatie", - "value": "196733.51,439931.89" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "statusPand", - "value": "" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "bouwjaar[min]", - "value": "" - }, - { - "key": "bouwjaar[max]", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "disabled": false, - "key": "X-Pagination-Page", - "value": "3", - "description": "" - }, - { - "disabled": false, - "key": "X-Pagination-Limit", - "value": "20", - "description": "" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"_links\": {\n \"self\": {\n \"href\": {\n \"value\": \"\"\n },\n \"templated\": true,\n \"title\": \"quis\"\n },\n \"first\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"proident\"\n },\n \"previous\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"non\"\n },\n \"next\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"culpa aliquip\"\n },\n \"last\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"aliquip\"\n }\n },\n \"_embedded\": {\n \"panden\": [\n {\n \"identificatie\": \"officia anim ipsum\",\n \"domein\": \"anim ex\",\n \"geometrie\": {\n \"coordinates\": [\n [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n ],\n \"type\": \"Polygon\"\n },\n \"oorspronkelijkBouwjaar\": 1991,\n \"status\": \"\",\n \"geconstateerd\": false,\n \"documentdatum\": \"1998-12-27\",\n \"documentnummer\": \"09.BW.0273\",\n \"adresseerbaarObjectIdentificaties\": [\n \"0226010000038820\"\n ],\n \"nummeraanduidingIdentificaties\": [\n {\n \"nummeraanduidingIdentificatie\": \"0226200000038923\",\n \"isNevenadres\": false\n },\n {\n \"nummeraanduidingIdentificatie\": \"0226200000038923\",\n \"isNevenadres\": true\n }\n ],\n \"mogelijkOnjuist\": {\n \"geometrie\": {\n \"value\": \"\"\n },\n \"oorspronkelijkBouwjaar\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"toelichting\": {\n \"value\": \"\"\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"dolor in \"\n },\n \"adressen\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"adresseerbareObjecten\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"identificatie\": \"dolore occaecat do aliqua est\",\n \"domein\": \"nisi sunt irure\",\n \"geometrie\": {\n \"coordinates\": [\n [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n ],\n \"type\": \"Polygon\"\n },\n \"oorspronkelijkBouwjaar\": 1991,\n \"status\": \"\",\n \"geconstateerd\": false,\n \"documentdatum\": \"2009-03-30\",\n \"documentnummer\": \"09.BW.0273\",\n \"adresseerbaarObjectIdentificaties\": [\n \"0226010000038820\"\n ],\n \"nummeraanduidingIdentificaties\": [\n {\n \"nummeraanduidingIdentificatie\": \"0226200000038923\",\n \"isNevenadres\": true\n },\n {\n \"nummeraanduidingIdentificatie\": \"0226200000038923\",\n \"isNevenadres\": false\n }\n ],\n \"mogelijkOnjuist\": {\n \"geometrie\": {\n \"value\": \"\"\n },\n \"oorspronkelijkBouwjaar\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"toelichting\": {\n \"value\": \"\"\n }\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"incididunt amet\"\n },\n \"adressen\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"adresseerbareObjecten\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n }\n ]\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "2ad763d8-189d-4b42-8424-8a64f9a7ae2d", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "panden" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "locatie", - "value": "196733.51,439931.89" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "statusPand", - "value": "" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "bouwjaar[min]", - "value": "" - }, - { - "key": "bouwjaar[max]", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "ca54be1e-15d3-4de1-82e3-cb6045c00021", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "panden" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "locatie", - "value": "196733.51,439931.89" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "statusPand", - "value": "" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "bouwjaar[min]", - "value": "" - }, - { - "key": "bouwjaar[max]", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"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.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "04917b34-e3b2-431b-a5c5-f2215235408d", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "panden" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "locatie", - "value": "196733.51,439931.89" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "statusPand", - "value": "" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "bouwjaar[min]", - "value": "" - }, - { - "key": "bouwjaar[max]", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "3a531dd7-fc30-45b5-86d2-264769bf0488", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "panden" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "locatie", - "value": "196733.51,439931.89" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "statusPand", - "value": "" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "bouwjaar[min]", - "value": "" - }, - { - "key": "bouwjaar[max]", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "baf262df-137e-4c90-b684-be85ea8fd77a", - "name": "Precondition failed", - "originalRequest": { - "url": { - "path": [ - "panden" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "locatie", - "value": "196733.51,439931.89" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "statusPand", - "value": "" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "bouwjaar[min]", - "value": "" - }, - { - "key": "bouwjaar[max]", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Precondition Failed", - "code": 412, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13\",\n \"title\": \"Precondition Failed\",\n \"status\": 412,\n \"detail\": \"The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"preconditionFailed\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "9f3ae716-228f-4398-ac41-366d333be657", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "panden" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "locatie", - "value": "196733.51,439931.89" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "statusPand", - "value": "" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "bouwjaar[min]", - "value": "" - }, - { - "key": "bouwjaar[max]", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "c2075f22-a770-413a-b020-ab87d64ba148", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "panden" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "locatie", - "value": "196733.51,439931.89" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "statusPand", - "value": "" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "bouwjaar[min]", - "value": "" - }, - { - "key": "bouwjaar[max]", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "54971211-6b76-4d24-a60e-b4185ea0e1fe", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "panden" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "adresseerbaarObjectIdentificatie", - "value": "0226010000038820" - }, - { - "key": "nummeraanduidingIdentificatie", - "value": "0226200000038923" - }, - { - "key": "locatie", - "value": "196733.51,439931.89" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "bbox", - "value": "196733.51,439931.89,196833.51,440031.89" - }, - { - "key": "statusPand", - "value": "" - }, - { - "key": "geconstateerd", - "value": "" - }, - { - "key": "bouwjaar[min]", - "value": "" - }, - { - "key": "bouwjaar[max]", - "value": "" - }, - { - "key": "page", - "value": "1" - }, - { - "key": "pageSize", - "value": "20" - } - ], - "variable": [] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"http://ifgfzjkLxFOtwWOCgCs.lsqPXNjyKQsryzYfL7D\",\n \"title\": \"ex\",\n \"status\": -62408852,\n \"detail\": \"dolor ad\",\n \"instance\": \"https://GkMDQWZiYItdkUMeIAHnBkJhqBAuhJhWq.pscAOX5Eey8IhuySMMXgTRVYvDoJZlC9YuoEvckd7hLZhriY+F97NuY\",\n \"code\": \"ut\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - }, - { - "id": "b08ad7ae-171d-4426-aa26-e3cca01c1de3", - "name": "levert een pand", - "request": { - "name": "levert een pand", - "description": { - "content": "Raadpleeg een actueel pand met de identificatie. Een pand is een bouwkundige, constructief zelfstandige eenheid die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar is. Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).", - "type": "text/plain" - }, - "url": { - "path": [ - "panden", - ":pandidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "key": "fields", - "value": "", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "pandidentificatie", - "description": "(Required) Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "X-Api-Key" - }, - { - "key": "value", - "value": "" - }, - { - "key": "in", - "value": "header" - } - ] - } - }, - "response": [ - { - "id": "00e8864c-c708-45b8-b8da-fc9176eb5996", - "name": "Geslaagd", - "originalRequest": { - "url": { - "path": [ - "panden", - ":pandidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "pandidentificatie", - "description": "(Required) Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "disabled": false, - "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "key": "Content-Crs", - "value": "epsg:28992" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"identificatie\": \"nisi consequat proident\",\n \"domein\": \"eiusmod sit qui est consequat\",\n \"geometrie\": {\n \"coordinates\": [\n [\n [\n 47787138.59600687,\n -65366626.96491415\n ],\n [\n 15781760.178339794,\n 72736059.03779104\n ],\n [\n -97707343.61939692,\n 42244855.78943345\n ],\n [\n -23691162.723395288,\n 50411770.96481535\n ]\n ],\n [\n [\n -97522430.40498474,\n -50051521.71728056\n ],\n [\n -97257134.31637818,\n -280127.55446851254\n ],\n [\n -11080513.316905096,\n 84034107.15475604\n ],\n [\n 23940987.01624103,\n 39930158.65523356\n ]\n ]\n ],\n \"type\": \"Polygon\"\n },\n \"oorspronkelijkBouwjaar\": 1991,\n \"status\": \"\",\n \"geconstateerd\": true,\n \"documentdatum\": \"1998-02-21\",\n \"documentnummer\": \"09.BW.0273\",\n \"adresseerbaarObjectIdentificaties\": [\n \"0226010000038820\"\n ],\n \"nummeraanduidingIdentificaties\": [\n {\n \"nummeraanduidingIdentificatie\": \"0226200000038923\",\n \"isNevenadres\": true\n },\n {\n \"nummeraanduidingIdentificatie\": \"0226200000038923\",\n \"isNevenadres\": true\n }\n ],\n \"mogelijkOnjuist\": {\n \"geometrie\": true,\n \"oorspronkelijkBouwjaar\": false,\n \"status\": true,\n \"toelichting\": [\n \"Mogelijk is de bouw al gereed of is het pand niet gerealiseerd.\",\n \"Mogelijk is de bouw al gereed of is het pand niet gerealiseerd.\"\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"enim velit sed eiusmod\"\n },\n \"adressen\": [\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"aliquip Duis esse \"\n },\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"voluptate eiusmod\"\n }\n ],\n \"adresseerbareObjecten\": [\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"sed\"\n },\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"ea\"\n }\n ]\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "c30ddd83-ba7b-48d9-b048-e9bb3eca1b67", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "panden", - ":pandidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "pandidentificatie", - "description": "(Required) Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "2b77b01b-445f-4d57-8e42-a8e611e84de3", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "panden", - ":pandidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "pandidentificatie", - "description": "(Required) Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"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.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "91b637c8-fbff-437f-9dda-88cee9f66a50", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "panden", - ":pandidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "pandidentificatie", - "description": "(Required) Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "9766f8a4-9dc2-4ddb-b8fa-9914b0ec320f", - "name": "Not Found", - "originalRequest": { - "url": { - "path": [ - "panden", - ":pandidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "pandidentificatie", - "description": "(Required) Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5\",\n \"title\": \"Opgevraagde resource bestaat niet.\",\n \"status\": 404,\n \"detail\": \"The server has not found anything matching the Request-URI.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notFound\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "3eccaa69-5466-4c16-8c24-4679063cef26", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "panden", - ":pandidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "pandidentificatie", - "description": "(Required) Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "e82520b4-eaf5-488a-874a-bb05270a6337", - "name": "Precondition failed", - "originalRequest": { - "url": { - "path": [ - "panden", - ":pandidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "pandidentificatie", - "description": "(Required) Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Precondition Failed", - "code": 412, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13\",\n \"title\": \"Precondition Failed\",\n \"status\": 412,\n \"detail\": \"The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"preconditionFailed\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "5dba9807-50bc-4695-a829-63c35c207ba0", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "panden", - ":pandidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "pandidentificatie", - "description": "(Required) Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "57e9ff24-22fe-4543-aeeb-eee71864c51e", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "panden", - ":pandidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "pandidentificatie", - "description": "(Required) Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "dfcc85c5-9141-43cb-84eb-5e1ad3bc2aa4", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "panden", - ":pandidentificatie" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "pandidentificatie", - "description": "(Required) Identificatie van een pand uit de BAG. Deze is 16 cijfers lang." - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-Api-Key", - "value": "" - }, - { - "disabled": false, - "description": "Gewenste CRS van de coördinaten in de response.", - "key": "Accept-Crs", - "value": "epsg:28992" - } - ], - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"http://ifgfzjkLxFOtwWOCgCs.lsqPXNjyKQsryzYfL7D\",\n \"title\": \"ex\",\n \"status\": -62408852,\n \"detail\": \"dolor ad\",\n \"instance\": \"https://GkMDQWZiYItdkUMeIAHnBkJhqBAuhJhWq.pscAOX5Eey8IhuySMMXgTRVYvDoJZlC9YuoEvckd7hLZhriY+F97NuY\",\n \"code\": \"ut\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - } - ], - "event": [] - } - ], - "event": [], - "variable": [ - { - "type": "string", - "value": "https://api.bag.acceptatie.kadaster.nl/esd/huidigebevragingen/v1", - "key": "baseUrl" - } - ], - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "X-Api-Key" - }, - { - "key": "value", - "value": "" - }, - { - "key": "in", - "value": "header" - } - ] - }, - "info": { - "_postman_id": "93aa48f8-0dc6-4d3e-8277-ba4fc4b04c29", - "name": "Huidige bevragingen API", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "description": { - "content": "Deze API levert actuele gegevens over adressen, adresseerbare objecten en panden. Actueel betekent in deze API `zonder eindstatus`. De bron voor deze API is de basisregistratie adressen en gebouwen (BAG).\n\nContact Support:\n Name: Kadaster - Beheerder Landelijke Voorziening BAG\n Email: bag@kadaster.nl", - "type": "text/plain" - } - } -} \ No newline at end of file From 43e04136f187141a7fff2e85b2b33cd911b2fe8b Mon Sep 17 00:00:00 2001 From: melsk-r Date: Mon, 22 Jan 2024 16:35:32 +0100 Subject: [PATCH 3/4] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2832122..2f8e289 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ +Onderliggende repository is tot eind 2023 onder de naam 'Haal-Centraal-BAG-bevragen' in gebruik geweest als project repsitory voor de Haal Centraal BAG Bevragen API. Deze API is echter halverwege 2023 vervangen door de BAG Individuele bevragingen API 2.0. De issues in deze repository, waaronder een flink aantal user stories, evenals de features en de documentatie blijven echter onverkort van toepassing. Voor de API specificaties, step definitions en testbestanden geldt dat niet en deze zijn dan ook in januari 2024 verwijderd. De API specificaties van de BAG Individuele bevragingen API worden in [deze respository](https://github.com/lvbag/BAG-API) beheerd. Als gevolg daarvan is de onderliggende repository hernoemd naar 'BAG-Gemeentelijke-wensen-tav-BAG-Bevragingen'. + BAG Individuele bevragingen is een API voor het zoeken en raadplegen van gegevens in de basisregistratie Adressen en Gebouwen voor alle binnengemeentelijke afnemers in NL, maar ook voor waterschappen, belastingsamenwerkingen en andere overheden. We doen ons uiterste best om de API evolvable door te ontwikkelen en geen breaking changes te introduceren. Bekijk de [release notes](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/releasenotes) van deze release. @@ -11,7 +13,7 @@ Bekijk de [release notes](https://vng-realisatie.github.io/Haal-Centraal-BAG-bev * Bekijk de specificaties met [Swagger UI](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/swagger-ui) of [Redoc](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/redoc) * Lees de [Getting started](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/getting-started) -* Download de [technische specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/blob/master/specificatie/genereervariant/openapi.yaml) +* Download de [technische specificaties](https://github.com/lvbag/BAG-API/blob/master/Technische%20specificatie/Archief/Yaml's/BAG%20API%20Individuele%20Bevragingen/resolved/individuelebevragingen/v2/openapi.yaml) * [Vraag een API-key aan](https://formulieren.kadaster.nl/aanvraag_bag_api_huidige_bevragingen_productie) voor toegang tot de productieomgeving. ## Bronnen From c5e7da8d6bd66a08169191dd9ce032da090b9080 Mon Sep 17 00:00:00 2001 From: melsk-r Date: Wed, 7 Feb 2024 08:42:29 +0100 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f8e289..0607510 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ -Onderliggende repository is tot eind 2023 onder de naam 'Haal-Centraal-BAG-bevragen' in gebruik geweest als project repsitory voor de Haal Centraal BAG Bevragen API. Deze API is echter halverwege 2023 vervangen door de BAG Individuele bevragingen API 2.0. De issues in deze repository, waaronder een flink aantal user stories, evenals de features en de documentatie blijven echter onverkort van toepassing. Voor de API specificaties, step definitions en testbestanden geldt dat niet en deze zijn dan ook in januari 2024 verwijderd. De API specificaties van de BAG Individuele bevragingen API worden in [deze respository](https://github.com/lvbag/BAG-API) beheerd. Als gevolg daarvan is de onderliggende repository hernoemd naar 'BAG-Gemeentelijke-wensen-tav-BAG-Bevragingen'. +Onderliggende repository is tot eind 2023 onder de naam 'Haal-Centraal-BAG-bevragen' in gebruik geweest als project repository voor de Haal Centraal BAG Bevragen API. Deze API is echter halverwege 2023 vervangen door de BAG Individuele bevragingen API 2.0. De issues in deze repository, waaronder een flink aantal user stories, evenals de features en de documentatie blijven echter onverkort van toepassing. Voor de API specificaties, step definitions en testbestanden geldt dat niet en deze zijn dan ook in januari 2024 verwijderd. De API specificaties van de BAG Individuele bevragingen API worden in [deze respository](https://github.com/lvbag/BAG-API) beheerd. Als gevolg daarvan is de onderliggende repository hernoemd naar 'BAG-Gemeentelijke-wensen-tav-BAG-Bevragingen'. BAG Individuele bevragingen is een API voor het zoeken en raadplegen van gegevens in de basisregistratie Adressen en Gebouwen voor alle binnengemeentelijke afnemers in NL, maar ook voor waterschappen, belastingsamenwerkingen en andere overheden. We doen ons uiterste best om de API evolvable door te ontwikkelen en geen breaking changes te introduceren.