openapi: 3.0.0
info:
  title: Huidige bevragingen API
  description: Deze API levert actuele gegevens over adressen, adresseerbare objecten
    en panden. Actueel betekent in deze API `zonder eindstatus`. De bron voor deze
    API is de basisregistratie adressen en gebouwen (BAG).
  termsOfService: https://zakelijk.kadaster.nl/algemene-voorwaarden
  contact:
    name: Kadaster - Beheerder Landelijke Voorziening BAG
    url: https://zakelijk.kadaster.nl/bag
    email: bag@kadaster.nl
  license:
    name: European Union Public License, version 1.2 (EUPL-1.2)
    url: https://eupl.eu/1.2/nl/
  version: 1.5.0
servers:
- url: https://api.bag.acceptatie.kadaster.nl/esd/huidigebevragingen/v1
  description: LVBAG - ACCEPTATIE
- url: https://api.bag.kadaster.nl/esd/huidigebevragingen/v1
  description: LVBAG - PRODUCTIE
security:
- apiKeyBAG: []
paths:
  /adressen/zoek:
    get:
      tags:
      - Adres
      summary: '"fuzzy" zoeken van adressen'
      description: Free query zoeken van adressen met postcode, woonplaats, straatnaam,
        huisnummer, huisletter, huisnummertoevoeging. Delen van de adressen in het
        antwoord matchen exact met jouw invoer. Je vindt een adres door de zoekresultaatidentificatie
        uit het antwoord te gebruiken in get/adressen
      operationId: zoek
      parameters:
      - name: zoek
        in: query
        description: Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter,
          huisnummertoevoeging.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: Pagina nummer
        required: false
        schema:
          minimum: 1
          type: integer
          default: 1
      - name: pageSize
        in: query
        required: false
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 20
      responses:
        "200":
          description: Geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Pagination-Page:
              $ref: '#/components/headers/X_Pagination_Page'
            X-Pagination-Limit:
              $ref: '#/components/headers/X_Pagination_Limit'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ZoekResultaatHalCollectie'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed
                  syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.vng.nl/realisatie/api/validaties/integer
                  name: verblijfplaats__huisnummer
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST
                  include a WWW-Authenticate header field (section 14.47) containing
                  a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill
                  it.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "406":
          description: Not Acceptable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
                title: Gevraagde contenttype wordt niet ondersteund.
                status: 406
                detail: The resource identified by the request is only capable of
                  generating response entities which have content characteristics
                  not acceptable according to thr accept headers sent in the request
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAcceptable
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented
                  it from fulfilling the request.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due
                  to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
      deprecated: true
      security:
      - apiKeyBAG: []
  /adressen:
    get:
      tags:
      - Adres
      summary: vindt adressen
      description: "Vind een actueel adres met:\n1. Een pandidentificatie of\n2. Een\
        \ adresseerbaarobjectidentificatie of\n3. Een postcode, huisnummer en optioneel\
        \ huisletter, huisnummertoevoeging en/of exacteMatch.\n4. Een zoekterm.\n\n\
        Gebruik de fields-parameter als je alleen specifieke velden in het antwoord\
        \ wil zien,  zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).\
        \ \nGebruik de expand-parameter als je het antwoord wil uitbreiden met (delen\
        \ van) de gerelateerde resources nummeraanduiding, woonplaats en openbare\
        \ ruimte,  zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature).\n\
        Gebruik de exacteMatch parameter als je alleen resultaten wilt ontvangen die\
        \ exact overeenkomen met de opgegeven zoek criteria, zie [functionele specificaties\
        \ exacteMatch-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/blob/v1.2.0/features/exacte_match.feature).\
        \ Je kunt adresseerbare objecten niet expanden als je tegelijkertijd de query\
        \ parameter adresseerbaarObjectIdentificatie gebruikt."
      operationId: raadpleegAdressen
      parameters:
      - name: pandIdentificatie
        in: query
        description: Identificatie van een pand uit de BAG. Deze is 16 cijfers lang.
        required: false
        style: form
        explode: true
        schema:
          pattern: ^[0-9]{16}$
          type: string
          example: "0226100000008856"
      - name: adresseerbaarObjectIdentificatie
        in: query
        description: De identificatie van een adresseerbaar object uit de BAG. Deze
          is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats
          zijn.
        required: false
        style: form
        explode: true
        schema:
          pattern: ^[0-9]{16}$
          type: string
          example: "0226010000038820"
      - name: zoekresultaatIdentificatie
        in: query
        description: De identificatie van een zoekresultaat van het endpoint get /adressen/zoek.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      - name: expand
        in: query
        description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd
          moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of
          enkele properties geef je in de expand parameter kommagescheiden op. Properties
          die je wil ontvangen geef je op met de resource-naam gevolgd door de property
          naam, met daartussen een punt. In de definitie van het antwoord kun je bij
          _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie
          [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).
        required: false
        schema:
          type: string
      - name: fields
        in: query
        description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen
          door een door komma's gescheiden lijst van property namen op te geven. Bij
          opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven.
          Wanneer de fields parameter niet is opgegeven, worden alle properties met
          een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)
        required: false
        schema:
          type: string
      - name: page
        in: query
        description: Pagina nummer
        required: false
        schema:
          minimum: 1
          type: integer
          default: 1
      - name: pageSize
        in: query
        required: false
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 20
      - name: postcode
        in: query
        description: Postcode van het adres.
        required: false
        style: form
        explode: true
        schema:
          pattern: ^[1-9]{1}[0-9]{3}[ ]{0,1}[a-zA-Z]{2}$
          type: string
        examples:
          zonderSpatie:
            value: 6922KZ
          metSpatie:
            value: 6922 KZ
      - name: huisnummer
        in: query
        description: Huisnummer van het adres.
        required: false
        style: form
        explode: true
        schema:
          maximum: 99999
          minimum: 1
          type: integer
          example: 1
      - name: huisletter
        in: query
        description: 'Een toevoeging (in de vorm van een letter) aan een huisnummer
          van het adres. Bijvoorbeeld:  Bij adres: Belgiëlaan 1 A2, 2391 PH  HAZERSWOUDE-DORP,
          is 1 het huisnummer en A de huisletter.'
        required: false
        style: form
        explode: true
        schema:
          pattern: ^[a-zA-Z]{1}$
          type: string
          example: A
      - name: huisnummertoevoeging
        in: query
        description: 'Een toevoeging (in de vorm van maximaal 4 cijfers of letters)
          aan een huisnummer of een combinatie van huisnummer en huisletter van het
          adres. Bijvoorbeeld: Bij het adres: Belgiëlaan 1 A2, 2391 PH  HAZERSWOUDE-DORP,
          is 1 het huisnummer, A de huisletter en 2 de huisnummertoevoeging.'
        required: false
        style: form
        explode: true
        schema:
          pattern: ^[0-9a-zA-Z]{1,4}$
          type: string
          example: bis
      - name: exacteMatch
        in: query
        description: Geeft aan of de resultaten van de zoekopdracht exact overeen
          moeten komen met de opgegeven parameters,  zie [functionele specificatie
          exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature).
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          example: true
          default: false
      - name: q
        in: query
        description: Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter,
          huisnummertoevoeging.
        required: false
        style: form
        explode: true
        schema:
          maxLength: 255
          minLength: 1
          type: string
      responses:
        "200":
          description: Geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Pagination-Page:
              $ref: '#/components/headers/X_Pagination_Page'
            X-Pagination-Limit:
              $ref: '#/components/headers/X_Pagination_Limit'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/AdresHalCollectie'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed
                  syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.vng.nl/realisatie/api/validaties/integer
                  name: verblijfplaats__huisnummer
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST
                  include a WWW-Authenticate header field (section 14.47) containing
                  a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill
                  it.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "406":
          description: Not Acceptable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
                title: Gevraagde contenttype wordt niet ondersteund.
                status: 406
                detail: The resource identified by the request is only capable of
                  generating response entities which have content characteristics
                  not acceptable according to thr accept headers sent in the request
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAcceptable
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented
                  it from fulfilling the request.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due
                  to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
      security:
      - apiKeyBAG: []
  /adressen/{nummeraanduidingidentificatie}:
    get:
      tags:
      - Adres
      summary: levert een adres
      description: "Raadpleeg een actueel adres met de nummeraanduidingidentificatie.\
        \ \nGebruik de fields-parameter als je alleen specifieke velden in het antwoord\
        \ wil zien,  zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).\
        \ \nGebruik de expand-parameter als je het antwoord wil uitbreiden met (delen\
        \ van) de gerelateerde resources nummeraanduiding, woonplaats, openbare ruimte,\
        \ adresseerbaarobject,  zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature)."
      operationId: raadpleegAdresMetNumId
      parameters:
      - name: nummeraanduidingidentificatie
        in: path
        description: Identificatie van een nummeraanduiding uit de BAG. Deze is 16
          cijfers lang.
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^[0-9]{16}$
          type: string
          example: "0226200000038923"
      - name: expand
        in: query
        description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd
          moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of
          enkele properties geef je in de expand parameter kommagescheiden op. Properties
          die je wil ontvangen geef je op met de resource-naam gevolgd door de property
          naam, met daartussen een punt. In de definitie van het antwoord kun je bij
          _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie
          [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).
        required: false
        schema:
          type: string
      - name: fields
        in: query
        description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen
          door een door komma's gescheiden lijst van property namen op te geven. Bij
          opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven.
          Wanneer de fields parameter niet is opgegeven, worden alle properties met
          een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/AdresHal'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed
                  syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.vng.nl/realisatie/api/validaties/integer
                  name: verblijfplaats__huisnummer
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST
                  include a WWW-Authenticate header field (section 14.47) containing
                  a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill
                  it.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "404":
          description: Not Found
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
                title: Opgevraagde resource bestaat niet.
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notFound
        "406":
          description: Not Acceptable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
                title: Gevraagde contenttype wordt niet ondersteund.
                status: 406
                detail: The resource identified by the request is only capable of
                  generating response entities which have content characteristics
                  not acceptable according to thr accept headers sent in the request
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAcceptable
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented
                  it from fulfilling the request.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due
                  to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
      security:
      - apiKeyBAG: []
  /adresseerbareobjecten/{adresseerbaarobjectidentificatie}:
    get:
      tags:
      - Adresseerbaar object
      summary: levert een verblijfsobject, standplaats of ligplaats
      description: Raadpleeg een actueel adresseerbaar object met de identificatie.
        Dit is de identificatie van een verblijfsobject, ligplaats of standplaats.
        Gebruik de fields-parameter als je alleen specifieke velden in het antwoord
        wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).
        Gebruik de expand-parameter als je het antwoord wil uitbreiden met (delen
        van) de gerelateerde resources adres en pand, zie [functionele specificaties
        expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature).
      operationId: raadpleegAdresseerbaarobject
      parameters:
      - name: adresseerbaarobjectidentificatie
        in: path
        description: De identificatie van een adresserbaar object uit de BAG. Deze
          is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats
          zijn.
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^[0-9]{16}$
          type: string
          example: "0226010000038820"
      - name: expand
        in: query
        description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd
          moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of
          enkele properties geef je in de expand parameter kommagescheiden op. Properties
          die je wil ontvangen geef je op met de resource-naam gevolgd door de property
          naam, met daartussen een punt. In de definitie van het antwoord kun je bij
          _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie
          [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).
        required: false
        schema:
          type: string
      - name: fields
        in: query
        description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen
          door een door komma's gescheiden lijst van property namen op te geven. Bij
          opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven.
          Wanneer de fields parameter niet is opgegeven, worden alle properties met
          een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)
        required: false
        schema:
          type: string
      - name: Accept-Crs
        in: header
        description: Gewenste CRS van de coördinaten in de response.
        required: false
        schema:
          $ref: '#/components/schemas/CrsEnum'
      responses:
        "200":
          description: Geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            Content-Crs:
              $ref: '#/components/headers/contentCrs'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/AdresseerbaarObjectHal'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed
                  syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.vng.nl/realisatie/api/validaties/integer
                  name: verblijfplaats__huisnummer
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST
                  include a WWW-Authenticate header field (section 14.47) containing
                  a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill
                  it.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "404":
          description: Not Found
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
                title: Opgevraagde resource bestaat niet.
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notFound
        "406":
          description: Not Acceptable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
                title: Gevraagde contenttype wordt niet ondersteund.
                status: 406
                detail: The resource identified by the request is only capable of
                  generating response entities which have content characteristics
                  not acceptable according to thr accept headers sent in the request
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAcceptable
        "412":
          description: Precondition failed
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13
                title: Precondition Failed
                status: 412
                detail: The precondition given in one or more of the request-header
                  fields evaluated to false when it was tested on the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: preconditionFailed
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented
                  it from fulfilling the request.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due
                  to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
      security:
      - apiKeyBAG: []
  /adresseerbareobjecten:
    get:
      tags:
      - Adresseerbaar object
      summary: vindt verblijfsobjecten, ligplaatsen, standplaatsen
      description: |-
        Zoek actuele adresseerbare objecten (verblijfsobjecten, standplaatsen of ligplaatsen) met:
        1. een nummeraanduidingidentificatie of
        2. een pandidentificatie of
        3. een lijst met pandidentificaties of
        4. een geometrische contour (rechthoek) in combinatie met status geconstateerd, oppervlakte, gebruiksdoel en/of type.

        Het zoeken van adresseerbare objecten met een oppervlakte en een type=ligplaats of type=standplaats wordt niet ondersteund en levert een foutmelding.
        Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).
        Gebruik de expand-parameter als je het antwoord wil uitbreiden met (delen van) de gerelateerde resources adres en pand, zie  [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature). Je kunt panden niet expanden als je tegelijkertijd de query parameter pandIdentificatie(s) gebruikt.
      operationId: raadpleegAdresseerbareobjecten
      parameters:
      - name: nummeraanduidingIdentificatie
        in: query
        description: Identificatie van een nummeraanduiding uit de BAG. Deze is 16
          cijfers lang.
        required: false
        style: form
        explode: true
        schema:
          pattern: ^[0-9]{16}$
          type: string
          example: "0226200000038923"
      - name: pandIdentificatie
        in: query
        description: Identificatie van een pand uit de BAG. Deze is 16 cijfers lang.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          pattern: ^[0-9]{16}$
          type: string
          example: "0226100000008856"
      - name: expand
        in: query
        description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd
          moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of
          enkele properties geef je in de expand parameter kommagescheiden op. Properties
          die je wil ontvangen geef je op met de resource-naam gevolgd door de property
          naam, met daartussen een punt. In de definitie van het antwoord kun je bij
          _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie
          [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).
        required: false
        schema:
          type: string
      - name: fields
        in: query
        description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen
          door een door komma's gescheiden lijst van property namen op te geven. Bij
          opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven.
          Wanneer de fields parameter niet is opgegeven, worden alle properties met
          een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)
        required: false
        schema:
          type: string
      - name: Accept-Crs
        in: header
        description: Gewenste CRS van de coördinaten in de response.
        required: false
        schema:
          $ref: '#/components/schemas/CrsEnum'
      - name: page
        in: query
        description: Pagina nummer
        required: false
        schema:
          minimum: 1
          type: integer
          default: 1
      - name: pageSize
        in: query
        required: false
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 20
      - name: pandIdentificaties
        in: query
        description: Een lijst met identificaties van panden uit de BAG.
        required: false
        style: form
        explode: false
        schema:
          minItems: 1
          type: array
          example:
          - "0226100000008856"
          items:
            pattern: ^[0-9]{16}$
            type: string
      - name: geconstateerd
        in: query
        description: Geeft aan of naar geconstateerde objecten moet worden gezocht.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: type
        in: query
        description: Geeft aan of het adresseerbaar object een ligplaats, standplaats
          of verblijfsobject is.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/TypeAdresseerbaarObjectEnum'
      - name: gebruiksdoelen
        in: query
        description: De gebruiksdoelen van het verblijfsobject zoals in de vergunning
          is opgenomen of bij constatering is vastgesteld. Als een verblijfsobject
          één van de gebruiksdoelen in deze lijst heeft, dan wordt het verblijfsobject
          in het zoekresultaat meegenomen.
        required: false
        style: form
        explode: true
        schema:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/GebruiksdoelEnum'
      - name: bbox
        in: query
        description: Rechthoek waarbinnen het object dat je zoekt valt. Objecten die
          de rand van de rechthoek raken of kruisen worden in het zoekresultaat meegenomen.
          Voor een definitie van bbox, zie [OGC API Features specificatie - bbox definitie](https://docs.opengeospatial.org/is/17-069r3/17-069r3.html#ats_core_fc-bbox-definition).
          In tegenstelling tot wat er in de OGC API Features specificatie staat, wordt
          hier geen bbox-crs parameter maar de contentCrs parameter gebruikt om aan
          te geven in welk CRS de coördinaten van de bbox zijn. Daarnaast kan er alleen
          met 2D coördinaten worden gezocht. De oppervlakte van de bounding box mag
          maximaal 250 duizend vierkante meter zijn.
        required: false
        style: form
        explode: false
        schema:
          maxItems: 4
          minItems: 4
          type: array
          example:
          - 196733.51
          - 439931.89
          - 196833.51
          - 440031.89
          items:
            type: number
      - name: oppervlakte
        in: query
        description: 'Geef de minimale en maximale oppervlakte op waarbinnen je wilt
          zoeken (in m2). Alleen verblijfsobjecten hebben een oppervlakte en kunnen
          met deze parameter worden gevonden. Ligplaatsen en standplaatsen hebben
          geen oppervlakte en kunnen met deze parameter niet worden gevonden. De oppervlakte
          van een verblijfsobject is een natuurlijk getal tussen 1 (minimaal) en 999999
          (maximaal). Het is niet toegestaan voor min een grotere waarde op te geven
          dan voor max. Is min > max dan treedt een foutmelding op. Bv: oppervlakte[min]=100&oppervlakte[max]=200'
        required: false
        style: deepObject
        explode: true
        schema:
          $ref: '#/components/schemas/OppervlakteFilter'
      - name: Content-Crs
        in: header
        description: CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New
          Nederlands coordinatenstelsel.
        required: false
        schema:
          $ref: '#/components/schemas/CrsEnum'
      responses:
        "200":
          description: Geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Pagination-Page:
              $ref: '#/components/headers/X_Pagination_Page'
            X-Pagination-Limit:
              $ref: '#/components/headers/X_Pagination_Limit'
            Content-Crs:
              $ref: '#/components/headers/contentCrs'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/AdresseerbaarobjectHalCollectie'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed
                  syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.vng.nl/realisatie/api/validaties/integer
                  name: verblijfplaats__huisnummer
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST
                  include a WWW-Authenticate header field (section 14.47) containing
                  a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill
                  it.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "406":
          description: Not Acceptable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
                title: Gevraagde contenttype wordt niet ondersteund.
                status: 406
                detail: The resource identified by the request is only capable of
                  generating response entities which have content characteristics
                  not acceptable according to thr accept headers sent in the request
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAcceptable
        "412":
          description: Precondition failed
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13
                title: Precondition Failed
                status: 412
                detail: The precondition given in one or more of the request-header
                  fields evaluated to false when it was tested on the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: preconditionFailed
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented
                  it from fulfilling the request.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due
                  to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
      security:
      - apiKeyBAG: []
  /woonplaatsen/{woonplaatsidentificatie}:
    get:
      tags:
      - Adres
      summary: levert BAG details van een woonplaats
      description: Raadpleeg een actuele woonplaats met de identificatie. Een woonplaats
        is een gedeelte van het grondgebied van de gemeente met een naam. Gebruik
        de fields-parameter als je alleen specifieke velden in het antwoord wil zien,
        zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).
        Gebruik de expand-parameter als je het antwoord wil uitbreiden met de gerelateerde
        resource geometrie, zie [functionele specificaties expand-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/expand.feature).
      operationId: raadpleegWoonplaats
      parameters:
      - name: woonplaatsidentificatie
        in: path
        description: De identificatie van een woonplaats.
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$
          type: string
          description: 'Deze wordt gebruikt in de operation, bv. /woonplaatsen/0123.
            Waarde: 0001-9999.'
          example: "2096"
      - name: expand
        in: query
        description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd
          moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of
          enkele properties geef je in de expand parameter kommagescheiden op. Properties
          die je wil ontvangen geef je op met de resource-naam gevolgd door de property
          naam, met daartussen een punt. In de definitie van het antwoord kun je bij
          _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie
          [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).
        required: false
        schema:
          type: string
      - name: fields
        in: query
        description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen
          door een door komma's gescheiden lijst van property namen op te geven. Bij
          opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven.
          Wanneer de fields parameter niet is opgegeven, worden alle properties met
          een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)
        required: false
        schema:
          type: string
      - name: Accept-Crs
        in: header
        description: Gewenste CRS van de coördinaten in de response.
        required: false
        schema:
          $ref: '#/components/schemas/CrsEnum'
      responses:
        "200":
          description: Geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            Content-Crs:
              $ref: '#/components/headers/contentCrs'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/WoonplaatsHal'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed
                  syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.vng.nl/realisatie/api/validaties/integer
                  name: verblijfplaats__huisnummer
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST
                  include a WWW-Authenticate header field (section 14.47) containing
                  a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill
                  it.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "404":
          description: Not Found
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
                title: Opgevraagde resource bestaat niet.
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notFound
        "406":
          description: Not Acceptable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
                title: Gevraagde contenttype wordt niet ondersteund.
                status: 406
                detail: The resource identified by the request is only capable of
                  generating response entities which have content characteristics
                  not acceptable according to thr accept headers sent in the request
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAcceptable
        "412":
          description: Precondition failed
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13
                title: Precondition Failed
                status: 412
                detail: The precondition given in one or more of the request-header
                  fields evaluated to false when it was tested on the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: preconditionFailed
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented
                  it from fulfilling the request.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due
                  to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
      security:
      - apiKeyBAG: []
  /openbareruimten/{openbareruimteidentificatie}:
    get:
      tags:
      - Adres
      summary: levert BAG detals van een openbare ruimte
      description: Raadpleeg een actuele openbare ruimte met de identificatie. Een
        openbare ruimte is een buitenruimte met een naam die binnen één woonplaats
        ligt, bijvoorbeeld een straat of een plein. Gebruik de fields-parameter als
        je alleen specifieke velden in het antwoord wil zien, zie [functionele specificaties
        fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).
      operationId: raadpleegOpenbareRuimte
      parameters:
      - name: openbareruimteidentificatie
        in: path
        description: Identificatie van een object uit de BAG. Deze is 16 cijfers lang.
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^[0-9]{16}$
          type: string
          example: "0226300000136166"
      - name: fields
        in: query
        description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen
          door een door komma's gescheiden lijst van property namen op te geven. Bij
          opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven.
          Wanneer de fields parameter niet is opgegeven, worden alle properties met
          een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/OpenbareRuimteHalBasis'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed
                  syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.vng.nl/realisatie/api/validaties/integer
                  name: verblijfplaats__huisnummer
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST
                  include a WWW-Authenticate header field (section 14.47) containing
                  a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill
                  it.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "404":
          description: Not Found
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
                title: Opgevraagde resource bestaat niet.
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notFound
        "406":
          description: Not Acceptable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
                title: Gevraagde contenttype wordt niet ondersteund.
                status: 406
                detail: The resource identified by the request is only capable of
                  generating response entities which have content characteristics
                  not acceptable according to thr accept headers sent in the request
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAcceptable
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented
                  it from fulfilling the request.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due
                  to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
      security:
      - apiKeyBAG: []
  /nummeraanduidingen/{nummeraanduidingidentificatie}:
    get:
      tags:
      - Adres
      summary: levert BAG details van een nummeraanduiding
      description: Raadpleeg een actuele nummeraanduiding met de identificatie. Een
        nummeraanduiding is een postcode, huisnummer met evt een huisletter en huisnummertoevoeging
        die hoort bij een verblijfsobject, een standplaats of een ligplaats. Gebruik
        de fields-parameter als je alleen specifieke velden in het antwoord wil zien,
        zie [functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).
      operationId: raadpleegNummeraanduiding
      parameters:
      - name: nummeraanduidingidentificatie
        in: path
        description: Identificatie van een nummeraanduiding uit de BAG. Deze is 16
          cijfers lang.
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^[0-9]{16}$
          type: string
          example: "0226200000038923"
      - name: fields
        in: query
        description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen
          door een door komma's gescheiden lijst van property namen op te geven. Bij
          opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven.
          Wanneer de fields parameter niet is opgegeven, worden alle properties met
          een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/NummeraanduidingHalBasis'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed
                  syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.vng.nl/realisatie/api/validaties/integer
                  name: verblijfplaats__huisnummer
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST
                  include a WWW-Authenticate header field (section 14.47) containing
                  a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill
                  it.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "404":
          description: Not Found
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
                title: Opgevraagde resource bestaat niet.
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notFound
        "406":
          description: Not Acceptable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
                title: Gevraagde contenttype wordt niet ondersteund.
                status: 406
                detail: The resource identified by the request is only capable of
                  generating response entities which have content characteristics
                  not acceptable according to thr accept headers sent in the request
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAcceptable
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented
                  it from fulfilling the request.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due
                  to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
      security:
      - apiKeyBAG: []
  /panden/{pandidentificatie}:
    get:
      tags:
      - Pand
      summary: levert een pand
      description: Raadpleeg een actueel pand met de identificatie. Een pand is een
        bouwkundige, constructief zelfstandige eenheid die direct en duurzaam met
        de aarde is verbonden en betreedbaar en afsluitbaar is. Gebruik de fields-parameter
        als je alleen specifieke velden in het antwoord wil zien, zie [functionele
        specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature).
      operationId: raadpleegPand
      parameters:
      - name: pandidentificatie
        in: path
        description: Identificatie van een pand uit de BAG. Deze is 16 cijfers lang.
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^[0-9]{16}$
          type: string
          example: "0226100000008856"
      - name: fields
        in: query
        description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen
          door een door komma's gescheiden lijst van property namen op te geven. Bij
          opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven.
          Wanneer de fields parameter niet is opgegeven, worden alle properties met
          een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)
        required: false
        schema:
          type: string
      - name: Accept-Crs
        in: header
        description: Gewenste CRS van de coördinaten in de response.
        required: false
        schema:
          $ref: '#/components/schemas/CrsEnum'
      responses:
        "200":
          description: Geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            Content-Crs:
              $ref: '#/components/headers/contentCrs'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/PandHalBasis'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed
                  syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.vng.nl/realisatie/api/validaties/integer
                  name: verblijfplaats__huisnummer
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST
                  include a WWW-Authenticate header field (section 14.47) containing
                  a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill
                  it.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "404":
          description: Not Found
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
                title: Opgevraagde resource bestaat niet.
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notFound
        "406":
          description: Not Acceptable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
                title: Gevraagde contenttype wordt niet ondersteund.
                status: 406
                detail: The resource identified by the request is only capable of
                  generating response entities which have content characteristics
                  not acceptable according to thr accept headers sent in the request
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAcceptable
        "412":
          description: Precondition failed
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13
                title: Precondition Failed
                status: 412
                detail: The precondition given in one or more of the request-header
                  fields evaluated to false when it was tested on the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: preconditionFailed
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented
                  it from fulfilling the request.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due
                  to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
      security:
      - apiKeyBAG: []
  /panden:
    get:
      tags:
      - Pand
      summary: vindt panden
      description: "Zoek actuele panden:\n1. met de identificatie van een adresseerbaar\
        \ object of\n2. met de identificatie van een nummeraanduiding of\n3. met een\
        \ locatie (punt) of \n4. binnen een geometrische contour (rechthoek) die voldoen\
        \ aan de opgegeven status, geconstateerd of bouwjaar.\n\nGebruik de fields-parameter\
        \ als je alleen specifieke velden in het antwoord wil zien, zie  [functionele\
        \ specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/fields.feature)."
      operationId: raadpleegPanden
      parameters:
      - name: adresseerbaarObjectIdentificatie
        in: query
        description: De identificatie van een adresseerbaar object uit de BAG. Deze
          is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats
          zijn.
        required: false
        style: form
        explode: true
        schema:
          pattern: ^[0-9]{16}$
          type: string
          example: "0226010000038820"
      - name: nummeraanduidingIdentificatie
        in: query
        description: Identificatie van een nummeraanduiding uit de BAG. Deze is 16
          cijfers lang.
        required: false
        style: form
        explode: true
        schema:
          pattern: ^[0-9]{16}$
          type: string
          example: "0226200000038923"
      - name: locatie
        in: query
        description: Coördinaten van een locatie die als query-parameter gebruikt
          wordt om een object te zoeken. Let op, explode is false dus het formaat
          is ?locatie=196733.51,439931.89
        required: false
        style: form
        explode: false
        schema:
          maxItems: 2
          minItems: 2
          type: array
          example:
          - 196733.51
          - 439931.89
          items:
            type: number
      - name: fields
        in: query
        description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen
          door een door komma's gescheiden lijst van property namen op te geven. Bij
          opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven.
          Wanneer de fields parameter niet is opgegeven, worden alle properties met
          een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)
        required: false
        schema:
          type: string
      - name: Accept-Crs
        in: header
        description: Gewenste CRS van de coördinaten in de response.
        required: false
        schema:
          $ref: '#/components/schemas/CrsEnum'
      - name: Content-Crs
        in: header
        description: CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New
          Nederlands coordinatenstelsel.
        required: false
        schema:
          $ref: '#/components/schemas/CrsEnum'
      - name: bbox
        in: query
        description: Rechthoek waarbinnen het object dat je zoekt valt. Objecten die
          de rand van de rechthoek raken of kruisen worden in het zoekresultaat meegenomen.
          Voor een definitie van bbox, zie [OGC API Features specificatie - bbox definitie](https://docs.opengeospatial.org/is/17-069r3/17-069r3.html#ats_core_fc-bbox-definition).
          In tegenstelling tot wat er in de OGC API Features specificatie staat, wordt
          hier geen bbox-crs parameter maar de contentCrs parameter gebruikt om aan
          te geven in welk CRS de coördinaten van de bbox zijn. Daarnaast kan er alleen
          met 2D coördinaten worden gezocht. De oppervlakte van de bounding box mag
          maximaal 250 duizend vierkante meter zijn.
        required: false
        style: form
        explode: false
        schema:
          maxItems: 4
          minItems: 4
          type: array
          example:
          - 196733.51
          - 439931.89
          - 196833.51
          - 440031.89
          items:
            type: number
      - name: statusPand
        in: query
        description: Status van het pand.
        required: false
        style: form
        explode: true
        schema:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/StatusPandEnum'
      - name: geconstateerd
        in: query
        description: Geeft aan of naar geconstateerde objecten moet worden gezocht.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: bouwjaar
        in: query
        description: 'Bouwjaar van het pand. Geeft het minimale en/of maximale bouwjaar
          aan van het pand waarnaar moet worden gezocht.  Een bouwjaar is een natuurlijk
          getal tussen 0 (minimaal) en 9999 (maximaal). Bv: bouwjaar[min]=1970&bouwjaar[max]=2010'
        required: false
        style: deepObject
        explode: true
        schema:
          $ref: '#/components/schemas/BouwjaarFilter'
      - name: page
        in: query
        description: Pagina nummer
        required: false
        schema:
          minimum: 1
          type: integer
          default: 1
      - name: pageSize
        in: query
        required: false
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 20
      responses:
        "200":
          description: Geslaagd
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
            warning:
              $ref: '#/components/headers/warning'
            X-Pagination-Page:
              $ref: '#/components/headers/X_Pagination_Page'
            X-Pagination-Limit:
              $ref: '#/components/headers/X_Pagination_Limit'
            Content-Crs:
              $ref: '#/components/headers/contentCrs'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/PandHalCollectie'
        "400":
          description: Bad Request
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/BadRequestFoutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
                title: Ten minste één parameter moet worden opgegeven.
                status: 400
                detail: The request could not be understood by the server due to malformed
                  syntax. The client SHOULD NOT repeat the request without modification.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: paramsRequired
                invalidParams:
                - type: https://www.vng.nl/realisatie/api/validaties/integer
                  name: verblijfplaats__huisnummer
                  code: integer
                  reason: Waarde is geen geldige integer.
        "401":
          description: Unauthorized
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
                title: Niet correct geauthenticeerd.
                status: 401
                detail: The request requires user authentication. The response MUST
                  include a WWW-Authenticate header field (section 14.47) containing
                  a challenge applicable to the requested resource.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: authentication
        "403":
          description: Forbidden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
                title: U bent niet geautoriseerd voor deze operatie.
                status: 403
                detail: The server understood the request, but is refusing to fulfill
                  it.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: autorisation
        "406":
          description: Not Acceptable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7
                title: Gevraagde contenttype wordt niet ondersteund.
                status: 406
                detail: The resource identified by the request is only capable of
                  generating response entities which have content characteristics
                  not acceptable according to thr accept headers sent in the request
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAcceptable
        "412":
          description: Precondition failed
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13
                title: Precondition Failed
                status: 412
                detail: The precondition given in one or more of the request-header
                  fields evaluated to false when it was tested on the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: preconditionFailed
        "500":
          description: Internal Server Error
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
                title: Interne server fout.
                status: 500
                detail: The server encountered an unexpected condition which prevented
                  it from fulfilling the request.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: serverError
        "503":
          description: Service Unavailable
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
              example:
                type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
                title: Bronservice {bron} is tijdelijk niet beschikbaar.
                status: 503
                detail: The service is currently unable to handle the request due
                  to a temporary overloading or maintenance of the server.
                instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde
                code: notAvailable
        default:
          description: Er is een onverwachte fout opgetreden
          headers:
            api-version:
              $ref: '#/components/headers/api_version'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Foutbericht'
      security:
      - apiKeyBAG: []
components:
  schemas:
    ZoekResultaat:
      type: object
      properties:
        omschrijving:
          type: string
          description: Omschrijving van het zoekresultaat
        identificatie:
          type: string
          description: Identificatie van het zoekresultaat
      description: Resultaat van een zoekoperatie dat je kunt gebruiken om een adres
        te vinden met /adressen.
      deprecated: true
    ZoekResultaatHal:
      deprecated: true
      allOf:
      - $ref: '#/components/schemas/ZoekResultaat'
      - properties:
          _links:
            $ref: '#/components/schemas/ZoekResultaatLinks'
    ZoekResultaatLinks:
      type: object
      properties:
        adres:
          $ref: '#/components/schemas/HalLink'
      deprecated: true
    ZoekResultaatHalCollectie:
      type: object
      properties:
        _links:
          $ref: '#/components/schemas/HalPaginationLinksMetLast'
        _embedded:
          $ref: '#/components/schemas/ZoekResultaatHalCollectieEmbedded'
      description: Resultaten als lijst.
      deprecated: true
    ZoekResultaatHalCollectieEmbedded:
      type: object
      properties:
        zoekresultaten:
          type: array
          items:
            $ref: '#/components/schemas/ZoekResultaatHal'
      deprecated: true
    BouwjaarFilter:
      type: object
      properties:
        min:
          maximum: 9999
          minimum: 0
          type: integer
          description: Zoek naar waarden groter of gelijk aan de opgegeven waarde.
        max:
          maximum: 9999
          minimum: 0
          type: integer
          description: Zoek naar waarden kleiner dan de opgegeven waarde.
      description: "\"Zoek binnen een bereik van de opgegeven minimumwaarde tot maximumwaarde.\
        \ \nDe opgegeven minimumwaarde moet lager zijn dan de opgegeven maximumwaarde.\"\
        \n"
    OppervlakteFilter:
      type: object
      properties:
        min:
          maximum: 999999
          minimum: 1
          type: integer
          description: Zoek naar waarden groter of gelijk aan de opgegeven waarde.
        max:
          maximum: 999999
          minimum: 1
          type: integer
          description: Zoek naar waarden kleiner dan de opgegeven waarde.
      description: "\"Zoek binnen een bereik van de opgegeven minimumwaarde tot maximumwaarde.\
        \ \nDe opgegeven minimumwaarde moet lager zijn dan de opgegeven maximumwaarde.\"\
        \n"
    Adres:
      type: object
      properties:
        straat:
          title: openbareruimte naam
          type: string
          description: Een naam die door de gemeente aan een openbare ruimte is gegeven.
          example: Laan van de landinrichtingscommissie Duiven-Westervoort
        huisnummer:
          type: integer
          description: Een nummer dat door de gemeente aan een adresseerbaar object
            is gegeven.
          example: 1
        huisletter:
          type: string
          description: Een toevoeging aan een huisnummer in de vorm van een letter
            die door de gemeente aan een adresseerbaar object is gegeven.
          example: A
        huisnummertoevoeging:
          type: string
          description: Een toevoeging aan een huisnummer of een combinatie van huisnummer
            en huisletter die door de gemeente aan een adresseerbaar object is gegeven.
          example: bis
        postcode:
          type: string
          description: De door PostNL vastgestelde code die bij een bepaalde combinatie
            van een straatnaam en een huisnummer hoort.
          example: 6922KZ
        woonplaats:
          title: woonplaats naam
          type: string
          description: Een woonplaats is een gedeelte van het grondgebied van de gemeente
            met een naam.
          example: Duiven
      description: Eigenschappen van het adres die kunnen worden hergebruikt in andere
        API's met adresgegevens.
    AdresUitgebreid:
      allOf:
      - $ref: '#/components/schemas/Adres'
      - properties:
          adresregel1:
            type: string
            description: De eerste regel van het adres zoals deze gebruikt kan worden
              in postadressering.
            example: Ln vd l D-Westervoort 1
          adresregel2:
            type: string
            description: De tweede regel van het adres zoals deze gebruikt kan worden
              in postadressering.
            example: 6922 KZ  DUIVEN
          korteNaam:
            maxLength: 24
            type: string
            description: De officiële openbareruimtenaam of een verkorte versie. Beiden
              hebben maximaal 24 tekens.
            example: Ln vd l D-Westervoort
          nummeraanduidingIdentificatie:
            type: string
            description: Fungeert ook als identificatie van het adres.
            example: "0226200000038923"
          openbareRuimteIdentificatie:
            type: string
            example: "0226300000136166"
          woonplaatsIdentificatie:
            type: string
            example: "2096"
          adresseerbaarObjectIdentificatie:
            type: string
            example: "0226010000038820"
          pandIdentificaties:
            type: array
            description: Identificatie(s) van het pand of de panden waar het verblijfsobject
              deel van is.
            example:
            - "0226100000008856"
            items:
              type: string
          isNevenadres:
            type: boolean
            description: Indicatie dat dit adres een nevenadres is van een adresseerbaar
              object. Het adres is een hoofdadres als deze indicatie niet wordt meegeleverd.
          geconstateerd:
            type: boolean
            description: Indicatie dat dit adres in de registratie is opgenomen door
              een feitelijke constatering, zonder dat er sprake was van een brondocument/vergunning.
              Het adres is mogelijk illegaal.
          mogelijkOnjuist:
            $ref: '#/components/schemas/AdresMogelijkOnjuist'
        description: Het adres is de benaming van een locatie bestaande uit straatnaam,
          huisnummer, (mogelijk met huisletter, huisnummertoevoeging, postcode) en
          woonplaatsnaam. Dit is de vereenvoudigde samenstelling van de officiële
          naamgeving gebaseerd op woonplaats, openbare ruimte en nummeraanduiding.
    AdresMogelijkOnjuist:
      type: object
      properties:
        adresregel1:
          type: boolean
        adresregel2:
          type: boolean
        korteNaam:
          type: boolean
        straat:
          type: boolean
        huisnummer:
          type: boolean
        huisletter:
          type: boolean
        huisnummertoevoeging:
          type: boolean
        postcode:
          type: boolean
        woonplaats:
          type: boolean
        nummeraanduidingIdentificatie:
          type: boolean
        openbareRuimteIdentificatie:
          type: boolean
        woonplaatsIdentificatie:
          type: boolean
        toelichting:
          type: array
          items:
            type: string
            example: Geometrie of woonplaatsgrens is mogelijk onjuist, waardoor gaten
              of overlappingen ontstaan in de registratie van woonplaatsen. Gevolg
              kan zijn dat een object in een verkeerde woonplaats, in twee woonplaatsen,
              of in geen enkele woonplaats ligt.
      description: Wanneer true is de waarde mogelijk onjuist en wordt juistheid op
        dit moment onderzocht. Zie toelichting.
    AdresHal:
      allOf:
      - $ref: '#/components/schemas/AdresHalBasis'
      - properties:
          _embedded:
            $ref: '#/components/schemas/AdresEmbedded'
    AdresHalBasis:
      allOf:
      - $ref: '#/components/schemas/AdresUitgebreid'
      - properties:
          _links:
            $ref: '#/components/schemas/AdresLinks'
    AdresHalCollectie:
      type: object
      properties:
        _links:
          $ref: '#/components/schemas/HalPaginationLinksMetLast'
        _embedded:
          $ref: '#/components/schemas/AdresHalCollectieEmbedded'
    AdresHalCollectieEmbedded:
      type: object
      properties:
        adressen:
          type: array
          items:
            $ref: '#/components/schemas/AdresHal'
    AdresLinks:
      type: object
      properties:
        self:
          $ref: '#/components/schemas/HalLink'
        openbareRuimte:
          $ref: '#/components/schemas/HalLink'
        nummeraanduiding:
          $ref: '#/components/schemas/HalLink'
        woonplaats:
          $ref: '#/components/schemas/HalLink'
        adresseerbaarObject:
          $ref: '#/components/schemas/HalLink'
        panden:
          type: array
          description: Het/de aan het adres gerelateerde pand(en).
          items:
            $ref: '#/components/schemas/HalLink'
    AdresEmbedded:
      type: object
      properties:
        openbareRuimte:
          $ref: '#/components/schemas/OpenbareRuimteHalBasis'
        nummeraanduiding:
          $ref: '#/components/schemas/NummeraanduidingHalBasis'
        woonplaats:
          $ref: '#/components/schemas/WoonplaatsHalBasis'
        adresseerbaarObject:
          $ref: '#/components/schemas/AdresseerbaarObjectHalBasis'
    AdresseerbaarObject:
      type: object
      properties:
        identificatie:
          type: string
          description: Dit is de identificatie van een verblijfsobject, standplaats
            of ligplaats.
          example: "0226010000038820"
        domein:
          type: string
          description: Het domein waartoe de identificatie behoort.
        type:
          $ref: '#/components/schemas/TypeAdresseerbaarObjectEnum'
        documentdatum:
          type: string
          description: De vaststellingsdatum van het brondocument dat de basis is
            voor opname, wijziging of een verwijdering van een object.
          format: date
          example: 2019-11-22
        documentnummer:
          type: string
          description: De unieke aanduiding van het brondocument op basis waarvan
            een opname, mutatie of een verwijdering van gegevens ten aanzien van een
            woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit
            de MES-1 karakterset zijn toegestaan.
          example: 19SZ2048
        gebruiksdoelen:
          type: array
          items:
            $ref: '#/components/schemas/GebruiksdoelEnum'
        geconstateerd:
          type: boolean
          description: Indicatie dat een standplaats, ligplaats of verblijfsobject
            in de registratie is opgenomen door een feitelijke constatering, zonder
            dat er een brondocument aan ten grondslag ligt. Het adresseerbaar object
            is mogelijk illegaal.
        geometrie:
          $ref: '#/components/schemas/PuntOfVlak'
        pandIdentificaties:
          type: array
          description: Identificatie(s) van het pand of de panden waar het verblijfsobject
            deel van is.
          example:
          - "0226100000008856"
          items:
            type: string
        nummeraanduidingIdentificaties:
          type: array
          description: Identificatie(s) van de hoofd- en nevenadressen van de standplaats,
            ligplaats of verblijfsobject.
          items:
            $ref: '#/components/schemas/NummeraanduidingIdentificatiesArray'
        oppervlakte:
          type: integer
        status:
          $ref: '#/components/schemas/AdresseerbaarObjectStatusEnum'
        mogelijkOnjuist:
          $ref: '#/components/schemas/AdresseerbaarObjectMogelijkOnjuist'
      description: Een adresseerbaarobject is een standplaats, ligplaats of verblijfsobject.
    AdresseerbaarObjectHal:
      allOf:
      - $ref: '#/components/schemas/AdresseerbaarObjectHalBasis'
      - properties:
          _embedded:
            $ref: '#/components/schemas/AdresseerbaarObjectEmbedded'
    AdresseerbaarObjectHalBasis:
      allOf:
      - $ref: '#/components/schemas/AdresseerbaarObject'
      - properties:
          _links:
            $ref: '#/components/schemas/AdresseerbaarObjectLinks'
    AdresseerbaarObjectMogelijkOnjuist:
      type: object
      properties:
        gebruiksdoelen:
          type: boolean
        geometrie:
          type: boolean
        nummeraanduidingIdentificaties:
          type: boolean
        pandIdentificaties:
          type: boolean
        oppervlakte:
          type: boolean
        status:
          type: boolean
        toelichting:
          type: array
          items:
            type: string
            example: Locatie/contour mogelijk onjuist.
      description: Wanneer true is de waarde mogelijk onjuist en wordt juistheid op
        dit moment onderzocht. Zie toelichting.
    AdresseerbaarObjectEmbedded:
      type: object
      properties:
        adressen:
          type: array
          items:
            $ref: '#/components/schemas/AdresHalBasis'
        panden:
          type: array
          items:
            $ref: '#/components/schemas/PandHalBasis'
    AdresseerbaarObjectLinks:
      type: object
      properties:
        adressen:
          type: array
          description: Link(s) naar het hoofdadres en waar van toepassing de nevenadressen
            van het adresseerbaar object.
          items:
            $ref: '#/components/schemas/HalLink'
        panden:
          type: array
          description: Link(s) naar het pand of de panden waar het adresseerbaar object
            deel van uitmaakt.
          items:
            $ref: '#/components/schemas/HalLink'
        self:
          $ref: '#/components/schemas/HalLink'
    AdresseerbaarobjectHalCollectie:
      type: object
      properties:
        _embedded:
          $ref: '#/components/schemas/AdresseerbaarobjectHalCollectieEmbedded'
        _links:
          $ref: '#/components/schemas/HalPaginationLinksMetLast'
    AdresseerbaarobjectHalCollectieEmbedded:
      type: object
      properties:
        adresseerbareObjecten:
          type: array
          items:
            $ref: '#/components/schemas/AdresseerbaarObjectHal'
    AdresseerbaarObjectStatusEnum:
      type: string
      enum:
      - Plaats aangewezen
      - Verblijfsobject gevormd
      - Verblijfsobject in gebruik (niet ingemeten)
      - Verblijfsobject in gebruik
      - Verbouwing verblijfsobject
      - Verblijfsobject buiten gebruik
    GebruiksdoelEnum:
      type: string
      enum:
      - woonfunctie
      - bijeenkomstfunctie
      - celfunctie
      - gezondheidszorgfunctie
      - industriefunctie
      - kantoorfunctie
      - logiesfunctie
      - onderwijsfunctie
      - sportfunctie
      - winkelfunctie
      - overige gebruiksfunctie
    OpenbareRuimte:
      type: object
      properties:
        identificatie:
          type: string
        domein:
          type: string
          description: Het domein waartoe de identificatie behoort.
        naam:
          title: openbare ruimte naam
          type: string
          description: De naam die door de gemeente aan een openbare ruimte is gegeven.
          example: Laan van de landinrichtingscommissie Duiven-Westervoort
        type:
          $ref: '#/components/schemas/TypeOpenbareRuimteEnum'
        status:
          $ref: '#/components/schemas/StatusNaamgevingEnum'
        korteNaam:
          maxLength: 24
          type: string
          description: De officiële openbareruimtenaam of een verkorte versie. Beiden
            hebben maximaal 24 tekens.
          example: Ln vd l D-Westervoort
        geconstateerd:
          type: boolean
          description: Indicator dat een openbare ruimte in de registratie is opgenomen
            door een feitelijke constatering, zonder dat er een brondocument aan ten
            grondslag ligt. De openbare ruimte is mogelijk illegaal.
        documentdatum:
          type: string
          description: De vaststellingsdatum van het brondocument dat de basis is
            voor opname, wijziging of een verwijdering van een object.
          format: date
          example: 2010-02-09
        documentnummer:
          type: string
          description: De unieke aanduiding van het brondocument op basis waarvan
            een opname, mutatie of een verwijdering van gegevens ten aanzien van een
            woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit
            de MES-1 karakterset zijn toegestaan.
          example: BAG-21
        woonplaatsIdentificatie:
          type: string
          description: Een openbare ruimte ligt in een woonplaats.
          example: "2096"
        mogelijkOnjuist:
          $ref: '#/components/schemas/OpenbareRuimteMogelijkOnjuist'
      description: Een buitenruimte met een naam die binnen één woonplaats ligt, bijvoorbeeld
        een straat of een plein.
    OpenbareRuimteMogelijkOnjuist:
      type: object
      properties:
        naam:
          type: boolean
        korteNaam:
          type: boolean
        type:
          type: boolean
        status:
          type: boolean
        woonplaatsIdentificatie:
          type: boolean
        toelichting:
          type: array
          items:
            type: string
            example: Openbare ruimtenaam komt mogelijk niet overeen met de vermelding
              in het straatnaambesluit.
      description: Wanneer true is de waarde mogelijk onjuist en wordt juistheid op
        dit moment onderzocht. Zie toelichting.
    OpenbareRuimteHalBasis:
      allOf:
      - $ref: '#/components/schemas/OpenbareRuimte'
      - properties:
          _links:
            $ref: '#/components/schemas/OpenbareRuimteLinks'
    OpenbareRuimteLinks:
      type: object
      properties:
        self:
          $ref: '#/components/schemas/HalLink'
        woonplaats:
          $ref: '#/components/schemas/HalLink'
    Nummeraanduiding:
      type: object
      properties:
        identificatie:
          type: string
        domein:
          type: string
          description: Het domein waartoe de identificatie behoort.
        huisnummer:
          type: integer
          description: Nummer dat door de gemeente aan een adresseerbaar object is
            gegeven.
          example: 1
        huisletter:
          type: string
          description: Toevoeging aan een huisnummer in de vorm van een letter die
            door de gemeente aan een adresseerbaar object is gegeven.
          example: A
        huisnummertoevoeging:
          type: string
          description: Toevoeging aan een huisnummer of een combinatie van huisnummer
            en huisletter die door de gemeente aan een adresseerbaar object is gegeven.
          example: bis
        postcode:
          type: string
          description: Door PostNL vastgestelde code die bij een bepaalde combinatie
            van een straatnaam en een huisnummer hoort.
          example: 6922KZ
        status:
          $ref: '#/components/schemas/StatusNaamgevingEnum'
        geconstateerd:
          type: boolean
          description: Indicator dat de nummeraanduiding in de registratie is opgenomen
            door een feitelijke constatering, zonder dat er sprake was van een brondocument/vergunning.
            De nummeraanduiding is mogelijk illegaal.
        documentdatum:
          type: string
          description: De vaststellingsdatum van het brondocument dat de basis is
            voor opname, wijziging of een verwijdering van een object.
          format: date
          example: 2019-11-25
        documentnummer:
          type: string
          description: Identificatie van het brondocument dat ten grondslag ligt aan
            de opname, mutatie of een verwijdering van gegevens.
          example: Duiven 25112019
        woonplaatsIdentificatie:
          type: string
          description: Een nummeraanduiding ligt in een woonplaats.
          example: "2096"
        openbareRuimteIdentificatie:
          type: string
          description: Een nummeraanduiding ligt aan een openbare ruimte.
          example: "0226300000136166"
        mogelijkOnjuist:
          $ref: '#/components/schemas/NummeraanduidingMogelijkOnjuist'
      description: Een postcode, huisnummer met mogelijk een huisletter en huisnummertoevoeging
        die hoort bij een verblijfsobject, een standplaats of een ligplaats.
    NummeraanduidingIdentificatiesArray:
      type: object
      properties:
        nummeraanduidingIdentificatie:
          type: string
          example: "0226200000038923"
        isNevenadres:
          type: boolean
    NummeraanduidingMogelijkOnjuist:
      type: object
      properties:
        huisnummer:
          type: boolean
        huisletter:
          type: boolean
        huisnummertoevoeging:
          type: boolean
        postcode:
          type: boolean
        status:
          type: boolean
        woonplaatsIdentificatie:
          type: boolean
        openbareRuimteIdentificatie:
          type: boolean
        toelichting:
          type: array
          items:
            type: string
            example: Woonplaats bestaat mogelijk niet.
      description: Wanneer true is de waarde mogelijk onjuist en wordt juistheid op
        dit moment onderzocht. Zie toelichting.
    NummeraanduidingHalBasis:
      allOf:
      - $ref: '#/components/schemas/Nummeraanduiding'
      - properties:
          _links:
            $ref: '#/components/schemas/NummeraanduidingLinks'
    NummeraanduidingLinks:
      type: object
      properties:
        self:
          $ref: '#/components/schemas/HalLink'
        adres:
          $ref: '#/components/schemas/HalLink'
        openbareRuimte:
          $ref: '#/components/schemas/HalLink'
        woonplaats:
          $ref: '#/components/schemas/HalLink'
    Woonplaats:
      type: object
      properties:
        identificatie:
          type: string
        domein:
          type: string
          description: Het domein waartoe de identificatie behoort.
        naam:
          type: string
          description: De naam van de woonplaats.
          example: Duiven
        status:
          $ref: '#/components/schemas/StatusWoonplaatsEnum'
        geconstateerd:
          type: boolean
          description: Indicator dat de woonplaats in de registratie is opgenomen
            door een feitelijke constatering, zonder dat er een brondocument aan ten
            grondslag ligt. De woonplaats is mogelijk illegaal.
        documentdatum:
          type: string
          description: De vaststellingsdatum van het brondocument dat de basis is
            voor opname, wijziging of een verwijdering van een object.
          format: date
          example: 2009-02-09
        documentnummer:
          type: string
          description: De unieke aanduiding van het brondocument op basis waarvan
            een opname, mutatie of een verwijdering van gegevens ten aanzien van een
            woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit
            de MES-1 karakterset zijn toegestaan.
          example: "09.0898"
        mogelijkOnjuist:
          $ref: '#/components/schemas/WoonplaatsMogelijkOnjuist'
      description: Een woonplaats is een gedeelte van het grondgebied van de gemeente
        met een naam.
    WoonplaatsMogelijkOnjuist:
      type: object
      properties:
        naam:
          type: boolean
        geometrie:
          type: boolean
        status:
          type: boolean
        toelichting:
          type: array
          items:
            type: string
            example: Woonplaats bestaat mogelijk niet.
      description: Wanneer true is de waarde mogelijk onjuist en wordt juistheid op
        dit moment onderzocht. Zie toelichting.
    WoonplaatsHalBasis:
      allOf:
      - $ref: '#/components/schemas/Woonplaats'
      - properties:
          _links:
            $ref: '#/components/schemas/WoonplaatsLinks'
    WoonplaatsHal:
      allOf:
      - $ref: '#/components/schemas/WoonplaatsHalBasis'
      - properties:
          _embedded:
            $ref: '#/components/schemas/WoonplaatsEmbedded'
    WoonplaatsLinks:
      type: object
      properties:
        self:
          $ref: '#/components/schemas/HalLink'
    WoonplaatsEmbedded:
      type: object
      properties:
        geometrie:
          $ref: '#/components/schemas/VlakOfMultivlak'
    Pand:
      type: object
      properties:
        identificatie:
          type: string
          description: De unieke aanduiding van een pand. Elk pand waarvan gegevens
            zijn opgenomen in de BAG wordt uniek aangeduid door middel van een identificatiecode.
        domein:
          type: string
          description: Het domein waartoe de identificatie behoort.
        geometrie:
          $ref: '#/components/schemas/polygonGeoJSON'
        oorspronkelijkBouwjaar:
          type: integer
          description: Het jaar waarin een pand oorspronkelijk als bouwkundig gereed
            is opgeleverd. Door de gemeente wordt een inschatting gemaakt van het
            bouwjaar, en aangepast als het pand wordt opgeleverd. Wijzigingen aan
            een pand na oplevering leiden niet tot wijziging van het bouwjaar.
          example: 1991
        status:
          $ref: '#/components/schemas/StatusPandEnum'
        geconstateerd:
          type: boolean
          description: Indicatie dat het pand in de registratie is opgenomen door
            een feitelijke constatering, zonder dat er sprake was van een brondocument/vergunning.
            Het pand is mogelijk illegaal.
        documentdatum:
          type: string
          description: De vaststellingsdatum van het brondocument dat de basis is
            voor opname, wijziging of een verwijdering van een object.
          format: date
          example: 2009-05-12
        documentnummer:
          type: string
          description: De unieke aanduiding van het brondocument op basis waarvan
            een opname, mutatie of een verwijdering van gegevens ten aanzien van een
            woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit
            de MES-1 karakterset zijn toegestaan.
          example: 09.BW.0273
        adresseerbaarObjectIdentificaties:
          type: array
          example:
          - "0226010000038820"
          items:
            type: string
        nummeraanduidingIdentificaties:
          type: array
          description: Identificatie(s) van de hoofd- en nevenadressen van het pand.
          items:
            $ref: '#/components/schemas/NummeraanduidingIdentificatiesArray'
        mogelijkOnjuist:
          $ref: '#/components/schemas/PandMogelijkOnjuist'
      description: Een pand is een bouwkundige, constructief zelfstandige eenheid
        die direct en duurzaam met de aarde is verbonden en betreedbaar en afsluitbaar
        is.
    PandMogelijkOnjuist:
      type: object
      properties:
        geometrie:
          type: boolean
        oorspronkelijkBouwjaar:
          type: boolean
        status:
          type: boolean
        toelichting:
          type: array
          items:
            type: string
            example: Mogelijk is de bouw al gereed of is het pand niet gerealiseerd.
      description: Wanneer true is de waarde mogelijk onjuist en wordt juistheid op
        dit moment onderzocht. Zie toelichting.
    PandHalBasis:
      allOf:
      - $ref: '#/components/schemas/Pand'
      - properties:
          _links:
            $ref: '#/components/schemas/PandLinks'
    PandLinks:
      type: object
      properties:
        self:
          $ref: '#/components/schemas/HalLink'
        adressen:
          type: array
          items:
            $ref: '#/components/schemas/HalLink'
        adresseerbareObjecten:
          type: array
          items:
            $ref: '#/components/schemas/HalLink'
    PandHalCollectie:
      type: object
      properties:
        _links:
          $ref: '#/components/schemas/HalPaginationLinksMetLast'
        _embedded:
          $ref: '#/components/schemas/PandHalCollectieEmbedded'
    PandHalCollectieEmbedded:
      type: object
      properties:
        panden:
          type: array
          items:
            $ref: '#/components/schemas/PandHalBasis'
    StatusNaamgevingEnum:
      type: string
      description: Een aanduiding van alle waarden die de status van een openbare
        ruimte of een nummeraanduiding kan aannemen.
      enum:
      - Naamgeving uitgegeven
    StatusPandEnum:
      type: string
      enum:
      - Bouwvergunning verleend
      - Bouw gestart
      - Pand in gebruik (niet ingemeten)
      - Pand in gebruik
      - Verbouwing pand
      - Sloopvergunning verleend
      - Pand buiten gebruik
    StatusWoonplaatsEnum:
      type: string
      description: Een aanduiding van alle waarden die de status van een woonplaats
        kan aannemen.
      enum:
      - Woonplaats aangewezen
    TypeAdresseerbaarObjectEnum:
      type: string
      enum:
      - verblijfsobject
      - standplaats
      - ligplaats
    TypeOpenbareRuimteEnum:
      type: string
      description: Een codering van de verschillende waarden die de typering van een
        openbare ruimte kan aannemen.
      enum:
      - Weg
      - Water
      - Spoorbaan
      - Terrein
      - Kunstwerk
      - Landschappelijk gebied
      - Administratief gebied
    PuntOfVlak:
      type: object
      properties:
        punt:
          $ref: '#/components/schemas/pointGeoJSON'
        vlak:
          $ref: '#/components/schemas/polygonGeoJSON'
      description: Een samengesteld geometriegegevenstype waarbij wordt afgedwongen
        dat voor de geometrie een keuze gemaakt moet worden tussen een punt of een
        vlak.
    VlakOfMultivlak:
      type: object
      properties:
        vlak:
          $ref: '#/components/schemas/polygonGeoJSON'
        multivlak:
          $ref: '#/components/schemas/multipolygonGeoJSON'
      description: Een samengesteld geometriegegevenstype waarbij wordt afgedwongen
        dat voor de geometrie een keuze gemaakt moet worden tussen een vlak (GM_Surface)
        of een multivlak (GM_MultiSurface).
    BadRequestFoutbericht:
      allOf:
      - $ref: '#/components/schemas/Foutbericht'
      - type: object
        properties:
          invalidParams:
            type: array
            description: Foutmelding per fout in een parameter. Alle gevonden fouten
              worden één keer teruggemeld.
            items:
              $ref: '#/components/schemas/InvalidParams'
    Foutbericht:
      type: object
      properties:
        type:
          type: string
          description: Link naar meer informatie over deze fout
          format: uri
        title:
          type: string
          description: Beschrijving van de fout
        status:
          type: integer
          description: Http status code
        detail:
          type: string
          description: Details over de fout
        instance:
          type: string
          description: Uri van de aanroep die de fout heeft veroorzaakt
          format: uri
        code:
          minLength: 1
          type: string
          description: Systeemcode die het type fout aangeeft
      description: Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807).
    InvalidParams:
      type: object
      properties:
        type:
          type: string
          format: uri
          example: https://www.vng.nl/realisatie/api/{major-versie}/validaties/integer
        name:
          type: string
          description: Naam van de parameter
          example: verblijfplaats__huisnummer
        code:
          minLength: 1
          type: string
          description: Systeemcode die het type fout aangeeft
          example: integer
        reason:
          type: string
          description: Beschrijving van de fout op de parameterwaarde
          example: Waarde is geen geldige integer.
      description: Details over fouten in opgegeven parameters
    CrsEnum:
      type: string
      description: CRS van geometrie. epsg:28992 mapt op het RD New Nederlands coordinatenstelsel.
      default: epsg:28992
      enum:
      - epsg:28992
    HalLink:
      required:
      - href
      type: object
      properties:
        href:
          $ref: '#/components/schemas/Href'
        templated:
          type: boolean
        title:
          type: string
          description: Voor mens leesbaar label bij de link
      description: De Link Object zoals gespecificeerd in https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5;
        Deze link kan als templated link worden aangeboden. [URI-templating is hier
        beschreven](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/uri-templating.feature).
    Href:
      type: string
      example: https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}
    HalPaginationLinksMetLast:
      description: |
        HalPaginationLinksMetLast bevat de link properties die nodig zijn om te kunnen navigeren in een eindige collectie:

        - first: uri voor het opvragen van de eerste pagina van deze collectie
        - previous: uri voor het opvragen van de vorige pagina van deze collectie
        - next: uri voor het opvragen van de volgende pagina van deze collectie
        - last: uri voor het opvragen van de laatste pagina van deze collectie
      example:
        self:
          href: /resourcenaam?page=4
        first:
          href: /resourcenaam?page=1
          title: Eerste pagina
        previous:
          href: /resourcenaam?page=3
          title: Vorige pagina
        next:
          href: /resourcenaam?page=5
          title: Volgende pagina
        last:
          href: /resourcenaam?page=8
          title: Laatste pagina
      allOf:
      - $ref: '#/components/schemas/HalPaginationLinks'
      - type: object
        properties:
          last:
            $ref: '#/components/schemas/HalLink'
    HalPaginationLinks:
      description: |
        HalPaginationLinks bevat de link properties die nodig zijn om te kunnen navigeren in een collectie:

        - first: uri voor het opvragen van de eerste pagina van deze collectie
        - previous: uri voor het opvragen van de vorige pagina van deze collectie
        - next: uri voor het opvragen van de volgende pagina van deze collectie
      example:
        self:
          href: /resourcenaam?page=4
        first:
          href: /resourcenaam?page=1
          title: Eerste pagina
        previous:
          href: /resourcenaam?page=3
          title: Vorige pagina
        next:
          href: /resourcenaam?page=5
          title: Volgende pagina
      allOf:
      - $ref: '#/components/schemas/HalCollectionLinks'
      - type: object
        properties:
          first:
            $ref: '#/components/schemas/HalLink'
          previous:
            $ref: '#/components/schemas/HalLink'
          next:
            $ref: '#/components/schemas/HalLink'
    HalCollectionLinks:
      type: object
      properties:
        self:
          $ref: '#/components/schemas/HalLink'
      description: |
        HalCollectionLinks bevat de self link die elke HAL Resource minimaal moet hebben in zijn _links property
    polygonGeoJSON:
      required:
      - coordinates
      - type
      type: object
      properties:
        type:
          type: string
          enum:
          - Polygon
        coordinates:
          type: array
          items:
            minItems: 4
            type: array
            items:
              minItems: 2
              type: array
              items:
                type: number
    pointGeoJSON:
      required:
      - coordinates
      - type
      type: object
      properties:
        type:
          type: string
          enum:
          - Point
        coordinates:
          minItems: 2
          type: array
          items:
            type: number
    multipolygonGeoJSON:
      required:
      - coordinates
      - type
      type: object
      properties:
        type:
          type: string
          enum:
          - MultiPolygon
        coordinates:
          type: array
          items:
            type: array
            items:
              minItems: 4
              type: array
              items:
                minItems: 2
                type: array
                items:
                  type: number
  parameters:
    zoek:
      name: zoek
      in: query
      description: Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter,
        huisnummertoevoeging.
      required: true
      style: form
      explode: true
      schema:
        type: string
    q:
      name: q
      in: query
      description: Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter,
        huisnummertoevoeging.
      required: false
      style: form
      explode: true
      schema:
        maxLength: 255
        minLength: 1
        type: string
    zoekresultaatIdentificatie:
      name: zoekresultaatIdentificatie
      in: query
      description: De identificatie van een zoekresultaat van het endpoint get /adressen/zoek.
      required: false
      deprecated: true
      style: form
      explode: true
      schema:
        type: string
    locatie-query:
      name: locatie
      in: query
      description: Coördinaten van een locatie die als query-parameter gebruikt wordt
        om een object te zoeken. Let op, explode is false dus het formaat is ?locatie=196733.51,439931.89
      required: false
      style: form
      explode: false
      schema:
        maxItems: 2
        minItems: 2
        type: array
        example:
        - 196733.51
        - 439931.89
        items:
          type: number
    nummeraanduidingIdentificatie-query:
      name: nummeraanduidingIdentificatie
      in: query
      description: Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers
        lang.
      required: false
      style: form
      explode: true
      schema:
        pattern: ^[0-9]{16}$
        type: string
        example: "0226200000038923"
    pandIdentificatie-query:
      name: pandIdentificatie
      in: query
      description: Identificatie van een pand uit de BAG. Deze is 16 cijfers lang.
      required: false
      style: form
      explode: true
      schema:
        pattern: ^[0-9]{16}$
        type: string
        example: "0226100000008856"
    deprecated-pandIdentificatie-query:
      name: pandIdentificatie
      in: query
      description: Identificatie van een pand uit de BAG. Deze is 16 cijfers lang.
      required: false
      deprecated: true
      style: form
      explode: true
      schema:
        pattern: ^[0-9]{16}$
        type: string
        example: "0226100000008856"
    adresseerbaarObjectIdentificatie-query:
      name: adresseerbaarObjectIdentificatie
      in: query
      description: De identificatie van een adresseerbaar object uit de BAG. Deze
        is 16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats
        zijn.
      required: false
      style: form
      explode: true
      schema:
        pattern: ^[0-9]{16}$
        type: string
        example: "0226010000038820"
    postcode:
      name: postcode
      in: query
      description: Postcode van het adres.
      required: false
      style: form
      explode: true
      schema:
        pattern: ^[1-9]{1}[0-9]{3}[ ]{0,1}[a-zA-Z]{2}$
        type: string
      examples:
        zonderSpatie:
          value: 6922KZ
        metSpatie:
          value: 6922 KZ
    huisnummer:
      name: huisnummer
      in: query
      description: Huisnummer van het adres.
      required: false
      style: form
      explode: true
      schema:
        maximum: 99999
        minimum: 1
        type: integer
        example: 1
    huisnummertoevoeging:
      name: huisnummertoevoeging
      in: query
      description: 'Een toevoeging (in de vorm van maximaal 4 cijfers of letters)
        aan een huisnummer of een combinatie van huisnummer en huisletter van het
        adres. Bijvoorbeeld: Bij het adres: Belgiëlaan 1 A2, 2391 PH  HAZERSWOUDE-DORP,
        is 1 het huisnummer, A de huisletter en 2 de huisnummertoevoeging.'
      required: false
      style: form
      explode: true
      schema:
        pattern: ^[0-9a-zA-Z]{1,4}$
        type: string
        example: bis
    huisletter:
      name: huisletter
      in: query
      description: 'Een toevoeging (in de vorm van een letter) aan een huisnummer
        van het adres. Bijvoorbeeld:  Bij adres: Belgiëlaan 1 A2, 2391 PH  HAZERSWOUDE-DORP,
        is 1 het huisnummer en A de huisletter.'
      required: false
      style: form
      explode: true
      schema:
        pattern: ^[a-zA-Z]{1}$
        type: string
        example: A
    exacteMatch:
      name: exacteMatch
      in: query
      description: Geeft aan of de resultaten van de zoekopdracht exact overeen moeten
        komen met de opgegeven parameters,  zie [functionele specificatie exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature).
      required: false
      style: form
      explode: true
      schema:
        type: boolean
        example: true
        default: false
    pandIdentificaties:
      name: pandIdentificaties
      in: query
      description: Een lijst met identificaties van panden uit de BAG.
      required: false
      style: form
      explode: false
      schema:
        minItems: 1
        type: array
        example:
        - "0226100000008856"
        items:
          pattern: ^[0-9]{16}$
          type: string
    geconstateerd:
      name: geconstateerd
      in: query
      description: Geeft aan of naar geconstateerde objecten moet worden gezocht.
      required: false
      style: form
      explode: true
      schema:
        type: boolean
    statusPand:
      name: statusPand
      in: query
      description: Status van het pand.
      required: false
      style: form
      explode: true
      schema:
        minItems: 1
        type: array
        items:
          $ref: '#/components/schemas/StatusPandEnum'
    bouwjaar:
      name: bouwjaar
      in: query
      description: 'Bouwjaar van het pand. Geeft het minimale en/of maximale bouwjaar
        aan van het pand waarnaar moet worden gezocht.  Een bouwjaar is een natuurlijk
        getal tussen 0 (minimaal) en 9999 (maximaal). Bv: bouwjaar[min]=1970&bouwjaar[max]=2010'
      required: false
      style: deepObject
      explode: true
      schema:
        $ref: '#/components/schemas/BouwjaarFilter'
    type:
      name: type
      in: query
      description: Geeft aan of het adresseerbaar object een ligplaats, standplaats
        of verblijfsobject is.
      required: false
      style: form
      explode: true
      schema:
        $ref: '#/components/schemas/TypeAdresseerbaarObjectEnum'
    gebruiksdoelen:
      name: gebruiksdoelen
      in: query
      description: De gebruiksdoelen van het verblijfsobject zoals in de vergunning
        is opgenomen of bij constatering is vastgesteld. Als een verblijfsobject één
        van de gebruiksdoelen in deze lijst heeft, dan wordt het verblijfsobject in
        het zoekresultaat meegenomen.
      required: false
      style: form
      explode: true
      schema:
        minItems: 1
        type: array
        items:
          $ref: '#/components/schemas/GebruiksdoelEnum'
    oppervlakte:
      name: oppervlakte
      in: query
      description: 'Geef de minimale en maximale oppervlakte op waarbinnen je wilt
        zoeken (in m2). Alleen verblijfsobjecten hebben een oppervlakte en kunnen
        met deze parameter worden gevonden. Ligplaatsen en standplaatsen hebben geen
        oppervlakte en kunnen met deze parameter niet worden gevonden. De oppervlakte
        van een verblijfsobject is een natuurlijk getal tussen 1 (minimaal) en 999999
        (maximaal). Het is niet toegestaan voor min een grotere waarde op te geven
        dan voor max. Is min > max dan treedt een foutmelding op. Bv: oppervlakte[min]=100&oppervlakte[max]=200'
      required: false
      style: deepObject
      explode: true
      schema:
        $ref: '#/components/schemas/OppervlakteFilter'
    bbox:
      name: bbox
      in: query
      description: Rechthoek waarbinnen het object dat je zoekt valt. Objecten die
        de rand van de rechthoek raken of kruisen worden in het zoekresultaat meegenomen.
        Voor een definitie van bbox, zie [OGC API Features specificatie - bbox definitie](https://docs.opengeospatial.org/is/17-069r3/17-069r3.html#ats_core_fc-bbox-definition).
        In tegenstelling tot wat er in de OGC API Features specificatie staat, wordt
        hier geen bbox-crs parameter maar de contentCrs parameter gebruikt om aan
        te geven in welk CRS de coördinaten van de bbox zijn. Daarnaast kan er alleen
        met 2D coördinaten worden gezocht. De oppervlakte van de bounding box mag
        maximaal 250 duizend vierkante meter zijn.
      required: false
      style: form
      explode: false
      schema:
        maxItems: 4
        minItems: 4
        type: array
        example:
        - 196733.51
        - 439931.89
        - 196833.51
        - 440031.89
        items:
          type: number
    nummeraanduidingidentificatie:
      name: nummeraanduidingidentificatie
      in: path
      description: Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers
        lang.
      required: true
      style: simple
      explode: false
      schema:
        pattern: ^[0-9]{16}$
        type: string
        example: "0226200000038923"
    adresseerbaarobjectidentificatie:
      name: adresseerbaarobjectidentificatie
      in: path
      description: De identificatie van een adresserbaar object uit de BAG. Deze is
        16 cijfers lang en kan een verblijfsobject, een standplaats of een ligplaats
        zijn.
      required: true
      style: simple
      explode: false
      schema:
        pattern: ^[0-9]{16}$
        type: string
        example: "0226010000038820"
    pandidentificatie:
      name: pandidentificatie
      in: path
      description: Identificatie van een pand uit de BAG. Deze is 16 cijfers lang.
      required: true
      style: simple
      explode: false
      schema:
        pattern: ^[0-9]{16}$
        type: string
        example: "0226100000008856"
    woonplaatsidentificatie:
      name: woonplaatsidentificatie
      in: path
      description: De identificatie van een woonplaats.
      required: true
      style: simple
      explode: false
      schema:
        pattern: ^[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}$
        type: string
        description: 'Deze wordt gebruikt in de operation, bv. /woonplaatsen/0123.
          Waarde: 0001-9999.'
        example: "2096"
    openbareruimteidentificatie:
      name: openbareruimteidentificatie
      in: path
      description: Identificatie van een object uit de BAG. Deze is 16 cijfers lang.
      required: true
      style: simple
      explode: false
      schema:
        pattern: ^[0-9]{16}$
        type: string
        example: "0226300000136166"
  headers:
    api_version:
      schema:
        type: string
        description: Geeft een specifieke API-versie aan in de context van een specifieke
          aanroep.
        example: 1.0.0
    warning:
      schema:
        type: string
        description: zie RFC 7234. In het geval een major versie wordt uitgefaseerd,
          gebruiken we warn-code 299 ("Miscellaneous Persistent Warning") en het API
          end-point (inclusief versienummer) als de warn-agent van de warning, gevolgd
          door de warn-text met de human-readable waarschuwing
        example: '299 https://service.../api/.../v1 "Deze versie van de API is verouderd
          en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie
          hier de documentatie: https://omgevingswet.../api/.../v1".'
    X_Pagination_Page:
      schema:
        type: integer
        description: Huidige pagina.
        example: 3
    X_Pagination_Limit:
      schema:
        type: integer
        description: Aantal resultaten per pagina.
        example: 20
    contentCrs:
      description: CRS van de meegegeven geometrie. epsg:28992 mapt op het RD New
        Nederlands coordinatenstelsel.
      schema:
        $ref: '#/components/schemas/CrsEnum'
  securitySchemes:
    apiKeyBAG:
      type: apiKey
      description: De API-key die je hebt gekregen dient bij elke request via de `X-Api-Key`
        request header meegestuurd te worden. Indien deze niet juist wordt meegestuurd,
        of het een ongeldige key betreft, zul je de foutmelding `403 Forbidden` terugkrijgen.
      name: X-Api-Key
      in: header