---
openapi: 3.0.3
info:
  title: Grondwaterstandendossier (GLD)
  description: "Landelijke Voorziening Basisregistratie Ondergrond (BRO), uitgifte\
    \ en validatie grondwaterstandendossier (GLD)."
  contact:
    name: BRO Servicedesk
    url: https://basisregistratieondergrond.nl/service-contact/
    email: support@broservicedesk.nl
  version: 2.168.2
tags:
- name: default
paths:
  /gm/gld/v1/bro-ids:
    get:
      summary: Lijst van BRO-IDs
      description: "Haalt de lijst van GLD bro-ids op waarvoor [bronhouder](https://basisregistratieondergrond.nl/service-contact/formulieren/aangemeld-bro/)\
        \ verantwoordelijk is."
      operationId: bro-ids
      parameters:
      - name: bronhouder
        in: query
        description: Het kvk (kamer van koophandel) nummer van een bronhouder
        required: true
        schema:
          type: string
        example: 12345678
      - name: registered
        in: query
        description: "Registered is een optionele parameter, bij afwezigheid geeft\
          \ deze methode alle 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."
        schema:
          type: string
      responses:
        "200":
          description: De lijst van bro-ids voor dit registratie object type waarvoor
            bronhouder verantwoordelijk is.
          content:
            application/json: {}
        "400":
          description: Er bevinden zich andere fouten in het verzoek.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
  /gm/gld/v1/objects/{broId}:
    get:
      tags:
      - default
      summary: "Haalt een grondwaterstandendossier ( groundwater level dossier, GLD)\
        \ op op basis van een BRO-ID"
      description: "Haal een grondwaterstandendossier 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.Het aantal resultaten (tijd-meetwaarde-paren)\
        \ is beperkt tot 2000 bij weglaten van een periode. Zie ook [hier](https://bro-productomgeving.nl/bpo/latest/grondwatermonitoring/grondwaterstandonderzoek-gld/gld-berichtencatalogus-uitgiftewebservice)"
      operationId: objects
      parameters:
      - name: broId
        in: path
        description: Het BRO-ID van het object.
        required: true
        content:
          text/plain:
            schema:
              type: string
      - name: requestReference
        in: query
        description: Een optionele referentie van de gebruiker. "-" wordt aangenomen
          bij afwezigheid.
        schema:
          type: string
        example: Mijn-object-aanvraag-000001
      - name: observationPeriodBeginDate
        in: query
        description: Begindatum van het datuminterval waarbinnen de observatieperiode
          van een observatie geheel of gedeeltelijk ligt.
        schema:
          type: string
        example: 2017-01-01
      - name: observationPeriodEndDate
        in: query
        description: Einddatum van het datuminterval waarbinnen de observatieperiode
          van een observatie geheel of gedeeltelijk ligt.
        schema:
          type: string
        example: 2021-01-01
      - name: filtered
        in: query
        description: Aanduiding of de te leveren gegevens gefilterd moeten worden
          volgens de juridische gebruiksplicht of niet.
        schema:
          type: string
        example: JA
      responses:
        "200":
          description: Het aangevraagde registratie object dan wel een afwijzing van
            het verzoek.
          content:
            application/xml: {}
        "400":
          description: Er bevinden zich andere fouten in het verzoek.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
  /gm/gld/v1/objects/{broId}/observations/{observationId}:
    get:
      tags:
      - default
      summary: "Haalt een grondwaterstandendossier ( groundwater level dossier, GLD)\
        \ met 1 observatie op op basis van een BRO-ID en een OBSERVATIE-ID"
      description: "Haal een grondwaterstandendossier met 1 observatie op op basis\
        \ van een BRO-ID en OBSERVATIE-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.Gebruik een geldige\
        \ startTVPTime en endTVPTime OF een mostRecentTVP=JA Zie ook [hier](https://bro-productomgeving.nl/bpo/latest/grondwatermonitoring/grondwaterstandonderzoek-gld/gld-berichtencatalogus-uitgiftewebservice)"
      operationId: objects
      parameters:
      - name: broId
        in: path
        description: Het BRO-ID van het object.
        required: true
        content:
          text/plain:
            schema:
              type: string
      - name: observationId
        in: path
        description: Het OBSERVATIE-ID van de observatie binnen het object.
        required: true
        content:
          text/plain:
            schema:
              type: string
      - name: startTVPTime
        in: query
        description: Begindatum van het datuminterval waarbinnen de tijdmeetwaarde
          paren van de observatie moeten liggen.
        schema:
          type: string
        example: 2017-01-01T00:00:00
      - name: endTVPTime
        in: query
        description: Einddatum van het datuminterval waarbinnen de tijdmeetwaarde
          paren van de observatie moeten liggen.
        schema:
          type: string
        example: 2018-01-01T00:00:00
      - name: mostRecentTVP
        in: query
        description: Aanduiding of alleen het meest recente tijdmeetwaarde paar binnen
          de observatie teruggeven dient te worden of niet.
        schema:
          type: string
        example: JA
      responses:
        "200":
          description: Het aangevraagde registratie object dan wel een afwijzing van
            het verzoek.
          content:
            application/xml: {}
        "400":
          description: Er bevinden zich fouten in het verzoek.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
  /gm/gld/v1/objects/{broId}/observationsSummary:
    get:
      tags:
      - default
      summary: Operatie die een samenvatting van een GLD ophaalt in JSON op basis
        van een BRO-ID
      description: "Operatie die een samenvatting van een GLD ophaalt in JSON op basis\
        \ van een BRO-ID Zie ook [hier](https://bro-productomgeving.nl/bpo/latest/grondwatermonitoring/grondwaterstandonderzoek-gld/gld-berichtencatalogus-uitgiftewebservice)"
      operationId: observationsSummary
      parameters:
      - name: broId
        in: path
        description: Het BRO-ID van het object.
        required: true
        content:
          text/plain:
            schema:
              type: string
      responses:
        "200":
          description: Het aangevraagde registratie object dan wel een afwijzing van
            het verzoek.
          content:
            application/json: {}
        "400":
          description: Er bevinden zich fouten in het verzoek.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
  /gm/gld/v1/objectsAsCsv/{broId}:
    get:
      tags:
      - default
      summary: "Haalt een grondwaterstandendossier ( groundwater level dossier, GLD)\
        \ op op basis van een BRO-ID als CSV"
      description: Haal een volledig grondwaterstandendossier op op basis van een
        BRO-ID als CSV (RFC 4180) bestand. Er kan op rapportage type enobservatie
        type worden gefilterd.
      operationId: objectsAsCsv
      parameters:
      - name: broId
        in: path
        description: Het BRO-ID van het object.
        required: true
        content:
          text/plain:
            schema:
              type: string
      - name: rapportagetype
        in: query
        description: "type rapportage; \n+ volledig: Zo volledig mogelijk, \n+ compact:\
          \ Compact met leesbare tijdstippen, \n+ compact_met_timestamps: Compact\
          \ met unix epoch tijdstippen. Afwezigheid van deze parameter geeft een volledige\
          \ rapportage."
        schema:
          type: string
        example: volledig
      - name: observatietype
        in: query
        description: "type observatie; \n+ regulier_beoordeeld: observatietype = reguliere\
          \ meting en mate beoordeling = volledig beoordeeld, \n+ regulier_voorlopig:\
          \ observatietype = reguliere meting en mate beoordeling = voorlopig, \n\
          + controle: observatietype = controle meting, \n+ onbekend: observatietype\
          \ = reguliere meting en mate beoordeling = onbekend. \nAfwezigheid van deze\
          \ parameter geeft alle resultaten gescheiden door lege regels en een regel\
          \ met duiding."
        schema:
          type: string
        example: regulier_beoordeeld
      responses:
        "200":
          description: Het aangevraagde registratie object dan wel een afwijzing van
            het verzoek.
          content:
            text/plain: {}
        "400":
          description: Er bevinden zich andere fouten in het verzoek.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
  /gm/gld/v1/seriesAsCsv/{broId}:
    get:
      tags:
      - default
      summary: "Geeft een tabel met als eerste kolom doorlopende tijdstippen (unix\
        \ epoch) en als kolommen de daaraan gekoppeld de meetwaarden en opmerkingen\
        \ van de verschilllende observatie typen (regulier_voorlopig, regulier_beoordeeld,\
        \ controle en onbekend). Bedoeld voor bijvoorbeeld het grafisch weergeven\
        \ van standen."
      operationId: seriesAsCSV
      parameters:
      - name: broId
        in: path
        description: Het BRO-ID van het object.
        required: true
        content:
          text/plain:
            schema:
              type: string
      - name: filterOnStatusQualityControl
        in: query
        description: Een string bestaande uit een of meerdere quality control statussen
          gesepareerd door een komma.
        schema:
          type: string
        allowEmptyValue: true
      - name: asISO8601
        in: query
        description: Als aanwezig dan worden de tijdstippen in ISO8601 formaat weergegeven.
          Anders in de Unix Epoch.
        schema:
          type: string
        allowEmptyValue: true
      responses:
        "200":
          description: Het aangevraagde registratie object dan wel een afwijzing van
            het verzoek.
          content:
            text/plain: {}
        "400":
          description: Er bevinden zich andere fouten in het verzoek.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
components:
  schemas:
    ServiceError:
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        errorCode:
          format: int32
          type: integer
