components:
  schemas:
    ServiceError:
      properties:
        description:
          type: string
        errorCode:
          format: int32
          type: integer
        title:
          type: string
      type: object
info:
  contact:
    email: support@broservicedesk.nl
    name: BRO Servicedesk
    url: https://basisregistratieondergrond.nl/service-contact/
  description: Landelijke Voorziening Basisregistratie Ondergrond (BRO), uitgifte
    en validatie grondwaterstandendossier (GLD).
  title: Grondwaterstandendossier (GLD)
  version: 2.197.0
openapi: 3.0.3
paths:
  /gm/gld/v1/bro-ids:
    get:
      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:
      - description: Het kvk (kamer van koophandel) nummer van een GLD bronhouder
        example: "12345678"
        in: query
        name: bronhouder
        required: true
        schema:
          type: string
      - description: Registered is een optionele parameter, bij afwezigheid geeft
          deze methode alle GLD 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 GLD BRO-IDs voor dit registratie object type waarvoor
            bronhouder verantwoordelijk is.
          headers:
            API-Version:
              description: Versie van deze GLD 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 GLD verzoek.
          headers:
            API-Version:
              description: Versie van deze GLD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Lijst van GLD BRO-IDs
  /gm/gld/v1/objects/{broId}:
    get:
      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://www.bro-productomgeving.nl/bpo/latest/grondwatermonitoring/grondwaterstandonderzoek-gld/gld-berichtencatalogus-uitgiftewebservice)
      operationId: objects
      parameters:
      - content:
          text/plain:
            schema:
              pattern: \S
              type: string
        description: Het BRO-ID van het GLD object.
        in: path
        name: broId
        required: true
      - description: Een optionele GLD referentie van de gebruiker. "-" wordt aangenomen
          bij afwezigheid.
        example: Mijn-GLD-object-aanvraag-000001
        in: query
        name: requestReference
        schema:
          type: string
      - description: Begindatum van het datuminterval waarbinnen de observatieperiode
          van een observatie geheel of gedeeltelijk ligt.
        example: "2018-01-01"
        in: query
        name: observationPeriodBeginDate
        schema:
          type: string
      - description: Einddatum van het datuminterval waarbinnen de observatieperiode
          van een observatie geheel of gedeeltelijk ligt.
        example: "2022-01-01"
        in: query
        name: observationPeriodEndDate
        schema:
          type: string
      - description: Aanduiding of de te leveren gegevens gefilterd moeten worden
          volgens de juridische gebruiksplicht of niet.
        example: JA
        in: query
        name: filtered
        schema:
          type: string
      responses:
        "200":
          content:
            application/xml: {}
          description: Het aangevraagde registratie object dan wel een afwijzing van
            het GLD verzoek.
          headers:
            API-Version:
              description: Versie van deze GLD 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 GLD verzoek.
          headers:
            API-Version:
              description: Versie van deze GLD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Haalt een grondwaterstandendossier (groundwater level dossier, GLD)
        op op basis van een BRO-ID
      tags:
      - default
  /gm/gld/v1/objects/{broId}/observations/{observationId}:
    get:
      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://www.bro-productomgeving.nl/bpo/latest/grondwatermonitoring/grondwaterstandonderzoek-gld/gld-berichtencatalogus-uitgiftewebservice)
      operationId: observation
      parameters:
      - content:
          text/plain:
            schema:
              pattern: \S
              type: string
        description: Het BRO-ID van het GLD object.
        in: path
        name: broId
        required: true
      - content:
          text/plain:
            schema:
              pattern: \S
              type: string
        description: Het OBSERVATIE-ID van de observatie binnen het object.
        in: path
        name: observationId
        required: true
      - description: Begindatum van het datuminterval waarbinnen de tijdmeetwaarde
          paren van de observatie moeten liggen.
        example: 2017-01-01T00:00:00
        in: query
        name: startTVPTime
        schema:
          type: string
      - description: Einddatum van het datuminterval waarbinnen de tijdmeetwaarde
          paren van de observatie moeten liggen.
        example: 2018-01-01T00:00:00
        in: query
        name: endTVPTime
        schema:
          type: string
      - description: Aanduiding of alleen het meest recente tijdmeetwaarde paar binnen
          de observatie teruggeven dient te worden of niet.
        example: JA
        in: query
        name: mostRecentTVP
        schema:
          type: string
      responses:
        "200":
          content:
            application/xml: {}
          description: Het aangevraagde registratie object dan wel een afwijzing van
            het GLD verzoek.
        "400":
          content:
            application/json:
              schema:
                properties:
                  description:
                    type: string
                  errorCode:
                    format: int32
                    type: integer
                  title:
                    type: string
                type: object
          description: Er bevinden zich fouten in het verzoek.
          headers:
            API-Version:
              description: Versie van deze GLD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Haalt een grondwaterstandendossier (groundwater level dossier, GLD)
        met 1 observatie op op basis van een BRO-ID en een OBSERVATIE-ID
      tags:
      - default
  /gm/gld/v1/objects/{broId}/observationsSummary:
    get:
      description: Operatie die een samenvatting van een GLD ophaalt in JSON op basis
        van een BRO-ID Zie ook [hier](https://www.bro-productomgeving.nl/bpo/latest/grondwatermonitoring/grondwaterstandonderzoek-gld/gld-berichtencatalogus-uitgiftewebservice)
      operationId: observationsSummary
      parameters:
      - content:
          text/plain:
            schema:
              pattern: \S
              type: string
        description: Het BRO-ID van het GLD object.
        in: path
        name: broId
        required: true
      responses:
        "200":
          content:
            application/json: {}
          description: Het aangevraagde registratie object dan wel een afwijzing van
            het GLD verzoek.
          headers:
            API-Version:
              description: Versie van deze GLD 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 fouten in het verzoek.
          headers:
            API-Version:
              description: Versie van deze GLD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Operatie die een samenvatting van een GLD ophaalt in JSON op basis
        van een BRO-ID
      tags:
      - default
  /gm/gld/v1/objectsAsCsv/{broId}:
    get:
      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:
      - content:
          text/plain:
            schema:
              pattern: \S
              type: string
        description: Het BRO-ID van het GLD object.
        in: path
        name: broId
        required: true
      - 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."
        example: volledig
        in: query
        name: rapportagetype
        schema:
          type: string
      - 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."
        example: regulier_beoordeeld
        in: query
        name: observatietype
        schema:
          type: string
      responses:
        "200":
          content:
            text/plain: {}
          description: Het aangevraagde registratie object dan wel een afwijzing van
            het GLD verzoek.
          headers:
            API-Version:
              description: Versie van deze GLD 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 GLD verzoek.
          headers:
            API-Version:
              description: Versie van deze GLD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Haalt een grondwaterstandendossier (groundwater level dossier, GLD)
        op op basis van een BRO-ID als CSV
      tags:
      - default
  /gm/gld/v1/seriesAsCsv/{broId}:
    get:
      operationId: seriesAsCSV
      parameters:
      - content:
          text/plain:
            schema:
              pattern: \S
              type: string
        description: Het BRO-ID van het GLD object.
        in: path
        name: broId
        required: true
      - allowEmptyValue: true
        description: Een string bestaande uit een of meerdere quality control statussen
          gesepareerd door een komma.
        in: query
        name: filterOnStatusQualityControl
        schema:
          type: string
      - allowEmptyValue: true
        description: Als aanwezig dan worden de tijdstippen in ISO8601 formaat weergegeven.
          Anders in de Unix Epoch.
        in: query
        name: asISO8601
        schema:
          type: string
      responses:
        "200":
          content:
            text/plain: {}
          description: Het aangevraagde registratie object dan wel een afwijzing van
            het GLD verzoek.
          headers:
            API-Version:
              description: Versie van deze GLD 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 GLD verzoek.
          headers:
            API-Version:
              description: Versie van deze GLD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      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.
      tags:
      - default
tags:
- name: default
