components:
  examples:
    BOUNDING_BOX_CRITERIA:
      value: |-
        {
          "area":{
            "boundingBox":{
              "lowerCorner":{
                "lat": 50.123585000,
                "lon": 1.983454000
              },
              "upperCorner":{
                "lat": 58.165521000,
                "lon": 10.028123000
              }
            }
          }
        }
    ENCLOSING_CIRCLE_CRITERIA:
      value: |-
        {
          "area": {
            "enclosingCircle": {
              "center": {
                "lat": 52.038297852,
                "lon": 5.31447958948
              },
              "radius": 10
            }
          }
        }
  schemas:
    Area:
      properties:
        boundingBox:
          properties:
            lowerCorner:
              properties:
                lat:
                  type: number
                lon:
                  type: number
              type: object
            upperCorner:
              properties:
                lat:
                  type: number
                lon:
                  type: number
              type: object
          type: object
        enclosingCircle:
          properties:
            center:
              properties:
                lat:
                  type: number
                lon:
                  type: number
              type: object
            radius:
              type: number
          type: object
      type: object
    Circle:
      properties:
        center:
          properties:
            lat:
              type: number
            lon:
              type: number
          type: object
        radius:
          type: number
      type: object
    DatePeriod:
      properties:
        beginDate:
          type: string
        endDate:
          type: string
      type: object
    Envelope:
      properties:
        lowerCorner:
          properties:
            lat:
              type: number
            lon:
              type: number
          type: object
        upperCorner:
          properties:
            lat:
              type: number
            lon:
              type: number
          type: object
      type: object
    Point:
      properties:
        lat:
          type: number
        lon:
          type: number
      type: object
    QualityRegime:
      enum:
      - IMBRO
      - IMBRO_A
      type: string
    SadCriteriaSet:
      properties:
        area:
          properties:
            boundingBox:
              properties:
                lowerCorner:
                  properties:
                    lat:
                      type: number
                    lon:
                      type: number
                  type: object
                upperCorner:
                  properties:
                    lat:
                      type: number
                    lon:
                      type: number
                  type: object
              type: object
            enclosingCircle:
              properties:
                center:
                  properties:
                    lat:
                      type: number
                    lon:
                      type: number
                  type: object
                radius:
                  type: number
              type: object
          type: object
        correctionPeriod:
          properties:
            beginDate:
              type: string
            endDate:
              type: string
          type: object
        deliveryAccountableParty:
          type: string
        identification:
          type: string
        qualityRegime:
          enum:
          - IMBRO
          - IMBRO_A
          type: string
        registrationPeriod:
          properties:
            beginDate:
              type: string
            endDate:
              type: string
          type: object
        reportNumber:
          type: string
        reportPeriod:
          properties:
            beginDate:
              type: string
            endDate:
              type: string
          type: object
        underReview:
          enum:
          - JA
          - NEE
          type: string
      required:
      - area
      type: object
    ServiceError:
      properties:
        description:
          type: string
        errorCode:
          format: int32
          type: integer
        title:
          type: string
      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), Milieuhygiënisch
    bodemonderzoek (SAD).
  title: Milieuhygiënisch bodemonderzoek (SAD)
  version: 2.197.1
openapi: 3.0.3
paths:
  /sq/sad/v1/bro-id/{soilResearchIdentification}:
    get:
      description: Haalt een SAD bro-id op basis van een bodemonderzoek SIKB0101-identificatie
        waarvoor [bronhouder](https://basisregistratieondergrond.nl/service-contact/formulieren/aangemeld-bro/)
        verantwoordelijk is.
      operationId: bro-id
      parameters:
      - description: Het bodemonderzoek SIKB0101-identificatie van een SIKB bronhouder
        example: d8401c1a-ec0c-446f-8e45-22d9514f8400
        in: path
        name: soilResearchIdentification
        required: true
        schema:
          pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}'
          type: string
      responses:
        "200":
          content:
            application/json: {}
          description: De bro-id voor dit registratie object type waarvoor bronhouder
            verantwoordelijk is.
          headers:
            API-Version:
              description: Versie van deze SAD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
        "400":
          content:
            application/json:
              schema:
                properties:
                  description:
                    type: string
                  errorCode:
                    format: int32
                    type: integer
                  title:
                    type: string
                type: object
          description: Er bevinden zich andere fouten in het SAD verzoek.
          headers:
            API-Version:
              description: Versie van deze SAD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Een Bro-id
  /sq/sad/v1/bro-ids:
    get:
      description: Haalt de lijst van SAD 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 SAD bronhouder
        example: "12345678"
        in: query
        name: bronhouder
        required: true
        schema:
          type: string
      - description: Registered is een optionele parameter, bij afwezigheid geeft
          deze methode alle SAD 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 SAD BRO-IDs voor dit registratie object type waarvoor
            bronhouder verantwoordelijk is.
          headers:
            API-Version:
              description: Versie van deze SAD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
        "400":
          content:
            application/json:
              schema:
                properties:
                  description:
                    type: string
                  errorCode:
                    format: int32
                    type: integer
                  title:
                    type: string
                type: object
          description: Er bevinden zich andere fouten in het SAD verzoek.
          headers:
            API-Version:
              description: Versie van deze SAD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Lijst van SAD BRO-IDs
  /sq/sad/v1/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/milieuhygienisch-bodemonderzoek-sad)
        voor meer info.
      operationId: characteristics
      parameters:
      - description: Een optionele SAD referentie van de gebruiker. "-" wordt aangenomen
          bij afwezigheid.
        example: Mijn-aanvraag-000001
        in: query
        name: requestReference
        schema:
          type: string
      requestBody:
        content:
          application/json:
            examples:
              Bounding Box Criteria:
                value: |-
                  {
                    "area":{
                      "boundingBox":{
                        "lowerCorner":{
                          "lat": 50.123585000,
                          "lon": 1.983454000
                        },
                        "upperCorner":{
                          "lat": 58.165521000,
                          "lon": 10.028123000
                        }
                      }
                    }
                  }
              Enclosing Circle Criteria:
                value: |-
                  {
                    "area": {
                      "enclosingCircle": {
                        "center": {
                          "lat": 52.038297852,
                          "lon": 5.31447958948
                        },
                        "radius": 10
                      }
                    }
                  }
            schema:
              properties:
                area:
                  properties:
                    boundingBox:
                      properties:
                        lowerCorner:
                          properties:
                            lat:
                              type: number
                            lon:
                              type: number
                          type: object
                        upperCorner:
                          properties:
                            lat:
                              type: number
                            lon:
                              type: number
                          type: object
                      type: object
                    enclosingCircle:
                      properties:
                        center:
                          properties:
                            lat:
                              type: number
                            lon:
                              type: number
                          type: object
                        radius:
                          type: number
                      type: object
                  type: object
                correctionPeriod:
                  properties:
                    beginDate:
                      type: string
                    endDate:
                      type: string
                  type: object
                deliveryAccountableParty:
                  type: string
                identification:
                  type: string
                qualityRegime:
                  enum:
                  - IMBRO
                  - IMBRO_A
                  type: string
                registrationPeriod:
                  properties:
                    beginDate:
                      type: string
                    endDate:
                      type: string
                  type: object
                reportNumber:
                  type: string
                reportPeriod:
                  properties:
                    beginDate:
                      type: string
                    endDate:
                      type: string
                  type: object
                underReview:
                  enum:
                  - JA
                  - NEE
                  type: string
              required:
              - area
              type: object
        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 SAD karakteristieken die matched met de criteria
            dan wel een afwijzing.
          headers:
            API-Version:
              description: Versie van deze SAD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
        "400":
          content:
            application/json:
              schema:
                properties:
                  description:
                    type: string
                  errorCode:
                    format: int32
                    type: integer
                  title:
                    type: string
                type: object
          description: Er bevinden zich andere fouten in het SAD verzoek.
          headers:
            API-Version:
              description: Versie van deze SAD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Haalt de karakteristieken op van een set van registratie objecten,
        gegeven een kenmerkenverzameling (kenset).
  /sq/sad/v1/objects/{broId}:
    get:
      description: Haal een milieuhygiënisch bodemonderzoek 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/milieuhygienisch-bodemonderzoek-sad)
        voor meer info.
      operationId: objects
      parameters:
      - content:
          text/plain:
            schema:
              type: string
        description: Het BRO-ID van het SAD object.
        in: path
        name: broId
        required: true
      - description: Een optionele SAD referentie van de gebruiker. "-" wordt aangenomen
          bij afwezigheid.
        example: Mijn-SAD-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 SAD verzoek.
          headers:
            API-Version:
              description: Versie van deze SAD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
        "400":
          content:
            application/json:
              schema:
                properties:
                  description:
                    type: string
                  errorCode:
                    format: int32
                    type: integer
                  title:
                    type: string
                type: object
          description: Er bevinden zich andere fouten in het SAD verzoek.
          headers:
            API-Version:
              description: Versie van deze SAD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Haalt een milieuhygiënisch bodemonderzoek (site assessment data, SAD)
        op op basis van een BRO-ID
