components:
  examples:
    SIMPLE_CRITERIA:
      value: |-
        {
          "registrationPeriod": {
            "beginDate": "2017-02-01",
            "endDate": "2021-02-01"
          },
          "area": {
            "enclosingCircle": {
              "center": {
                "lat": 52.038297852,
                "lon": 5.31447958948
              },
              "radius": 0.5
            }
          }
        }
  schemas:
    Area:
      properties:
        boundingBox:
          $ref: '#/components/schemas/Envelope'
        enclosingCircle:
          $ref: '#/components/schemas/Circle'
      type: object
    BhrpCriteriaSet:
      properties:
        analysisReportPeriod:
          $ref: '#/components/schemas/DatePeriod'
        analysisType:
          type: string
        area:
          $ref: '#/components/schemas/Area'
        boreholeSamplesAnalyzed:
          $ref: '#/components/schemas/YesNoEnumeration'
        boreholeSamplesDescribed:
          $ref: '#/components/schemas/YesNoEnumeration'
        boreholeSamplesPhotographed:
          $ref: '#/components/schemas/YesNoEnumeration'
        characteristicModelled:
          $ref: '#/components/schemas/YesNoEnumeration'
        correctionPeriod:
          $ref: '#/components/schemas/DatePeriod'
        deliveryAccountableParty:
          type: string
        depthInterval:
          $ref: '#/components/schemas/VerticalInterval'
        descriptionCompletionPeriod:
          $ref: '#/components/schemas/DatePeriod'
        discipline:
          type: string
        fieldworkPeriod:
          $ref: '#/components/schemas/DatePeriod'
        fractionDistributionDetermined:
          $ref: '#/components/schemas/YesNoEnumeration'
        qualityRegime:
          $ref: '#/components/schemas/QualityRegime'
        registrationPeriod:
          $ref: '#/components/schemas/DatePeriod'
        researchReportPeriod:
          $ref: '#/components/schemas/DatePeriod'
        toolUsed:
          type: string
        underReview:
          $ref: '#/components/schemas/YesNoEnumeration'
      required:
      - area
      type: object
    Circle:
      properties:
        center:
          $ref: '#/components/schemas/Point'
        radius:
          type: number
      type: object
    DatePeriod:
      properties:
        beginDate:
          type: string
        endDate:
          type: string
      type: object
    Envelope:
      properties:
        lowerCorner:
          $ref: '#/components/schemas/Point'
        upperCorner:
          $ref: '#/components/schemas/Point'
      type: object
    Point:
      properties:
        lat:
          type: number
        lon:
          type: number
      type: object
    QualityRegime:
      enum:
      - IMBRO
      - IMBRO_A
      type: string
    ServiceError:
      properties:
        description:
          type: string
        errorCode:
          format: int32
          type: integer
        title:
          type: string
      type: object
    VerticalInterval:
      properties:
        endDepth:
          type: number
        startDepth:
          type: number
      type: object
    YesNoEnumeration:
      enum:
      - JA
      - NEE
      type: string
info:
  contact:
    email: support@broservicedesk.nl
    name: BRO Servicedesk
    url: https://basisregistratieondergrond.nl/service-contact/
  description: Landelijke Voorziening Basisregistratie Ondergrond (BRO), uitgifte
    en validatie bodemkundig booronderzoek (BHR-P).
  title: Bodemkundig Booronderzoek (BHR-P)
  version: 2.195.3
