openapi: 3.1.0
tags:
  - name: default
components:
  schemas:
    ServiceError:
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        errorCode:
          type: integer
          format: int32
paths:
  /gu/gpd/v1/bro-ids:
    get:
      summary: Lijst van GPD BRO-IDs
      description: Haalt de lijst van GPD 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 GPD bronhouder
          example: '12345678'
          name: bronhouder
          in: query
          schema:
            type: string
          required: true
        - description: Registered is een optionele parameter, bij afwezigheid geeft deze methode alle GPD 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.
          name: registered
          in: query
          schema:
            type: string
      responses:
        '200':
          description: De Lijst van GPD BRO-IDs voor dit registratie object type waarvoor bronhouder verantwoordelijk is.
          headers:
            API-Version:
              description: Versie van deze GPD API
              schema:
                type: string
                examples:
                  - 3.2.1
          content:
            application/json: {}
        '400':
          description: Er bevinden zich andere fouten in het GPD verzoek.
          headers:
            API-Version:
              description: Versie van deze GPD API
              schema:
                type: string
                examples:
                  - 3.2.1
          content:
            application/json:
              schema:
                type: object
                properties:
                  title:
                    type: string
                  description:
                    type: string
                  errorCode:
                    type: integer
                    format: int32
  /gu/gpd/v1/objects/{broId}:
    get:
      summary: Haalt een grondwaterproductiedossier (groundwater production dossier, GPD) op op basis van een BRO-ID
      description: Haal een grondwaterproductiedossier 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/grondwatergebruik/grondwaterproductiedossier-gpd/gpd-berichtencatalogus-uitgiftewebservice) voor meer info.
      operationId: objects
      parameters:
        - content:
            text/plain:
              schema:
                type: string
          description: Het BRO-ID van het GPD object.
          name: broId
          in: path
          required: true
        - description: Een optionele GPD referentie van de gebruiker. "-" wordt aangenomen bij afwezigheid.
          example: Mijn-GPD-object-aanvraag-000001
          name: requestReference
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Het aangevraagde registratie object dan wel een afwijzing van het GPD verzoek.
          headers:
            API-Version:
              description: Versie van deze GPD API
              schema:
                type: string
                examples:
                  - 3.2.1
          content:
            application/xml: {}
        '400':
          description: Er bevinden zich andere fouten in het GPD verzoek.
          headers:
            API-Version:
              description: Versie van deze GPD API
              schema:
                type: string
                examples:
                  - 3.2.1
          content:
            application/json:
              schema:
                type: object
                properties:
                  title:
                    type: string
                  description:
                    type: string
                  errorCode:
                    type: integer
                    format: int32
  /gu/gpd/v1/seriesAsCsv/{broId}:
    get:
      summary: Geeft een tabel met als eerste en tweede kolom datums (ISO 8601) en alle overige kolommen de daaraan gekoppelde meetwaarden van de verschilllende verplaatsingsrichtingen (onttrokken, ingebracht) en temperatuurIngebracht(warm, koud, onbekend). Bedoeld voor bijvoorbeeld het grafisch weergeven van volumes.
      operationId: seriesAsCSV
      tags:
        - default
      parameters:
        - content:
            text/plain:
              schema:
                type: string
                pattern: \S
          description: Het BRO-ID van het GPD object.
          name: broId
          in: path
          required: true
      responses:
        '200':
          description: Het aangevraagde registratie object dan wel een afwijzing van het GPD verzoek.
          headers:
            API-Version:
              description: Versie van deze GPD API
              schema:
                type: string
                examples:
                  - 3.2.1
          content:
            text/plain: {}
        '400':
          description: Er bevinden zich andere fouten in het GPD verzoek.
          headers:
            API-Version:
              description: Versie van deze GPD API
              schema:
                type: string
                examples:
                  - 3.2.1
          content:
            application/json:
              schema:
                type: object
                properties:
                  title:
                    type: string
                  description:
                    type: string
                  errorCode:
                    type: integer
                    format: int32
info:
  title: Grondwaterproductiedossier (GPD)
  version: 2.197.0
  description: Landelijke Voorziening Basisregistratie Ondergrond (BRO), uitgifte en validatie Grondwaterproductiedossier (GPD).
  contact:
    name: BRO Servicedesk
    email: support@broservicedesk.nl
    url: https://basisregistratieondergrond.nl/service-contact/
