---
openapi: 3.0.3
info:
  title: Grondwater Monitoring (GM) domein
  description: "Landelijke Voorziening Basisregistratie Ondergrond (BRO), uitgifte\
    \ grondwatermonitoring (GM) in samenhang."
  contact:
    name: BRO Servicedesk
    url: https://basisregistratieondergrond.nl/service-contact/
    email: support@broservicedesk.nl
  version: 2.178.1
paths:
  /gm/v1/gmw-relations/{broId}:
    get:
      summary: Haalt aan deze put gerelateerde registratie objecten op
      description: "Haalt een overzicht op van aan deze put gerelateerde objecten:\
        \ grondwaterstandendossier (GLD), grondwatersamenstellingsonderzoek (GAR),\
        \ formatieweerstandsonderzoek (FRD) en grondwatermonitoringnetwerk (GMN).\
        \  \n**Merk op:** een buis-verwijzing kan beëindigd zijn in GMN. In dat geval\
        \ wordt een buis-verwijzing einddatum teruggestuurd in het resultaat.  \n\
        **Merk op:** een meetpunt kan beëindigd zijn in GMN. In dat geval wordt het\
        \ GMN teruggestuurd zonder verdere informatie in het resultaat. Het is dus\
        \ raadzaam om altijd te kijken of de relatie nog geldig is in het GMN registratie\
        \ object en het meetpunt niet is beëindigd. In de toekomst nemen we deze casus\
        \ wellicht ook mee op soortegelijke wijze als de buis-verwijzing einddatum."
      operationId: gmw-relations
      parameters:
      - name: broId
        in: path
        description: Het BRO-ID van de grondwatermonitoringsput (GMW).
        required: true
        schema:
          type: string
        example: GMW000000038500
      - name: inclMetadata
        in: query
        description: "Deze parameter bepaalt of er wel of niet kensetgegevens in de\
          \ response staan. \nEr zijn twee mogelijke waarden: true, false.\nDatums\
          \ worden volgens ISO 8601 geformatteerd. \nBij afwezigheid van deze parameter\
          \ worden er geen kensetgegevens teruggegeven."
        schema:
          default: "false"
          type: boolean
        example: true
      responses:
        "200":
          description: De gevraagde relaties.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GmwRelations"
        "400":
          description: Er bevinden zich fouten in het verzoek.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
components:
  schemas:
    GmwRelations:
      type: object
      properties:
        gmwBroId:
          type: string
        monitoringTubeReferences:
          type: array
          items:
            $ref: "#/components/schemas/MonitoringTubeReferences"
        characteristics:
          $ref: "#/components/schemas/RelationsDto"
    MonitoringTubeReferences:
      type: object
      properties:
        tubeNumber:
          format: int32
          type: integer
        screenTopPosition:
          type: number
        gmnReferences:
          type: array
          items:
            $ref: "#/components/schemas/RegistrationObjectReference"
        gldReferences:
          type: array
          items:
            $ref: "#/components/schemas/RegistrationObjectReference"
        garReferences:
          type: array
          items:
            $ref: "#/components/schemas/RegistrationObjectReference"
    RegistrationObjectReference:
      type: object
      properties:
        broId:
          type: string
        url:
          type: string
        accountableParty:
          type: string
        tubeReferenceEndDate:
          type: string
        characteristics:
          $ref: "#/components/schemas/RelationsDto"
    RelationsDto:
      type: object
      properties:
        broId:
          type: string
        qualityRegime:
          type: string
        deliveryAccountableParty:
          type: string
        objectRegistrationTime:
          type: string
        latestCorrectionTime:
          type: string
        underReview:
          type: string
        underReviewTime:
          type: string
        deregistered:
          type: string
    ServiceError:
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        errorCode:
          format: int32
          type: integer