openapi: 3.0.3
paths:
  /sr/bhrp/v2/bro-ids:
    get:
      description: Haalt de lijst van BHR-P bro-ids op waarvoor [bronhouder](https://basisregistratieondergrond.nl/service-contact/formulieren/aangemeld-bro/)
        verantwoordelijk is.
      operationId: bro-ids
      parameters:
      - description: Het kvk (kamer van koophandel) nummer van een BHR-P bronhouder
        example: "12345678"
        in: query
        name: bronhouder
        required: true
        schema:
          type: string
      - description: Registered is een optionele parameter, bij afwezigheid geeft
          deze methode alle BHR-P BRO-IDs terug onafhankelijk of die wel/niet uit
          registratie zijn genomen. <BR>registered = ja geeft alleen BRO-IDs terug
          die in registratie zijn genomen. <BR>registered = nee geeft alleen BRO-IDs
          terug die uit registratie zijn genomen.
        in: query
        name: registered
        schema:
          type: string
      responses:
        "200":
          content:
            application/json: {}
          description: De Lijst van BHR-P BRO-IDs voor dit registratie object type
            waarvoor bronhouder verantwoordelijk is.
          headers:
            API-Version:
              description: Versie van deze BHR-P API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Er bevinden zich andere fouten in het BHR-P lijstverzoek.
          headers:
            API-Version:
              description: Versie van deze BHR-P API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Lijst van BHR-P BRO-IDs
  /sr/bhrp/v2/characteristics/searches:
    post:
      description: De karakteristieken geven een samenvatting van een object zodat
        een verdere selectie gemaakt kan worden. Het past in een twee-traps-benadering,
        waarbij de eerste stap bestaat uit het ophalen van de karakteristieken en
        de 2e stap uit het ophalen van de gewenste registratie objecten. Het resultaat
        van deze operatie is gemaximaliseerd op 2000.Zie [hier](https://www.bro-productomgeving.nl/bpo/latest/bodem-en-grondonderzoek/booronderzoek-bhr/bodemkundig-booronderzoek-bhr-p/berichtencatalogus-uitgiftewebservice-bhr-p)
        voor meer info.
      operationId: characteristics
      parameters:
      - description: Een optionele BHR-P referentie van de gebruiker. "-" wordt aangenomen
          bij afwezigheid.
        example: Mijn-aanvraag-000001
        in: query
        name: requestReference
        schema:
          type: string
      requestBody:
        content:
          application/json:
            examples:
              Simple Criteria:
                $ref: '#/components/examples/SIMPLE_CRITERIA'
            schema:
              $ref: '#/components/schemas/BhrpCriteriaSet'
        description: 'De set van kenmerken. Zie voor meer informatie: https://www.bro-productomgeving.nl/bpo/latest/'
        required: true
      responses:
        "200":
          content:
            application/xml: {}
          description: De set van BHR-P karakteristieken die matched met de criteria
            dan wel een afwijzing.
          headers:
            API-Version:
              description: Versie van deze BHR-P API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Er bevinden zich andere fouten in het karakteristieken verzoek.
          headers:
            API-Version:
              description: Versie van deze BHR-P API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Haalt de karakteristieken op van een set van registratie objecten,
        gegeven een kenmerkenverzameling (kenset).
  /sr/bhrp/v2/objects/{broId}:
    get:
      description: Haal een bodemkundig booronderzoek op op basis van een BRO-ID.
        De operatie retourneert een object op basis van het BRO-ID als een 'O' (actuele
        situatie), of 'DO' (uit registratie) als IMBRO XML. De andere variant 'O-DP'
        is niet ondersteund omdat hier authenticatie / autorisatie voor nodig is (er
        worden bronhouder gevoelige gegevens terug gegeven). Gebruik hiervoor de 'DigiKoppeling'
        webservice.Zie [hier](https://www.bro-productomgeving.nl/bpo/latest/bodem-en-grondonderzoek/booronderzoek-bhr/bodemkundig-booronderzoek-bhr-p/berichtencatalogus-uitgiftewebservice-bhr-p)
        voor meer info.
      operationId: objects
      parameters:
      - content:
          text/plain:
            schema:
              type: string
        description: Het BRO-ID van het BHR-P object.
        in: path
        name: broId
        required: true
      - description: Een optionele BHR-P referentie van de gebruiker. "-" wordt aangenomen
          bij afwezigheid.
        example: Mijn-BHRP-object-aanvraag-000001
        in: query
        name: requestReference
        schema:
          type: string
      responses:
        "200":
          content:
            application/xml: {}
          description: Het aangevraagde registratie object dan wel een afwijzing van
            het BHR-P registratie object verzoek.
          headers:
            API-Version:
              description: Versie van deze BHR-P API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Er bevinden zich andere fouten in het BHR-P verzoek.
          headers:
            API-Version:
              description: Versie van deze BHR-P API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Haalt een bodemkundig booronderzoek ( pedological boreholeresearch
        survey, BHRP) op op basis van een BRO-ID
