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 formatieweerstandonderzoek (FRD).
  title: Formatieweerstandonderzoek (FRD)
  version: 2.197.0
openapi: 3.0.3
paths:
  /gm/frd/v1/bro-ids:
    get:
      description: Haalt de lijst van FRD 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 FRD bronhouder
        example: "12345678"
        in: query
        name: bronhouder
        required: true
        schema:
          type: string
      - description: Registered is een optionele parameter, bij afwezigheid geeft
          deze methode alle FRD 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 FRD BRO-IDs voor dit registratie object type waarvoor
            bronhouder verantwoordelijk is.
          headers:
            API-Version:
              description: Versie van deze FRD 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 FRD verzoek.
          headers:
            API-Version:
              description: Versie van deze FRD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Lijst van FRD BRO-IDs
  /gm/frd/v1/objects/{broId}:
    get:
      description: Haal een formatieweerstandonderzoek 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/grondwatermonitoring/formatieweerstandonderzoek-frd/frd-berichtencatalogus-uitgiftewebservice)
        voor meer info.
      operationId: objects
      parameters:
      - content:
          text/plain:
            schema:
              type: string
        description: Het BRO-ID van het FRD object.
        in: path
        name: broId
        required: true
      - description: Een optionele FRD referentie van de gebruiker. "-" wordt aangenomen
          bij afwezigheid.
        example: Mijn-FRD-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 FRD verzoek.
          headers:
            API-Version:
              description: Versie van deze FRD 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 FRD verzoek.
          headers:
            API-Version:
              description: Versie van deze FRD API
              examples: {}
              schema:
                examples:
                - 3.2.1
                type: string
      summary: Haalt een formatieweerstandonderzoek (formation resistance dossier,
        FRD) op op basis van een BRO-ID
