diff --git a/docs/goals-canvas.md b/docs/goals-canvas.md index f32dcc58..b4a76bfb 100644 --- a/docs/goals-canvas.md +++ b/docs/goals-canvas.md @@ -6,7 +6,7 @@ title: Goals Canvas | PRIO | | WHATS | HOWS | INPUT | OUTPUT | GOALS | STORIES | |------|-|-------|------|-------|--------|--------|---------| -| 1 | | Zoeken uniek adres om adres, pand, verblijfsobject, standplaats, ligplaats, nummeraanduiding, openbare ruimte en woonplaats te vinden | fuzzy zoeken van een adres (search as you type, exact match) | free query op postcode, woonplaats, openbare ruimtenaam, huisnummer-letter-toevoeging, contour, coordinaat | verzameling adressen (adresstrings) | collectie adresstrings tonen zodat er 1 door client kan worden geselecteerd | [4](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/4){:target="_blank"} | +| 1 | | Zoeken uniek adres om adres, pand, verblijfsobject, standplaats, ligplaats, nummeraanduiding, openbare ruimte en woonplaats te vinden | fuzzy zoeken van een adres (search as you type, exact match) | free query op postcode, woonplaats, openbare ruimtenaam, huisnummer-letter-toevoeging | verzameling adressen (adresstrings) | collectie adresstrings tonen zodat er 1 door client kan worden geselecteerd | [4](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/4){:target="_blank"} | | 2 | | eigenschappen en relaties van een adres vinden, inclusief "in onderzoek" | selecteer een unieke adres uit een collectie adresstrings die matchen met invoer OF gebruik een nummeraanduidingIdentificatie (bijv. uit BRK of BRP). | adresstring + expand parameter(optioneel) OF nummeraanduidingIdentificatie + expandparameter (optioneel) | adres: verkorte openbare ruimtenaam, huisnr, huisl, huisnr.toevoeging, postcode, woonplaats (+embedded openbare ruimte, nummeraanduiding, woonplaats), geconstateerd, optionele boolean nevenadres en "in onderzoek" + relaties van het adres met de resources adresseerbaarObject en pand. | raadplegen 1. eigenschappen van adres met bijbehorende identificatie/links naar nummeraanduiding, openbare ruimte en woonplaats + 2. identificatie/links van gerelateerd verblijfsobject, standplaats, ligplaats en pand(en), om deze evt. te kunnen raadplegen. | [32](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/32){:target="_blank"}, [15](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/15){:target="_blank"}, [16](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/16){:target="_blank"}, [17](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/17){:target="_blank"}, [18](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/18){:target="_blank"} | | 3 | | eigenschappen (minimaal gebruiksdoel, geometrie, oppervlakte, brondocument, gecontateerd en in onderzoek) en relaties van adresseerbaar object vinden | raadpleeg adresseerbaar object en relaties, of zoeken obv een ID. Bijvoorbeeld uit een andere (basis)registratie | invoeren adresseerbaarObjectIdentificatie + expandparameter (optioneel) Queryparameters: nummeraanduidingIdentificatie en pandIdentificatie | adresseerbaarObject met eigenschappen en relaties met adres (embedded) en Pand (embedded). | eigenschappen en relaties adresseerbaarObject raadplegen | [11](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/11){:target="_blank"}, [8](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/8){:target="_blank"}, [7](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/7){:target="_blank"}, [6](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/6){:target="_blank"}, [13](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/13){:target="_blank"}, [9](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/9){:target="_blank"}, [5](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/5){:target="_blank"}, [2](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/2){:target="_blank"}, [13](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/13){:target="_blank"} | | 4 | | eigenschappen (minimaal geometrie, oorspronkelijk bouwjaar, brondocument, gecontateerd en in onderzoek) en relaties van een pand vinden | raadpleeg pand en relaties, bijvoorbeeld via de kaart, of via zoeken op een ID. Bijvoorbeeld uit een andere (basis)registratie | invoeren pandIdentificatie + de expand parameter (optioneel). Queryparameters: nummeraanduidingIdentificatie en adresseerbaarObjectIdntificatie | eigenschappen van het pand en relaties met verblijfsobjecten (embedded) en adressen (embedded) | eigenschappen en relaties Pand raadplegen | [1](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/1){:target="_blank"}, [2](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/2){:target="_blank"}, [3](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/3){:target="_blank"}, [10](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/10){:target="_blank"}, [13](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/13){:target="_blank"}, [14](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/14){:target="_blank"}, [4](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/4){:target="_blank"} | @@ -16,4 +16,5 @@ title: Goals Canvas | laag | SPECIAL!!!! | actuele verdeling van alle gebruiksfuncties van verblijfsobjecten in BAG binnen een bepaald gebied | Zoek verblijfsobjecten standplaatsen en ligplaatsen in een gebied | invoeren contour | verdeling van actuele gebruiksdoelen in percentages (samen 100%) | actuele uitnutting gebruiksdoelen en beschikbare vrije ruimte binnen bestemmingsplan bepalen | [7](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/7){:target="_blank"} | | 1 | | Panden zoeken | Zoek panden op contour in combinatie met bouwjaar binnen periode (voor of na bouwjaar) | contour in combinatie met bouwperiode | panden | panden vinden van voor of na een bepaald bouwjaar of binnen een periode tbv energietransitie | [306](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/306){:target="_blank"} | | 2 | | Panden zoeken | Zoek panden op contour in combinatie met status en geconstateerd | contour in combinatie met status en geconstateerd | panden | panden vinden in een bepaald gebied met gecontateerd tbv handhaving stedelijke ontwikkelingen en belastingzaken | [331](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/331){:target="_blank"}, [333](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/333){:target="_blank"} | -| 3 | | Adresseerbaar object zoeken | zoeken ADO op contour in combinatie met oppervlakterange, status, gebruiksdoel, type en geconstateerd | contour in combinatie met oppervlakterange, status, gebruiksdoel, type en gecontateerd | Adresseerbaar objecten | ADO's vinden in een bepaald gebied met gecontateerd tbv handhaving stedelijke ontwikkelingen en belastingzaken | [19](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/19){:target="_blank"}, [331](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/331){:target="_blank"}, [332](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/332){:target="_blank"}, [334](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/334){:target="_blank"} | +| 3 | | Adresseerbaar object zoeken | zoeken ADO op woonplaats in combinatie met oppervlakterange, status, gebruiksdoel, type en geconstateerd | woonplaats in combinatie met oppervlakterange, status, gebruiksdoel, type en geconstateerd | Adresseerbaar objecten | overzicht ADO's met gecontateerd tbv belastingzaken | [334](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/334){:target="_blank"} | +| 3 | | Adresseerbaar object zoeken | zoeken ADO op contour in combinatie met oppervlakterange, status, gebruiksdoel, type en geconstateerd | contour in combinatie met oppervlakterange, status, gebruiksdoel, type en geconstateerd | Adresseerbaar objecten | ADO's en gerelateerde panden vinden in een bepaald gebied met gecontateerd tbv handhaving stedelijke ontwikkelingen en belastingzaken | [19](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/19){:target="_blank"}, [331](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/331){:target="_blank"}, [332](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/332){:target="_blank"}, [334](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/334){:target="_blank"} | diff --git a/docs/releasenotes.md b/docs/releasenotes.md index 36d5fcaf..88c303d5 100644 --- a/docs/releasenotes.md +++ b/docs/releasenotes.md @@ -5,6 +5,28 @@ title: Releasenotes # Release notes BAG Huidige bevragingen API +## Versie 1.2.0 (22-06-2021) +In deze release zijn enkele bugs in productie opgelost. Tevens zijn er enkele wijzigingen aan de API-specificaties en de feature-files aangebracht. +Er worden nu adresregels geleverd met daarin het samengestelde adres. +De Header Content-Crs is voorzien van een default waarde. +Op /adressen worden de resultaten gesorteerd geretourneerd. + +### Opgeloste issues + + | Link Github | Beschrijving | + | --- | --- | + | [234](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/234) | gebruik relatieve urls voor interne links | + | [293](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/293) | Expand gerelateerde resource als relatie in onderzoek is | + | [294](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/294) | Als gebruiker (nader te bepalen) wil ik de inhoud van de mogelijkOnjuist gegevensgroep kunnen filteren | + | [309](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/309) | wijzigen description zoekparameter zoekresultaat get/adressen/zoek e.a. | + | [338](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/338) | Underscores verwijderen uit componentnamen en enumeratienamen. | + | [343](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/343) | Gebruiker mag niet worden verplicht om Accept-Crs te definieren |\ + | [360](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/360) | Als gebruiker wil ik het samengesteld adres krijgen | + | [363](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/363) | als developer van de BRK API wil ik de korteNaam kunnen leveren bij het adres van een kadastraal object | + | [364](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/364) | toevoegen controle op minimale en maximale lengte invoer zoek | + | [371](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/371) | Is Content-Crs noodzakelijk bij bevraging van panden endpoint | + + ## Versie 1.1.1 (03-03-2021) In deze release zijn enkele bugs in productie opgelost. Er zijn geen wijzigingen gedaan aan de API specificaties. @@ -21,7 +43,7 @@ In deze release zijn enkele bugs in productie opgelost. Er zijn geen wijzigingen ### Opgeloste issues De volgende issues zijn in deze release opgelost. - + | Link Github | Beschrijving | | --- | --- | | [305](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/305) | Juiste foutmelding bij niet-toegestane combinatie van queryparameters | @@ -34,11 +56,11 @@ In deze release zijn enkele bugs in productie opgelost. Er zijn geen wijzigingen De volgende issues staan nog open, oplossing volgt in een latere versie: | Link Github | Beschrijving | - | --- | --- | - | - | Opvragen nummeraanduiding die niet gekoppeld is aan een verblijfsobject| - | [234](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/234) | Interne URL’s in de response worden relatief (zijn nu allemaal absolute links) | - | [265](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/265) | Via fields-parameter opvragen van link zonder "\_links" toe te voegen | - | [293](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/issues/293) | Communiceren dat een relatie mogelijk onjuist is bij het met fields vragen om _links of met expand vragen om de gerelateerde resource | + | --- | --- | --- | + + + + ## Versie 1.0.0 (12-08-2020) diff --git a/features/adresregels.feature b/features/adresregels.feature new file mode 100644 index 00000000..61a7d7da --- /dev/null +++ b/features/adresregels.feature @@ -0,0 +1,162 @@ +# language: nl + +Functionaliteit: Als gebruiker wil ik samengestelde adresregels + zodat ik het samengestelde adres direct en correct kan gebruiken. + + Het adres wordt samengesteld conform NEN 5825:2002. Dit betreft alleen het adresdeel van de adressering, het naamdeel van de adressering komt uit een andere bron (zoals BRP, HR of BRK). + + De adresregels worden samengesteld op basis van de volgende regels + - Property adresregel1 wordt samengesteld uit korteNaam + huisnummer + huisletter + huisnummertoevoeging + - Property adresregel2 wordt samengesteld uit postcode + woonplaats + - Tussen kortenaam en huisnummer wordt een spatie opgenomen + - Tussen het huisnummer en de huisnummertoevoeging (wat in de NEN een samenstelling is van huisletter en huisnummertoevoeging, niet gecheiden van elkaar) moet een koppelteken ("-") worden geplaatst indien de huisnummertoevoeging met een cijfer begint, een spatie in alle andere gevallen + - Tussen postcode numeriek deel en postcode alfabetisch deel moet een spatie worden geplaatst + - Tussen postcode alfabetisch deel en woonplaatsnaam moeten twee spaties worden geplaatst + - De woonplaatsnaam wordt in hoofdletters geschreven + + Scenario: er is geen huisnummertoevoeging en geen huisletter + Gegeven adres met nummeraanduidingidentificatie "0957200000021241" heeft de volgende gegevens: + """ + { + "straat": "Annelien Kappeyne van de Coppellostraat", + "huisnummer": 8, + "postcode": "6049HD", + "woonplaats": "Herten", + "korteNaam": "A K vd Coppellostr" + } + """ + Als het adres wordt gevraagd met /adressen/0957200000021241 + Dan bevat het antwoord: + """ + { + "adresregel1": "A K vd Coppellostr 8", + "adresregel2": "6049 HD HERTEN" + } + """ + + Scenario: er is een huisletter en er is geen huinummertoevoeging + Gegeven adres met nummeraanduidingidentificatie "0344200000004821" heeft de volgende gegevens: + """ + { + "straat": "Blauwkapelseweg", + "huisnummer": 1, + "huisletter": "A", + "postcode": "3572KA", + "woonplaats": "Utrecht", + "korteNaam": "Blauwkapelseweg" + } + """ + Als het adres wordt gevraagd met /adressen/0344200000004821 + Dan bevat het antwoord: + """ + { + "adresregel1": "Blauwkapelseweg 1 A", + "adresregel2": "3572 KA UTRECHT" + } + """ + + Scenario: er is een huisnummertoevoeging die begint met een letter en er is geen huisletter + Gegeven adres met nummeraanduidingidentificatie "0417200000000354" heeft de volgende gegevens: + """ + { + "straat": "Burgemeester van Nispen van Sevenaerstraat", + "huisnummer": 1, + "huisnummertoevoeging": "BEN", + "postcode": "1251KD", + "woonplaats": "Laren", + "korteNaam": "Burg v N v Sevenaerstr" + } + """ + Als het adres wordt gevraagd met /adressen/0417200000000354 + Dan bevat het antwoord: + """ + { + "adresregel1": "Burg v N v Sevenaerstr 1 BEN", + "adresregel2": "1251 KD LAREN" + } + """ + + Scenario: er is een huisnummertoevoeging die begint met een cijfer en er is geen huisletter + Gegeven adres met nummeraanduidingidentificatie "0289200000017214" heeft de volgende gegevens: + """ + { + "straat": "Bornsesteeg", + "huisnummer": 1, + "huisnummertoevoeging": "5A3", + "postcode": "6708GA", + "woonplaats": "Wageningen", + "korteNaam": "Bornsesteeg" + } + """ + Als het adres wordt gevraagd met /adressen/0014200022188962 + Dan bevat het antwoord: + """ + { + "adresregel1": "Bornsesteeg 1-5A3", + "adresregel2": "6708 GA WAGENINGEN" + } + """ + + Scenario: er is een huisletter en een huisnummertoevoeging die begint met een letter + Gegeven adres met nummeraanduidingidentificatie "0118200000264072" heeft de volgende gegevens: + """ + { + "straat": "Defensieweg", + "huisnummer": 16, + "huisletter": "D", + "huisnummertoevoeging": "K", + "postcode": "7933TL", + "woonplaats": "Pesse", + "korteNaam": "Defensieweg" + } + """ + Als het adres wordt gevraagd met /adressen/0118200000264072 + Dan bevat het antwoord: + """ + { + "adresregel1": "Defensieweg 16 DK", + "adresregel2": "7933 TL PESSE" + } + """ + + Scenario: er is een huisletter en een huisnummertoevoeging die begint met een cijfer + Gegeven adres met nummeraanduidingidentificatie "0484200002040489" heeft de volgende gegevens: + """ + { + "straat": "Belgiëlaan", + "huisnummer": 1, + "huisletter": "A", + "huisnummertoevoeging": "3", + "postcode": "2391PH", + "woonplaats": "Hazerswoude-Dorp", + "korteNaam": "Belgiëlaan" + } + """ + Als het adres wordt gevraagd met /adressen/0484200002040489 + Dan bevat het antwoord: + """ + { + "adresregel1": "Belgiëlaan 1 A3", + "adresregel2": "2391 PH HAZERSWOUDE-DORP" + } + """ + + Scenario: er is geen postcode + Gegeven adres met nummeraanduidingidentificatie "0518200001661726" heeft de volgende gegevens: + """ + { + "straat": "Zorgvlietstraat", + "huisnummer": 4, + "huisletter": "T", + "woonplaats": "'s-Gravenhage", + "korteNaam": "Zorgvlietstraat" + } + """ + Als het adres wordt gevraagd met /adressen/0518200001661726 + Dan bevat het antwoord: + """ + { + "adresregel1": "Zorgvlietstraat 4 T", + "adresregel2": "'S-GRAVENHAGE" + } + """ diff --git a/specificatie/genereervariant/openapi.json b/specificatie/genereervariant/openapi.json index ed9518b4..21b022e9 100644 --- a/specificatie/genereervariant/openapi.json +++ b/specificatie/genereervariant/openapi.json @@ -13,7 +13,7 @@ "name": "European Union Public License, version 1.2 (EUPL-1.2)", "url": "https://eupl.eu/1.2/nl/" }, - "version": "1.1.0" + "version": "1.2.0" }, "servers": [ { @@ -37,7 +37,7 @@ "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", + "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": [ { @@ -112,7 +112,7 @@ "$ref": "#/components/schemas/BadRequestFoutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", + "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.", @@ -143,7 +143,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", + "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.", @@ -166,7 +166,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", + "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.", @@ -189,7 +189,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", + "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", @@ -212,7 +212,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", + "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.", @@ -235,7 +235,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", + "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.", @@ -274,7 +274,7 @@ "Adres" ], "summary": "vindt adressen", - "description": "Vind een actueel adres met de identificatie van het zoekresultaat uit de operatie get /adressen/zoek, de pandidentificatie of de adresseerbaarobjectidentificatie. 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.1.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.1.0/features/expand.feature).", + "description": "Vind een actueel adres met de identificatie van het zoekresultaat uit de operatie get /adressen/zoek, de pandidentificatie of de adresseerbaarobjectidentificatie. 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).", "operationId": "raadpleegAdressen", "parameters": [ { @@ -317,7 +317,7 @@ { "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.1.0/features/expand.feature).", + "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" @@ -326,7 +326,7 @@ { "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.1.0/features/fields.feature)", + "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" @@ -393,7 +393,7 @@ "$ref": "#/components/schemas/BadRequestFoutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", + "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.", @@ -424,7 +424,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", + "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.", @@ -447,7 +447,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", + "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.", @@ -470,7 +470,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", + "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", @@ -493,7 +493,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", + "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.", @@ -516,7 +516,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", + "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.", @@ -555,7 +555,7 @@ "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.1.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.1.0/features/expand.feature).", + "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 en openbare ruimte, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature).", "operationId": "raadpleegAdresMetNumId", "parameters": [ { @@ -574,7 +574,7 @@ { "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.1.0/features/expand.feature).", + "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" @@ -583,7 +583,7 @@ { "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.1.0/features/fields.feature)", + "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" @@ -622,7 +622,7 @@ "$ref": "#/components/schemas/BadRequestFoutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", + "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.", @@ -653,7 +653,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", + "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.", @@ -676,7 +676,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", + "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.", @@ -699,7 +699,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", + "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.", @@ -722,7 +722,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", + "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", @@ -745,7 +745,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", + "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.", @@ -768,7 +768,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", + "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.", @@ -807,7 +807,7 @@ "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.1.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.1.0/features/expand.feature).", + "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": [ { @@ -826,7 +826,7 @@ { "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.1.0/features/expand.feature).", + "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" @@ -835,7 +835,7 @@ { "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.1.0/features/fields.feature)", + "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" @@ -847,11 +847,7 @@ "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "schema": { - "type": "string", - "description": "CRS van de coördinaten in de response. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "enum": [ - "epsg:28992" - ] + "$ref": "#/components/schemas/CrsEnum" } } ], @@ -890,7 +886,7 @@ "$ref": "#/components/schemas/BadRequestFoutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", + "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.", @@ -921,7 +917,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", + "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.", @@ -944,7 +940,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", + "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.", @@ -967,7 +963,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", + "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.", @@ -990,7 +986,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", + "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", @@ -1013,7 +1009,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", + "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.", @@ -1036,7 +1032,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", + "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.", @@ -1059,7 +1055,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", + "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.", @@ -1098,7 +1094,7 @@ "Adresseerbaar object" ], "summary": "vindt verblijfsobjecten, ligplaatsen, standplaatsen", - "description": "Zoek actuele adresseerbare objecten (verblijfsobjecten, standplaatsen of ligplaatsen) met een nummeraanduidingidentificatie of pandidentificatie. 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.1.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.1.0/features/expand.feature).", + "description": "Zoek actuele adresseerbare objecten (verblijfsobjecten, standplaatsen of ligplaatsen) met een nummeraanduidingidentificatie of pandidentificatie. 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": "raadpleegAdresseerbareobjecten", "parameters": [ { @@ -1130,7 +1126,7 @@ { "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.1.0/features/expand.feature).", + "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" @@ -1139,7 +1135,7 @@ { "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.1.0/features/fields.feature)", + "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" @@ -1151,11 +1147,7 @@ "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "schema": { - "type": "string", - "description": "CRS van de coördinaten in de response. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "enum": [ - "epsg:28992" - ] + "$ref": "#/components/schemas/CrsEnum" } }, { @@ -1222,7 +1214,7 @@ "$ref": "#/components/schemas/BadRequestFoutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", + "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.", @@ -1253,7 +1245,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", + "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.", @@ -1276,7 +1268,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", + "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.", @@ -1299,7 +1291,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", + "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", @@ -1322,7 +1314,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", + "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.", @@ -1345,7 +1337,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", + "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.", @@ -1368,7 +1360,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", + "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.", @@ -1407,7 +1399,7 @@ "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.1.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.1.0/features/expand.feature).", + "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": [ { @@ -1427,7 +1419,7 @@ { "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.1.0/features/expand.feature).", + "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" @@ -1436,7 +1428,7 @@ { "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.1.0/features/fields.feature)", + "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" @@ -1448,11 +1440,7 @@ "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "schema": { - "type": "string", - "description": "CRS van de coördinaten in de response. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "enum": [ - "epsg:28992" - ] + "$ref": "#/components/schemas/CrsEnum" } } ], @@ -1491,7 +1479,7 @@ "$ref": "#/components/schemas/BadRequestFoutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", + "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.", @@ -1522,7 +1510,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", + "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.", @@ -1545,7 +1533,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", + "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.", @@ -1568,7 +1556,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", + "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.", @@ -1591,7 +1579,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", + "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", @@ -1614,7 +1602,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", + "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.", @@ -1637,7 +1625,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", + "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.", @@ -1660,7 +1648,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", + "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.", @@ -1699,7 +1687,7 @@ "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.1.0/features/fields.feature).", + "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": [ { @@ -1718,7 +1706,7 @@ { "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.1.0/features/fields.feature)", + "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" @@ -1757,7 +1745,7 @@ "$ref": "#/components/schemas/BadRequestFoutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", + "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.", @@ -1788,7 +1776,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", + "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.", @@ -1811,7 +1799,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", + "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.", @@ -1834,7 +1822,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", + "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.", @@ -1857,7 +1845,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", + "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", @@ -1880,7 +1868,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", + "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.", @@ -1903,7 +1891,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", + "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.", @@ -1942,7 +1930,7 @@ "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.1.0/features/fields.feature).", + "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": [ { @@ -1961,7 +1949,7 @@ { "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.1.0/features/fields.feature)", + "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" @@ -2000,7 +1988,7 @@ "$ref": "#/components/schemas/BadRequestFoutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", + "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.", @@ -2031,7 +2019,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", + "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.", @@ -2054,7 +2042,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", + "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.", @@ -2077,7 +2065,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", + "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.", @@ -2100,7 +2088,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", + "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", @@ -2123,7 +2111,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", + "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.", @@ -2146,7 +2134,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", + "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.", @@ -2185,7 +2173,7 @@ "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.1.0/features/fields.feature).", + "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": [ { @@ -2204,7 +2192,7 @@ { "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.1.0/features/fields.feature)", + "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" @@ -2216,11 +2204,7 @@ "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "schema": { - "type": "string", - "description": "CRS van de coördinaten in de response. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "enum": [ - "epsg:28992" - ] + "$ref": "#/components/schemas/CrsEnum" } } ], @@ -2259,7 +2243,7 @@ "$ref": "#/components/schemas/BadRequestFoutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", + "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.", @@ -2290,7 +2274,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", + "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.", @@ -2313,7 +2297,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", + "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.", @@ -2336,7 +2320,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 404 Not Found", + "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.", @@ -2359,7 +2343,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", + "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", @@ -2382,7 +2366,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", + "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.", @@ -2405,7 +2389,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", + "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.", @@ -2428,7 +2412,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", + "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.", @@ -2467,7 +2451,7 @@ "Pand" ], "summary": "vindt panden", - "description": "Zoek actuele panden met de identificatie van een adresseerbaar object, nummeraanduiding of een locatie. 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.1.0/features/fields.feature).", + "description": "Zoek actuele panden met de identificatie van een adresseerbaar object, nummeraanduiding of een locatie. 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": "raadpleegPanden", "parameters": [ { @@ -2519,7 +2503,7 @@ { "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.1.0/features/fields.feature)", + "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" @@ -2531,11 +2515,7 @@ "description": "Gewenste CRS van de coördinaten in de response.", "required": false, "schema": { - "type": "string", - "description": "CRS van de coördinaten in de response. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", - "enum": [ - "epsg:28992" - ] + "$ref": "#/components/schemas/CrsEnum" } }, { @@ -2544,10 +2524,7 @@ "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", "required": false, "schema": { - "type": "string", - "enum": [ - "epsg:28992" - ] + "$ref": "#/components/schemas/CrsEnum" } } ], @@ -2586,7 +2563,7 @@ "$ref": "#/components/schemas/BadRequestFoutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 400 Bad Request", + "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.", @@ -2617,7 +2594,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized", + "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.", @@ -2640,7 +2617,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 403 Forbidden", + "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.", @@ -2663,7 +2640,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 406 Not Acceptable", + "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", @@ -2686,7 +2663,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 412 Precondition Failed", + "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.", @@ -2709,7 +2686,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.16 415 Unsupported Media Type", + "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16", "title": "Unsupported Media Type", "status": 415, "detail": "The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method.", @@ -2732,7 +2709,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 500 Internal server error", + "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.", @@ -2755,7 +2732,7 @@ "$ref": "#/components/schemas/Foutbericht" }, "example": { - "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 503 Service Unavailable", + "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.", @@ -2813,13 +2790,13 @@ { "properties": { "_links": { - "$ref": "#/components/schemas/ZoekResultaat_links" + "$ref": "#/components/schemas/ZoekResultaatLinks" } } } ] }, - "ZoekResultaat_links": { + "ZoekResultaatLinks": { "type": "object", "properties": { "adres": { @@ -2883,7 +2860,7 @@ "example": "Duiven" } }, - "description": "Eigenschappen van het adres die kunnen worden hergebruikt in andere API's waarin adresgegevens worden opgenomen." + "description": "Eigenschappen van het adres die kunnen worden hergebruikt in andere API's waarin adresgegevens worden opgenomen. " }, "AdresUitgebreid": { "allOf": [ @@ -2892,6 +2869,16 @@ }, { "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", @@ -2990,7 +2977,7 @@ { "properties": { "_embedded": { - "$ref": "#/components/schemas/Adres_embedded" + "$ref": "#/components/schemas/AdresEmbedded" } } } @@ -3004,7 +2991,7 @@ { "properties": { "_links": { - "$ref": "#/components/schemas/Adres_links" + "$ref": "#/components/schemas/AdresLinks" } } } @@ -3029,7 +3016,7 @@ } } }, - "Adres_links": { + "AdresLinks": { "type": "object", "properties": { "self": { @@ -3056,7 +3043,7 @@ } } }, - "Adres_embedded": { + "AdresEmbedded": { "type": "object", "properties": { "openbareRuimte": { @@ -3083,7 +3070,7 @@ "description": "Het domein waartoe de identificatie behoort." }, "type": { - "$ref": "#/components/schemas/TypeAdresseerbaarObject_enum" + "$ref": "#/components/schemas/TypeAdresseerbaarObjectEnum" }, "documentdatum": { "type": "string", @@ -3099,7 +3086,7 @@ "gebruiksdoelen": { "type": "array", "items": { - "$ref": "#/components/schemas/Gebruiksdoel_enum" + "$ref": "#/components/schemas/GebruiksdoelEnum" } }, "geconstateerd": { @@ -3128,13 +3115,13 @@ "type": "integer" }, "status": { - "$ref": "#/components/schemas/AdresseerbaarObjectStatus_enum" + "$ref": "#/components/schemas/AdresseerbaarObjectStatusEnum" }, "mogelijkOnjuist": { "$ref": "#/components/schemas/AdresseerbaarObjectMogelijkOnjuist" } }, - "description": "Een adresseerbaar object is een standplaats, ligplaats of verblijfsobject." + "description": "Een adresseerbaarobject is een standplaats, ligplaats of verblijfsobject." }, "AdresseerbaarObjectHal": { "allOf": [ @@ -3144,7 +3131,7 @@ { "properties": { "_embedded": { - "$ref": "#/components/schemas/AdresseerbaarObject_embedded" + "$ref": "#/components/schemas/AdresseerbaarObjectEmbedded" } } } @@ -3158,7 +3145,7 @@ { "properties": { "_links": { - "$ref": "#/components/schemas/AdresseerbaarObject_links" + "$ref": "#/components/schemas/AdresseerbaarObjectLinks" } } } @@ -3195,7 +3182,7 @@ }, "description": "Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting." }, - "AdresseerbaarObject_embedded": { + "AdresseerbaarObjectEmbedded": { "type": "object", "properties": { "adressen": { @@ -3212,7 +3199,7 @@ } } }, - "AdresseerbaarObject_links": { + "AdresseerbaarObjectLinks": { "type": "object", "properties": { "adressen": { @@ -3253,7 +3240,7 @@ } } }, - "AdresseerbaarObjectStatus_enum": { + "AdresseerbaarObjectStatusEnum": { "type": "string", "enum": [ "Plaats aangewezen", @@ -3264,7 +3251,7 @@ "Verblijfsobject buiten gebruik" ] }, - "Gebruiksdoel_enum": { + "GebruiksdoelEnum": { "type": "string", "enum": [ "woonfunctie", @@ -3297,10 +3284,10 @@ "example": "Laan van de landinrichtingscommissie Duiven-Westervoort" }, "type": { - "$ref": "#/components/schemas/TypeOpenbareRuimte_enum" + "$ref": "#/components/schemas/TypeOpenbareRuimteEnum" }, "status": { - "$ref": "#/components/schemas/StatusNaamgeving_enum" + "$ref": "#/components/schemas/StatusNaamgevingEnum" }, "korteNaam": { "maxLength": 24, @@ -3356,7 +3343,7 @@ "type": "array", "items": { "type": "string", - "example": "Openbareruimtenaam komt mogelijk niet overeen met de vermelding in het straatnaambesluit." + "example": "Openbare ruimtenaam komt mogelijk niet overeen met de vermelding in het straatnaambesluit." } } }, @@ -3370,13 +3357,13 @@ { "properties": { "_links": { - "$ref": "#/components/schemas/OpenbareRuimte_links" + "$ref": "#/components/schemas/OpenbareRuimteLinks" } } } ] }, - "OpenbareRuimte_links": { + "OpenbareRuimteLinks": { "type": "object", "properties": { "self": { @@ -3418,7 +3405,7 @@ "example": "6922KZ" }, "status": { - "$ref": "#/components/schemas/StatusNaamgeving_enum" + "$ref": "#/components/schemas/StatusNaamgevingEnum" }, "geconstateerd": { "type": "boolean", @@ -3505,13 +3492,13 @@ { "properties": { "_links": { - "$ref": "#/components/schemas/Nummeraanduiding_links" + "$ref": "#/components/schemas/NummeraanduidingLinks" } } } ] }, - "Nummeraanduiding_links": { + "NummeraanduidingLinks": { "type": "object", "properties": { "self": { @@ -3544,7 +3531,7 @@ "example": "Duiven" }, "status": { - "$ref": "#/components/schemas/StatusWoonplaats_enum" + "$ref": "#/components/schemas/StatusWoonplaatsEnum" }, "geconstateerd": { "type": "boolean", @@ -3597,7 +3584,7 @@ { "properties": { "_links": { - "$ref": "#/components/schemas/Woonplaats_links" + "$ref": "#/components/schemas/WoonplaatsLinks" } } } @@ -3611,13 +3598,13 @@ { "properties": { "_embedded": { - "$ref": "#/components/schemas/Woonplaats_embedded" + "$ref": "#/components/schemas/WoonplaatsEmbedded" } } } ] }, - "Woonplaats_links": { + "WoonplaatsLinks": { "type": "object", "properties": { "self": { @@ -3625,7 +3612,7 @@ } } }, - "Woonplaats_embedded": { + "WoonplaatsEmbedded": { "type": "object", "properties": { "geometrie": { @@ -3653,7 +3640,7 @@ "example": 1991 }, "status": { - "$ref": "#/components/schemas/StatusPand_enum" + "$ref": "#/components/schemas/StatusPandEnum" }, "geconstateerd": { "type": "boolean", @@ -3720,13 +3707,13 @@ { "properties": { "_links": { - "$ref": "#/components/schemas/Pand_links" + "$ref": "#/components/schemas/PandLinks" } } } ] }, - "Pand_links": { + "PandLinks": { "type": "object", "properties": { "self": { @@ -3765,14 +3752,14 @@ } } }, - "StatusNaamgeving_enum": { + "StatusNaamgevingEnum": { "type": "string", "description": "Een aanduiding van alle waarden die de status van een openbare ruimte of een nummeraanduiding kan aannemen.", "enum": [ "Naamgeving uitgegeven" ] }, - "StatusPand_enum": { + "StatusPandEnum": { "type": "string", "description": "Een codering van de verschillende waarden die de status van een pand kan aannemen.", "enum": [ @@ -3785,14 +3772,14 @@ "Pand buiten gebruik" ] }, - "StatusWoonplaats_enum": { + "StatusWoonplaatsEnum": { "type": "string", "description": "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen.", "enum": [ "Woonplaats aangewezen" ] }, - "TypeAdresseerbaarObject_enum": { + "TypeAdresseerbaarObjectEnum": { "type": "string", "enum": [ "verblijfsobject", @@ -3800,7 +3787,7 @@ "ligplaats" ] }, - "TypeOpenbareRuimte_enum": { + "TypeOpenbareRuimteEnum": { "type": "string", "description": "Een codering van de verschillende waarden die de typering van een openbare ruimte kan aannemen.", "enum": [ @@ -3916,6 +3903,14 @@ }, "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" @@ -3933,13 +3928,35 @@ "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" + "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" @@ -3948,27 +3965,31 @@ "type": "object", "properties": { "last": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "/resourcenaam?page=8" - }, - "templated": { - "type": "boolean" - }, - "title": { - "type": "string", - "example": "Laatste pagina" - } - }, - "description": "uri voor het opvragen van de laatste pagina van deze collectie" + "$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" @@ -3977,55 +3998,13 @@ "type": "object", "properties": { "first": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "/resourcenaam?page=1" - }, - "templated": { - "type": "boolean" - }, - "title": { - "type": "string", - "example": "Eerste pagina" - } - }, - "description": "uri voor het opvragen van de eerste pagina van deze collectie" + "$ref": "#/components/schemas/HalLink" }, "previous": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "/resourcenaam?page=3" - }, - "templated": { - "type": "boolean" - }, - "title": { - "type": "string", - "example": "Vorige pagina" - } - }, - "description": "uri voor het opvragen van de vorige pagina van deze collectie" + "$ref": "#/components/schemas/HalLink" }, "next": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "/resourcenaam?page=5" - }, - "templated": { - "type": "boolean" - }, - "title": { - "type": "string", - "example": "Volgende pagina" - } - }, - "description": "uri voor het opvragen van de volgende pagina van deze collectie" + "$ref": "#/components/schemas/HalLink" } } } @@ -4037,7 +4016,8 @@ "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": [ @@ -4304,10 +4284,7 @@ "contentCrs": { "description": "CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.", "schema": { - "type": "string", - "enum": [ - "epsg:28992" - ] + "$ref": "#/components/schemas/CrsEnum" } } }, @@ -4320,4 +4297,4 @@ } } } -} +} \ No newline at end of file diff --git a/specificatie/genereervariant/openapi.yaml b/specificatie/genereervariant/openapi.yaml index dd03511f..e87cc7f3 100644 --- a/specificatie/genereervariant/openapi.yaml +++ b/specificatie/genereervariant/openapi.yaml @@ -12,7 +12,7 @@ info: license: name: European Union Public License, version 1.2 (EUPL-1.2) url: https://eupl.eu/1.2/nl/ - version: 1.1.0 + version: 1.2.0 servers: - url: https://api.bag.acceptatie.kadaster.nl/esd/huidigebevragingen/v1 description: LVBAG - ACCEPTATIE @@ -29,7 +29,7 @@ paths: 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 + uit het antwoord te gebruiken in get/adressen operationId: zoek parameters: - name: zoek @@ -83,8 +83,7 @@ paths: schema: $ref: '#/components/schemas/BadRequestFoutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 - 400 Bad Request + 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 @@ -106,8 +105,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 - 401 Unauthorized + 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 @@ -125,8 +123,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 - 403 Forbidden + 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 @@ -143,8 +140,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 - 406 Not Acceptable + 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 @@ -162,8 +158,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 - 500 Internal server error + 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 @@ -180,8 +175,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 - 503 Service Unavailable + 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 @@ -207,10 +201,10 @@ paths: description: Vind een actueel adres met de identificatie van het zoekresultaat uit de operatie get /adressen/zoek, de pandidentificatie of de adresseerbaarobjectidentificatie. 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.1.0/features/fields.feature). + 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.1.0/features/expand.feature). + zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). operationId: raadpleegAdressen parameters: - name: pandIdentificatie @@ -251,7 +245,7 @@ paths: 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.1.0/features/expand.feature). + [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). required: false schema: type: string @@ -261,7 +255,7 @@ paths: 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.1.0/features/fields.feature) + een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature) required: false schema: type: string @@ -307,8 +301,7 @@ paths: schema: $ref: '#/components/schemas/BadRequestFoutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 - 400 Bad Request + 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 @@ -330,8 +323,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 - 401 Unauthorized + 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 @@ -349,8 +341,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 - 403 Forbidden + 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 @@ -367,8 +358,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 - 406 Not Acceptable + 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 @@ -386,8 +376,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 - 500 Internal server error + 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 @@ -404,8 +393,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 - 503 Service Unavailable + 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 @@ -430,10 +418,10 @@ paths: 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.1.0/features/fields.feature). + 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.1.0/features/expand.feature). + 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 @@ -455,7 +443,7 @@ paths: 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.1.0/features/expand.feature). + [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). required: false schema: type: string @@ -465,7 +453,7 @@ paths: 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.1.0/features/fields.feature) + een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature) required: false schema: type: string @@ -491,8 +479,7 @@ paths: schema: $ref: '#/components/schemas/BadRequestFoutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 - 400 Bad Request + 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 @@ -514,8 +501,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 - 401 Unauthorized + 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 @@ -533,8 +519,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 - 403 Forbidden + 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 @@ -551,8 +536,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 - 404 Not Found + 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. @@ -568,8 +552,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 - 406 Not Acceptable + 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 @@ -587,8 +570,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 - 500 Internal server error + 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 @@ -605,8 +587,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 - 503 Service Unavailable + 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 @@ -632,10 +613,10 @@ paths: 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.1.0/features/fields.feature). + 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.1.0/features/expand.feature). + expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). operationId: raadpleegAdresseerbaarobject parameters: - name: adresseerbaarobjectidentificatie @@ -658,7 +639,7 @@ paths: 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.1.0/features/expand.feature). + [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). required: false schema: type: string @@ -668,7 +649,7 @@ paths: 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.1.0/features/fields.feature) + een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature) required: false schema: type: string @@ -677,11 +658,7 @@ paths: description: Gewenste CRS van de coördinaten in de response. required: false schema: - type: string - description: CRS van de coördinaten in de response. epsg:28992 mapt op het - RD New Nederlands coordinatenstelsel. - enum: - - epsg:28992 + $ref: '#/components/schemas/CrsEnum' responses: "200": description: Geslaagd @@ -706,8 +683,7 @@ paths: schema: $ref: '#/components/schemas/BadRequestFoutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 - 400 Bad Request + 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 @@ -729,8 +705,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 - 401 Unauthorized + 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 @@ -748,8 +723,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 - 403 Forbidden + 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 @@ -766,8 +740,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 - 404 Not Found + 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. @@ -783,8 +756,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 - 406 Not Acceptable + 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 @@ -802,8 +774,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 - 412 Precondition Failed + 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 @@ -820,8 +791,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 - 500 Internal server error + 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 @@ -838,8 +808,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 - 503 Service Unavailable + 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 @@ -865,10 +834,10 @@ paths: description: Zoek actuele adresseerbare objecten (verblijfsobjecten, standplaatsen of ligplaatsen) met een nummeraanduidingidentificatie of pandidentificatie. 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.1.0/features/fields.feature). + 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.1.0/features/expand.feature). + expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). operationId: raadpleegAdresseerbareobjecten parameters: - name: nummeraanduidingIdentificatie @@ -900,7 +869,7 @@ paths: 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.1.0/features/expand.feature). + [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). required: false schema: type: string @@ -910,7 +879,7 @@ paths: 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.1.0/features/fields.feature) + een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature) required: false schema: type: string @@ -919,11 +888,7 @@ paths: description: Gewenste CRS van de coördinaten in de response. required: false schema: - type: string - description: CRS van de coördinaten in de response. epsg:28992 mapt op het - RD New Nederlands coordinatenstelsel. - enum: - - epsg:28992 + $ref: '#/components/schemas/CrsEnum' - name: page in: query description: Pagina nummer @@ -968,8 +933,7 @@ paths: schema: $ref: '#/components/schemas/BadRequestFoutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 - 400 Bad Request + 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 @@ -991,8 +955,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 - 401 Unauthorized + 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 @@ -1010,8 +973,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 - 403 Forbidden + 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 @@ -1028,8 +990,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 - 406 Not Acceptable + 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 @@ -1047,8 +1008,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 - 412 Precondition Failed + 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 @@ -1065,8 +1025,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 - 500 Internal server error + 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 @@ -1083,8 +1042,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 - 503 Service Unavailable + 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 @@ -1110,9 +1068,9 @@ paths: 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.1.0/features/fields.feature). + 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.1.0/features/expand.feature). + 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 @@ -1135,7 +1093,7 @@ paths: 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.1.0/features/expand.feature). + [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). required: false schema: type: string @@ -1145,7 +1103,7 @@ paths: 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.1.0/features/fields.feature) + een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature) required: false schema: type: string @@ -1154,11 +1112,7 @@ paths: description: Gewenste CRS van de coördinaten in de response. required: false schema: - type: string - description: CRS van de coördinaten in de response. epsg:28992 mapt op het - RD New Nederlands coordinatenstelsel. - enum: - - epsg:28992 + $ref: '#/components/schemas/CrsEnum' responses: "200": description: Geslaagd @@ -1183,8 +1137,7 @@ paths: schema: $ref: '#/components/schemas/BadRequestFoutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 - 400 Bad Request + 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 @@ -1206,8 +1159,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 - 401 Unauthorized + 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 @@ -1225,8 +1177,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 - 403 Forbidden + 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 @@ -1243,8 +1194,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 - 404 Not Found + 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. @@ -1260,8 +1210,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 - 406 Not Acceptable + 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 @@ -1279,8 +1228,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 - 412 Precondition Failed + 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 @@ -1297,8 +1245,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 - 500 Internal server error + 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 @@ -1315,8 +1262,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 - 503 Service Unavailable + 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 @@ -1343,7 +1289,7 @@ paths: 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.1.0/features/fields.feature). + fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). operationId: raadpleegOpenbareRuimte parameters: - name: openbareruimteidentificatie @@ -1362,7 +1308,7 @@ paths: 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.1.0/features/fields.feature) + een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature) required: false schema: type: string @@ -1388,8 +1334,7 @@ paths: schema: $ref: '#/components/schemas/BadRequestFoutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 - 400 Bad Request + 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 @@ -1411,8 +1356,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 - 401 Unauthorized + 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 @@ -1430,8 +1374,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 - 403 Forbidden + 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 @@ -1448,8 +1391,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 - 404 Not Found + 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. @@ -1465,8 +1407,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 - 406 Not Acceptable + 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 @@ -1484,8 +1425,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 - 500 Internal server error + 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 @@ -1502,8 +1442,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 - 503 Service Unavailable + 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 @@ -1530,7 +1469,7 @@ paths: 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.1.0/features/fields.feature). + 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 @@ -1550,7 +1489,7 @@ paths: 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.1.0/features/fields.feature) + een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature) required: false schema: type: string @@ -1576,8 +1515,7 @@ paths: schema: $ref: '#/components/schemas/BadRequestFoutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 - 400 Bad Request + 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 @@ -1599,8 +1537,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 - 401 Unauthorized + 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 @@ -1618,8 +1555,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 - 403 Forbidden + 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 @@ -1636,8 +1572,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 - 404 Not Found + 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. @@ -1653,8 +1588,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 - 406 Not Acceptable + 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 @@ -1672,8 +1606,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 - 500 Internal server error + 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 @@ -1690,8 +1623,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 - 503 Service Unavailable + 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 @@ -1718,7 +1650,7 @@ paths: 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.1.0/features/fields.feature). + specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). operationId: raadpleegPand parameters: - name: pandidentificatie @@ -1737,7 +1669,7 @@ paths: 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.1.0/features/fields.feature) + een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature) required: false schema: type: string @@ -1746,11 +1678,7 @@ paths: description: Gewenste CRS van de coördinaten in de response. required: false schema: - type: string - description: CRS van de coördinaten in de response. epsg:28992 mapt op het - RD New Nederlands coordinatenstelsel. - enum: - - epsg:28992 + $ref: '#/components/schemas/CrsEnum' responses: "200": description: Geslaagd @@ -1775,8 +1703,7 @@ paths: schema: $ref: '#/components/schemas/BadRequestFoutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 - 400 Bad Request + 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 @@ -1798,8 +1725,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 - 401 Unauthorized + 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 @@ -1817,8 +1743,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 - 403 Forbidden + 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 @@ -1835,8 +1760,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.5 - 404 Not Found + 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. @@ -1852,8 +1776,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 - 406 Not Acceptable + 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 @@ -1871,8 +1794,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 - 412 Precondition Failed + 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 @@ -1889,8 +1811,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 - 500 Internal server error + 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 @@ -1907,8 +1828,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 - 503 Service Unavailable + 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 @@ -1934,7 +1854,7 @@ paths: description: Zoek actuele panden met de identificatie van een adresseerbaar object, nummeraanduiding of een locatie. 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.1.0/features/fields.feature). + fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature). operationId: raadpleegPanden parameters: - name: adresseerbaarObjectIdentificatie @@ -1983,7 +1903,7 @@ paths: 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.1.0/features/fields.feature) + een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature) required: false schema: type: string @@ -1992,20 +1912,14 @@ paths: description: Gewenste CRS van de coördinaten in de response. required: false schema: - type: string - description: CRS van de coördinaten in de response. epsg:28992 mapt op het - RD New Nederlands coordinatenstelsel. - enum: - - epsg:28992 + $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: - type: string - enum: - - epsg:28992 + $ref: '#/components/schemas/CrsEnum' responses: "200": description: Geslaagd @@ -2030,8 +1944,7 @@ paths: schema: $ref: '#/components/schemas/BadRequestFoutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.1 - 400 Bad Request + 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 @@ -2053,8 +1966,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 - 401 Unauthorized + 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 @@ -2072,8 +1984,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.4 - 403 Forbidden + 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 @@ -2090,8 +2001,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.7 - 406 Not Acceptable + 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 @@ -2109,8 +2019,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.13 - 412 Precondition Failed + 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 @@ -2127,8 +2036,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.16 - 415 Unsupported Media Type + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16 title: Unsupported Media Type status: 415 detail: The server is refusing the request because the entity of the @@ -2146,8 +2054,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.1 - 500 Internal server error + 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 @@ -2164,8 +2071,7 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.5.4 - 503 Service Unavailable + 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 @@ -2201,8 +2107,8 @@ components: - $ref: '#/components/schemas/ZoekResultaat' - properties: _links: - $ref: '#/components/schemas/ZoekResultaat_links' - ZoekResultaat_links: + $ref: '#/components/schemas/ZoekResultaatLinks' + ZoekResultaatLinks: type: object properties: adres: @@ -2254,12 +2160,22 @@ components: 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 waarin adresgegevens worden opgenomen. + description: 'Eigenschappen van het adres die kunnen worden hergebruikt in andere + API''s waarin adresgegevens worden opgenomen. ' 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 @@ -2339,13 +2255,13 @@ components: - $ref: '#/components/schemas/AdresHalBasis' - properties: _embedded: - $ref: '#/components/schemas/Adres_embedded' + $ref: '#/components/schemas/AdresEmbedded' AdresHalBasis: allOf: - $ref: '#/components/schemas/AdresUitgebreid' - properties: _links: - $ref: '#/components/schemas/Adres_links' + $ref: '#/components/schemas/AdresLinks' AdresHalCollectie: type: object properties: @@ -2358,7 +2274,7 @@ components: type: array items: $ref: '#/components/schemas/AdresHal' - Adres_links: + AdresLinks: type: object properties: self: @@ -2376,7 +2292,7 @@ components: description: Het/de aan het adres gerelateerde pand(en). items: $ref: '#/components/schemas/HalLink' - Adres_embedded: + AdresEmbedded: type: object properties: openbareRuimte: @@ -2397,7 +2313,7 @@ components: type: string description: Het domein waartoe de identificatie behoort. type: - $ref: '#/components/schemas/TypeAdresseerbaarObject_enum' + $ref: '#/components/schemas/TypeAdresseerbaarObjectEnum' documentdatum: type: string description: De vaststellingsdatum van het brondocument dat de basis is @@ -2414,7 +2330,7 @@ components: gebruiksdoelen: type: array items: - $ref: '#/components/schemas/Gebruiksdoel_enum' + $ref: '#/components/schemas/GebruiksdoelEnum' geconstateerd: type: boolean description: Indicatie dat een standplaats, ligplaats of verblijfsobject @@ -2439,22 +2355,22 @@ components: oppervlakte: type: integer status: - $ref: '#/components/schemas/AdresseerbaarObjectStatus_enum' + $ref: '#/components/schemas/AdresseerbaarObjectStatusEnum' mogelijkOnjuist: $ref: '#/components/schemas/AdresseerbaarObjectMogelijkOnjuist' - description: Een adresseerbaar object is een standplaats, ligplaats of verblijfsobject. + description: Een adresseerbaarobject is een standplaats, ligplaats of verblijfsobject. AdresseerbaarObjectHal: allOf: - $ref: '#/components/schemas/AdresseerbaarObjectHalBasis' - properties: _embedded: - $ref: '#/components/schemas/AdresseerbaarObject_embedded' + $ref: '#/components/schemas/AdresseerbaarObjectEmbedded' AdresseerbaarObjectHalBasis: allOf: - $ref: '#/components/schemas/AdresseerbaarObject' - properties: _links: - $ref: '#/components/schemas/AdresseerbaarObject_links' + $ref: '#/components/schemas/AdresseerbaarObjectLinks' AdresseerbaarObjectMogelijkOnjuist: type: object properties: @@ -2477,7 +2393,7 @@ components: example: Locatie/contour mogelijk onjuist. description: Wanneer true is de waarde mogelijk onjuist en wordt juistheid op dit moment onderzocht. Zie toelichting. - AdresseerbaarObject_embedded: + AdresseerbaarObjectEmbedded: type: object properties: adressen: @@ -2488,7 +2404,7 @@ components: type: array items: $ref: '#/components/schemas/PandHalBasis' - AdresseerbaarObject_links: + AdresseerbaarObjectLinks: type: object properties: adressen: @@ -2517,7 +2433,7 @@ components: $ref: '#/components/schemas/AdresseerbaarObjectHal' _links: $ref: '#/components/schemas/HalPaginationLinksMetLast' - AdresseerbaarObjectStatus_enum: + AdresseerbaarObjectStatusEnum: type: string enum: - Plaats aangewezen @@ -2526,7 +2442,7 @@ components: - Verblijfsobject in gebruik - Verbouwing verblijfsobject - Verblijfsobject buiten gebruik - Gebruiksdoel_enum: + GebruiksdoelEnum: type: string enum: - woonfunctie @@ -2554,9 +2470,9 @@ components: description: De naam die door de gemeente aan een openbare ruimte is gegeven. example: Laan van de landinrichtingscommissie Duiven-Westervoort type: - $ref: '#/components/schemas/TypeOpenbareRuimte_enum' + $ref: '#/components/schemas/TypeOpenbareRuimteEnum' status: - $ref: '#/components/schemas/StatusNaamgeving_enum' + $ref: '#/components/schemas/StatusNaamgevingEnum' korteNaam: maxLength: 24 type: string @@ -2606,7 +2522,7 @@ components: type: array items: type: string - example: Openbareruimtenaam komt mogelijk niet overeen met de vermelding + 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. @@ -2615,8 +2531,8 @@ components: - $ref: '#/components/schemas/OpenbareRuimte' - properties: _links: - $ref: '#/components/schemas/OpenbareRuimte_links' - OpenbareRuimte_links: + $ref: '#/components/schemas/OpenbareRuimteLinks' + OpenbareRuimteLinks: type: object properties: self: @@ -2652,7 +2568,7 @@ components: van een straatnaam en een huisnummer hoort. example: 6922KZ status: - $ref: '#/components/schemas/StatusNaamgeving_enum' + $ref: '#/components/schemas/StatusNaamgevingEnum' geconstateerd: type: boolean description: Indicator dat de nummeraanduiding in de registratie is opgenomen @@ -2718,8 +2634,8 @@ components: - $ref: '#/components/schemas/Nummeraanduiding' - properties: _links: - $ref: '#/components/schemas/Nummeraanduiding_links' - Nummeraanduiding_links: + $ref: '#/components/schemas/NummeraanduidingLinks' + NummeraanduidingLinks: type: object properties: self: @@ -2743,7 +2659,7 @@ components: description: De naam van de woonplaats. example: Duiven status: - $ref: '#/components/schemas/StatusWoonplaats_enum' + $ref: '#/components/schemas/StatusWoonplaatsEnum' geconstateerd: type: boolean description: Indicator dat de woonplaats in de registratie is opgenomen @@ -2787,19 +2703,19 @@ components: - $ref: '#/components/schemas/Woonplaats' - properties: _links: - $ref: '#/components/schemas/Woonplaats_links' + $ref: '#/components/schemas/WoonplaatsLinks' WoonplaatsHal: allOf: - $ref: '#/components/schemas/WoonplaatsHalBasis' - properties: _embedded: - $ref: '#/components/schemas/Woonplaats_embedded' - Woonplaats_links: + $ref: '#/components/schemas/WoonplaatsEmbedded' + WoonplaatsLinks: type: object properties: self: $ref: '#/components/schemas/HalLink' - Woonplaats_embedded: + WoonplaatsEmbedded: type: object properties: geometrie: @@ -2824,7 +2740,7 @@ components: een pand na oplevering leiden niet tot wijziging van het bouwjaar. example: 1991 status: - $ref: '#/components/schemas/StatusPand_enum' + $ref: '#/components/schemas/StatusPandEnum' geconstateerd: type: boolean description: Indicatie dat het pand in de registratie is opgenomen door @@ -2879,8 +2795,8 @@ components: - $ref: '#/components/schemas/Pand' - properties: _links: - $ref: '#/components/schemas/Pand_links' - Pand_links: + $ref: '#/components/schemas/PandLinks' + PandLinks: type: object properties: self: @@ -2905,13 +2821,13 @@ components: type: array items: $ref: '#/components/schemas/PandHalBasis' - StatusNaamgeving_enum: + StatusNaamgevingEnum: type: string description: Een aanduiding van alle waarden die de status van een openbare ruimte of een nummeraanduiding kan aannemen. enum: - Naamgeving uitgegeven - StatusPand_enum: + StatusPandEnum: type: string description: Een codering van de verschillende waarden die de status van een pand kan aannemen. @@ -2923,19 +2839,19 @@ components: - Verbouwing pand - Sloopvergunning verleend - Pand buiten gebruik - StatusWoonplaats_enum: + StatusWoonplaatsEnum: type: string description: Een aanduiding van alle waarden die de status van een woonplaats kan aannemen. enum: - Woonplaats aangewezen - TypeAdresseerbaarObject_enum: + TypeAdresseerbaarObjectEnum: type: string enum: - verblijfsobject - standplaats - ligplaats - TypeOpenbareRuimte_enum: + TypeOpenbareRuimteEnum: type: string description: Een codering van de verschillende waarden die de typering van een openbare ruimte kan aannemen. @@ -3024,6 +2940,12 @@ components: 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 @@ -3036,73 +2958,77 @@ components: 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 + 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.3.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: - type: object - properties: - href: - type: string - example: /resourcenaam?page=8 - templated: - type: boolean - title: - type: string - example: Laatste pagina - description: uri voor het opvragen van de laatste pagina van deze collectie + $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: - type: object - properties: - href: - type: string - example: /resourcenaam?page=1 - templated: - type: boolean - title: - type: string - example: Eerste pagina - description: uri voor het opvragen van de eerste pagina van deze collectie + $ref: '#/components/schemas/HalLink' previous: - type: object - properties: - href: - type: string - example: /resourcenaam?page=3 - templated: - type: boolean - title: - type: string - example: Vorige pagina - description: uri voor het opvragen van de vorige pagina van deze collectie + $ref: '#/components/schemas/HalLink' next: - type: object - properties: - href: - type: string - example: /resourcenaam?page=5 - templated: - type: boolean - title: - type: string - example: Volgende pagina - description: uri voor het opvragen van de volgende pagina van deze collectie + $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 @@ -3324,9 +3250,7 @@ components: description: CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel. schema: - type: string - enum: - - epsg:28992 + $ref: '#/components/schemas/CrsEnum' securitySchemes: apiKeyBAG: type: apiKey diff --git a/specificatie/openapi.yaml b/specificatie/openapi.yaml index 77f7d052..6e115f51 100644 --- a/specificatie/openapi.yaml +++ b/specificatie/openapi.yaml @@ -10,7 +10,7 @@ servers: 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.1.0" + version: "1.2.0" termsOfService: https://zakelijk.kadaster.nl/algemene-voorwaarden contact: name: Kadaster - Beheerder Landelijke Voorziening BAG @@ -36,38 +36,38 @@ paths: 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.1.0/api-specificatie/common.yaml#/components/parameters/page' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/parameters/pageSize' + - $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.1.0/api-specificatie/common.yaml#/components/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/default' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' /adressen: get: @@ -77,45 +77,45 @@ paths: tags: - Adres summary: "vindt adressen" - description: "Vind een actueel adres met de identificatie van het zoekresultaat uit de operatie get /adressen/zoek, de pandidentificatie of de adresseerbaarobjectidentificatie. 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.1.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.1.0/features/expand.feature)." + description: "Vind een actueel adres met de identificatie van het zoekresultaat uit de operatie get /adressen/zoek, de pandidentificatie of de adresseerbaarobjectidentificatie. 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)." 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.1.0/api-specificatie/common.yaml#/components/parameters/expand' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/parameters/fields' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/parameters/page' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/parameters/pageSize' + - $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' responses: '200': description: "Geslaagd" headers: api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/default' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' /adressen/{nummeraanduidingidentificatie}: get: @@ -125,39 +125,39 @@ paths: 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.1.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.1.0/features/expand.feature)." + 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 en openbare ruimte, 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.1.0/api-specificatie/common.yaml#/components/parameters/expand' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.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/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.1.0/api-specificatie/common.yaml#/components/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/default' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' /adresseerbareobjecten/{adresseerbaarobjectidentificatie}: get: @@ -167,44 +167,44 @@ paths: 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.1.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.1.0/features/expand.feature)." + 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.1.0/api-specificatie/common.yaml#/components/parameters/expand' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/parameters/fields' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.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/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.1.0/api-specificatie/common.yaml#/components/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/headers/contentCrs' + $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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/default' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' /adresseerbareobjecten: get: @@ -214,49 +214,49 @@ paths: tags: - Adresseerbaar object summary: "vindt verblijfsobjecten, ligplaatsen, standplaatsen" - description: "Zoek actuele adresseerbare objecten (verblijfsobjecten, standplaatsen of ligplaatsen) met een nummeraanduidingidentificatie of pandidentificatie. 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.1.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.1.0/features/expand.feature)." + description: "Zoek actuele adresseerbare objecten (verblijfsobjecten, standplaatsen of ligplaatsen) met een nummeraanduidingidentificatie of pandidentificatie. 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/nummeraanduidingIdentificatie-query' - $ref: '#/components/parameters/pandIdentificatie-query' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/parameters/expand' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/parameters/fields' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/parameters/acceptCrs' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/parameters/page' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/parameters/pageSize' + - $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' responses: '200': description: "Geslaagd" headers: api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/headers/contentCrs' + $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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/default' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' /woonplaatsen/{woonplaatsidentificatie}: get: @@ -266,44 +266,44 @@ paths: 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.1.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.1.0/features/expand.feature)." + 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.1.0/api-specificatie/common.yaml#/components/parameters/expand' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/parameters/fields' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.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/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.1.0/api-specificatie/common.yaml#/components/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/headers/contentCrs' + $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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/default' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' /openbareruimten/{openbareruimteidentificatie}: get: @@ -313,38 +313,38 @@ paths: 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.1.0/features/fields.feature)." + 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.1.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/fields' responses: '200': description: "Geslaagd" headers: api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/default' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' /nummeraanduidingen/{nummeraanduidingidentificatie}: get: @@ -354,38 +354,38 @@ paths: 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.1.0/features/fields.feature)." + 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.1.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/fields' responses: '200': description: "Geslaagd" headers: api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/default' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' /panden/{pandidentificatie}: get: @@ -395,43 +395,43 @@ paths: 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.1.0/features/fields.feature)." + 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.1.0/api-specificatie/common.yaml#/components/parameters/fields' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.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/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.1.0/api-specificatie/common.yaml#/components/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/headers/contentCrs' + $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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/default' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' /panden: get: @@ -441,46 +441,46 @@ paths: tags: - Pand summary: "vindt panden" - description: "Zoek actuele panden met de identificatie van een adresseerbaar object, nummeraanduiding of een locatie. 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.1.0/features/fields.feature)." + description: "Zoek actuele panden met de identificatie van een adresseerbaar object, nummeraanduiding of een locatie. 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.1.0/api-specificatie/common.yaml#/components/parameters/fields' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/parameters/acceptCrs' - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/parameters/contentCrs' + - $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' responses: '200': description: "Geslaagd" headers: api-version: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/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.1.0/api-specificatie/common.yaml#/components/headers/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.1.0/api-specificatie/common.yaml#/components/headers/contentCrs' + $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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/412' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/412' '415': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/responses/415' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/415' '500': - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/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.1.0/api-specificatie/common.yaml#/components/responses/default' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/responses/default' components: @@ -627,18 +627,18 @@ components: - $ref: '#/components/schemas/ZoekResultaat' - properties: _links: - $ref: '#/components/schemas/ZoekResultaat_links' - ZoekResultaat_links: + $ref: '#/components/schemas/ZoekResultaatLinks' + ZoekResultaatLinks: type: object properties: adres: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' ZoekResultaatHalCollectie: type: object description: "Resultaten als lijst." properties: _links: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/schemas/HalPaginationLinksMetLast' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalPaginationLinksMetLast' _embedded: type: object properties: @@ -682,6 +682,14 @@ components: - $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 @@ -749,18 +757,18 @@ components: - $ref: '#/components/schemas/AdresHalBasis' - properties: _embedded: - $ref: '#/components/schemas/Adres_embedded' + $ref: '#/components/schemas/AdresEmbedded' AdresHalBasis: allOf: - $ref: '#/components/schemas/AdresUitgebreid' - properties: _links: - $ref: '#/components/schemas/Adres_links' + $ref: '#/components/schemas/AdresLinks' AdresHalCollectie: type: object properties: _links: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/schemas/HalPaginationLinksMetLast' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalPaginationLinksMetLast' _embedded: properties: adressen: @@ -768,29 +776,29 @@ components: $ref: '#/components/schemas/AdresHal' type: array type: object - Adres_links: + AdresLinks: type: object properties: self: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' - Adres_embedded: + $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: @@ -812,7 +820,7 @@ components: type: "string" description: "Het domein waartoe de identificatie behoort." type: - $ref: '#/components/schemas/TypeAdresseerbaarObject_enum' + $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." @@ -825,7 +833,7 @@ components: type: string gebruiksdoelen: items: - $ref: '#/components/schemas/Gebruiksdoel_enum' + $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." @@ -846,7 +854,7 @@ components: oppervlakte: type: integer status: - $ref: '#/components/schemas/AdresseerbaarObjectStatus_enum' + $ref: '#/components/schemas/AdresseerbaarObjectStatusEnum' mogelijkOnjuist: $ref: '#/components/schemas/AdresseerbaarObjectMogelijkOnjuist' AdresseerbaarObjectHal: @@ -854,13 +862,13 @@ components: - $ref: '#/components/schemas/AdresseerbaarObjectHalBasis' - properties: _embedded: - $ref: '#/components/schemas/AdresseerbaarObject_embedded' + $ref: '#/components/schemas/AdresseerbaarObjectEmbedded' AdresseerbaarObjectHalBasis: allOf: - $ref: '#/components/schemas/AdresseerbaarObject' - properties: _links: - $ref: '#/components/schemas/AdresseerbaarObject_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." @@ -882,7 +890,7 @@ components: items: type: string example: "Locatie/contour mogelijk onjuist." - AdresseerbaarObject_embedded: + AdresseerbaarObjectEmbedded: type: object properties: adressen: @@ -893,21 +901,21 @@ components: type: "array" items: $ref: '#/components/schemas/PandHalBasis' - AdresseerbaarObject_links: + 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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' AdresseerbaarobjectHalCollectie: type: object properties: @@ -919,8 +927,8 @@ components: type: array type: object _links: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/schemas/HalPaginationLinksMetLast' - AdresseerbaarObjectStatus_enum: + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalPaginationLinksMetLast' + AdresseerbaarObjectStatusEnum: type: string enum: # Ligplaats / standplaats huidige statussen @@ -931,7 +939,7 @@ components: - 'Verblijfsobject in gebruik' - 'Verbouwing verblijfsobject' - 'Verblijfsobject buiten gebruik' - Gebruiksdoel_enum: + GebruiksdoelEnum: type: string enum: - 'woonfunctie' @@ -961,9 +969,9 @@ components: type: string example: 'Laan van de landinrichtingscommissie Duiven-Westervoort' type: - $ref: '#/components/schemas/TypeOpenbareRuimte_enum' + $ref: '#/components/schemas/TypeOpenbareRuimteEnum' status: - $ref: '#/components/schemas/StatusNaamgeving_enum' + $ref: '#/components/schemas/StatusNaamgevingEnum' korteNaam: description: "De officiële openbareruimtenaam of een verkorte versie. Beiden hebben maximaal 24 tekens." type: string @@ -1011,15 +1019,15 @@ components: - $ref: '#/components/schemas/OpenbareRuimte' - properties: _links: - $ref: '#/components/schemas/OpenbareRuimte_links' + $ref: '#/components/schemas/OpenbareRuimteLinks' - OpenbareRuimte_links: + OpenbareRuimteLinks: type: object properties: self: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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: @@ -1048,7 +1056,7 @@ components: type: string example: '6922KZ' status: - $ref: '#/components/schemas/StatusNaamgeving_enum' + $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 @@ -1107,21 +1115,21 @@ components: - $ref: '#/components/schemas/Nummeraanduiding' - properties: _links: - $ref: '#/components/schemas/Nummeraanduiding_links' + $ref: '#/components/schemas/NummeraanduidingLinks' - Nummeraanduiding_links: + NummeraanduidingLinks: type: object properties: self: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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: @@ -1138,7 +1146,7 @@ components: type: string example: 'Duiven' status: - $ref: '#/components/schemas/StatusWoonplaats_enum' + $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." @@ -1174,20 +1182,20 @@ components: - $ref: '#/components/schemas/Woonplaats' - properties: _links: - $ref: '#/components/schemas/Woonplaats_links' + $ref: '#/components/schemas/WoonplaatsLinks' WoonplaatsHal: allOf: - $ref: '#/components/schemas/WoonplaatsHalBasis' - properties: _embedded: - $ref: '#/components/schemas/Woonplaats_embedded' - Woonplaats_links: + $ref: '#/components/schemas/WoonplaatsEmbedded' + WoonplaatsLinks: type: object properties: self: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink' - Woonplaats_embedded: + WoonplaatsEmbedded: type: object properties: geometrie: @@ -1211,7 +1219,7 @@ components: type: integer example: 1991 status: - $ref: '#/components/schemas/StatusPand_enum' + $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." @@ -1257,27 +1265,27 @@ components: - $ref: '#/components/schemas/Pand' - properties: _links: - $ref: '#/components/schemas/Pand_links' + $ref: '#/components/schemas/PandLinks' - Pand_links: + PandLinks: type: object properties: self: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalLink' + $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.1.0/api-specificatie/common.yaml#/components/schemas/HalCollectionLinks' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalCollectionLinks' _embedded: type: object properties: @@ -1285,12 +1293,12 @@ components: type: array items: $ref: '#/components/schemas/PandHalBasis' - StatusNaamgeving_enum: + StatusNaamgevingEnum: description: "Een aanduiding van alle waarden die de status van een openbare ruimte of een nummeraanduiding kan aannemen." type: string enum: - 'Naamgeving uitgegeven' - StatusPand_enum: + StatusPandEnum: description: "Een codering van de verschillende waarden die de status van een pand kan aannemen." type: string enum: @@ -1301,18 +1309,18 @@ components: - 'Verbouwing pand' - 'Sloopvergunning verleend' - 'Pand buiten gebruik' - StatusWoonplaats_enum: + StatusWoonplaatsEnum: description: "Een aanduiding van alle waarden die de status van een woonplaats kan aannemen." type: string enum: - 'Woonplaats aangewezen' - TypeAdresseerbaarObject_enum: + TypeAdresseerbaarObjectEnum: type: string enum: - 'verblijfsobject' - 'standplaats' - 'ligplaats' - TypeOpenbareRuimte_enum: + TypeOpenbareRuimteEnum: description: "Een codering van de verschillende waarden die de typering van een openbare ruimte kan aannemen." type: string enum: