components:
  examples:
    SIMPLE_CRITERIA:
      value: |-
        {
          "registrationPeriod": {
            "beginDate": "2017-04-01",
            "endDate": "2021-04-01"
          },
          "area": {
            "enclosingCircle": {
              "center": {
                "lat": 52.038297852,
                "lon": 5.31447958948
              },
              "radius": 0.5
            }
          }
        }
  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
    CptCriteriaSet:
      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
        cptStandard:
          type: string
        deliveryAccountableParty:
          type: string
        depthInterval:
          properties:
            beginDepth:
              type: number
            endDepth:
              type: number
          type: object
        dissipationTestPerformed:
          enum:
          - JA
          - NEE
          type: string
        fieldworkPeriod:
          properties:
            beginDate:
              type: string
            endDate:
              type: string
          type: object
        parameters:
          properties:
            correctedConeResistance:
              enum:
              - JA
              - NEE
              type: string
            depth:
              enum:
              - JA
              - NEE
              type: string
            elapsedTime:
              enum:
              - JA
              - NEE
              type: string
            electricalConductivity:
              enum:
              - JA
              - NEE
              type: string
            frictionRatio:
              enum:
              - JA
              - NEE
              type: string
            inclinationEW:
              enum:
              - JA
              - NEE
              type: string
            inclinationNS:
              enum:
              - JA
              - NEE
              type: string
            inclinationResultant:
              enum:
              - JA
              - NEE
              type: string
            inclinationX:
              enum:
              - JA
              - NEE
              type: string
            inclinationY:
              enum:
              - JA
              - NEE
              type: string
            localFriction:
              enum:
              - JA
              - NEE
              type: string
            magneticDeclination:
              enum:
              - JA
              - NEE
              type: string
            magneticFieldStrengthTotal:
              enum:
              - JA
              - NEE
              type: string
            magneticFieldStrengthX:
              enum:
              - JA
              - NEE
              type: string
            magneticFieldStrengthY:
              enum:
              - JA
              - NEE
              type: string
            magneticFieldStrengthZ:
              enum:
              - JA
              - NEE
              type: string
            magneticInclination:
              enum:
              - JA
              - NEE
              type: string
            netConeResistance:
              enum:
              - JA
              - NEE
              type: string
            porePressureU1:
              enum:
              - JA
              - NEE
              type: string
            porePressureU2:
              enum:
              - JA
              - NEE
              type: string
            porePressureU3:
              enum:
              - JA
              - NEE
              type: string
            poreRatio:
              enum:
              - JA
              - NEE
              type: string
            temperature:
              enum:
              - JA
              - NEE
              type: string
          type: object
        qualityClass:
          items:
            type: string
          type: array
        qualityRegime:
          enum:
          - IMBRO
          - IMBRO_A
          type: string
        registrationPeriod:
          properties:
            beginDate:
              type: string
            endDate:
              type: string
          type: object
        researchReportPeriod:
          properties:
            beginDate:
              type: string
            endDate:
              type: string
          type: object
        stopCriterion:
          type: string
        underReview:
          enum:
          - JA
          - NEE
          type: string
      required:
      - area
      type: object
    DatePeriod:
      properties:
        beginDate:
          type: string
        endDate:
          type: string
      type: object
    DepthInterval:
      properties:
        beginDepth:
          type: number
        endDepth:
          type: number
      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
    Parameters:
      properties:
        correctedConeResistance:
          enum:
          - JA
          - NEE
          type: string
        depth:
          enum:
          - JA
          - NEE
          type: string
        elapsedTime:
          enum:
          - JA
          - NEE
          type: string
        electricalConductivity:
          enum:
          - JA
          - NEE
          type: string
        frictionRatio:
          enum:
          - JA
          - NEE
          type: string
        inclinationEW:
          enum:
          - JA
          - NEE
          type: string
        inclinationNS:
          enum:
          - JA
          - NEE
          type: string
        inclinationResultant:
          enum:
          - JA
          - NEE
          type: string
        inclinationX:
          enum:
          - JA
          - NEE
          type: string
        inclinationY:
          enum:
          - JA
          - NEE
          type: string
        localFriction:
          enum:
          - JA
          - NEE
          type: string
        magneticDeclination:
          enum:
          - JA
          - NEE
          type: string
        magneticFieldStrengthTotal:
          enum:
          - JA
          - NEE
          type: string
        magneticFieldStrengthX:
          enum:
          - JA
          - NEE
          type: string
        magneticFieldStrengthY:
          enum:
          - JA
          - NEE
          type: string
        magneticFieldStrengthZ:
          enum:
          - JA
          - NEE
          type: string
        magneticInclination:
          enum:
          - JA
          - NEE
          type: string
        netConeResistance:
          enum:
          - JA
          - NEE
          type: string
        porePressureU1:
          enum:
          - JA
          - NEE
          type: string
        porePressureU2:
          enum:
          - JA
          - NEE
          type: string
        porePressureU3:
          enum:
          - JA
          - NEE
          type: string
        poreRatio:
          enum:
          - JA
          - NEE
          type: string
        temperature:
          enum:
          - JA
          - NEE
          type: string
      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
    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 Geotechnisch sondeeronderzoek (CPT).
  title: Geotechnisch sondeeronderzoek (CPT)
  version: 1.197.2
openapi: 3.0.3
paths:
  /sr/cpt/v1/bro-ids:
    get:
      description: Haalt de lijst van CPT 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 CPT bronhouder
        example: "12345678"
        in: query
        name: bronhouder
        required: true
        schema:
          type: string
      - description: Registered is een optionele parameter, bij afwezigheid geeft
          deze methode alle CPT 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 CPT BRO-IDs voor dit registratie object type waarvoor
            bronhouder verantwoordelijk is.
          headers:
            API-Version:
              description: Versie van deze CPT 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 CPT verzoek.
          headers:
            API-Version:
              description: Versie van deze CPT API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Lijst van CPT BRO-IDs
  /sr/cpt/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/bodem-en-grondonderzoek/geotechnisch-sondeeronderzoek-cpt/koppelvlakbeschrijving-uitgifteservice-cpt)
        en [hier](https://www.bro-productomgeving.nl/bpo/latest/bodem-en-grondonderzoek/geotechnisch-sondeeronderzoek-cpt/uitgiftehandboek-cpt)
        voor meer info.
      operationId: characteristics
      parameters:
      - description: Een optionele CPT 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:
                value: |-
                  {
                    "registrationPeriod": {
                      "beginDate": "2017-04-01",
                      "endDate": "2021-04-01"
                    },
                    "area": {
                      "enclosingCircle": {
                        "center": {
                          "lat": 52.038297852,
                          "lon": 5.31447958948
                        },
                        "radius": 0.5
                      }
                    }
                  }
            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
                cptStandard:
                  type: string
                deliveryAccountableParty:
                  type: string
                depthInterval:
                  properties:
                    beginDepth:
                      type: number
                    endDepth:
                      type: number
                  type: object
                dissipationTestPerformed:
                  enum:
                  - JA
                  - NEE
                  type: string
                fieldworkPeriod:
                  properties:
                    beginDate:
                      type: string
                    endDate:
                      type: string
                  type: object
                parameters:
                  properties:
                    correctedConeResistance:
                      enum:
                      - JA
                      - NEE
                      type: string
                    depth:
                      enum:
                      - JA
                      - NEE
                      type: string
                    elapsedTime:
                      enum:
                      - JA
                      - NEE
                      type: string
                    electricalConductivity:
                      enum:
                      - JA
                      - NEE
                      type: string
                    frictionRatio:
                      enum:
                      - JA
                      - NEE
                      type: string
                    inclinationEW:
                      enum:
                      - JA
                      - NEE
                      type: string
                    inclinationNS:
                      enum:
                      - JA
                      - NEE
                      type: string
                    inclinationResultant:
                      enum:
                      - JA
                      - NEE
                      type: string
                    inclinationX:
                      enum:
                      - JA
                      - NEE
                      type: string
                    inclinationY:
                      enum:
                      - JA
                      - NEE
                      type: string
                    localFriction:
                      enum:
                      - JA
                      - NEE
                      type: string
                    magneticDeclination:
                      enum:
                      - JA
                      - NEE
                      type: string
                    magneticFieldStrengthTotal:
                      enum:
                      - JA
                      - NEE
                      type: string
                    magneticFieldStrengthX:
                      enum:
                      - JA
                      - NEE
                      type: string
                    magneticFieldStrengthY:
                      enum:
                      - JA
                      - NEE
                      type: string
                    magneticFieldStrengthZ:
                      enum:
                      - JA
                      - NEE
                      type: string
                    magneticInclination:
                      enum:
                      - JA
                      - NEE
                      type: string
                    netConeResistance:
                      enum:
                      - JA
                      - NEE
                      type: string
                    porePressureU1:
                      enum:
                      - JA
                      - NEE
                      type: string
                    porePressureU2:
                      enum:
                      - JA
                      - NEE
                      type: string
                    porePressureU3:
                      enum:
                      - JA
                      - NEE
                      type: string
                    poreRatio:
                      enum:
                      - JA
                      - NEE
                      type: string
                    temperature:
                      enum:
                      - JA
                      - NEE
                      type: string
                  type: object
                qualityClass:
                  items:
                    type: string
                  type: array
                qualityRegime:
                  enum:
                  - IMBRO
                  - IMBRO_A
                  type: string
                registrationPeriod:
                  properties:
                    beginDate:
                      type: string
                    endDate:
                      type: string
                  type: object
                researchReportPeriod:
                  properties:
                    beginDate:
                      type: string
                    endDate:
                      type: string
                  type: object
                stopCriterion:
                  type: string
                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 CPT karakteristieken die matched met de criteria
            dan wel een afwijzing.
          headers:
            API-Version:
              description: Versie van deze CPT 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 CPT verzoek.
          headers:
            API-Version:
              description: Versie van deze CPT 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/cpt/v1/objects/{broId}:
    get:
      description: Haal een sondeeronderzoek 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/geotechnisch-sondeeronderzoek-cpt/koppelvlakbeschrijving-uitgifteservice-cpt)
        en [hier](https://www.bro-productomgeving.nl/bpo/latest/bodem-en-grondonderzoek/geotechnisch-sondeeronderzoek-cpt/uitgiftehandboek-cpt)
        voor meer info.
      operationId: objects
      parameters:
      - content:
          text/plain:
            schema:
              type: string
        description: Het BRO-ID van het CPT object.
        in: path
        name: broId
        required: true
      - description: Een optionele CPT referentie van de gebruiker. "-" wordt aangenomen
          bij afwezigheid.
        example: Mijn-CPT-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 CPT verzoek.
          headers:
            API-Version:
              description: Versie van deze CPT 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 CPT verzoek.
          headers:
            API-Version:
              description: Versie van deze CPT API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Haalt een geotechnisch sondeeronderzoek (geotechnical survey, CPT)
        op op basis van een BRO-ID
