Naar hoofdinhoud

BRO Geotechnisch Sondeeronderzoek (CPT) uitgifte en validatie - API specificatie

Binnenlandse Zaken en Koninkrijksrelaties

Originele specificatie

API documentatie

Geotechnisch sondeeronderzoek (CPT) (1.173.2)

Download OpenAPI specification:Download

Landelijke Voorziening Basisregistratie Ondergrond (BRO), uitgifte en validatie Geotechnisch sondeeronderzoek (CPT).

Lijst van BRO-IDs

Haalt de lijst van CPT bro-ids op waarvoor bronhouder verantwoordelijk is.

query Parameters
bronhouder
required
string
Example: bronhouder=12345678

Het kvk (kamer van koophandel) nummer van een bronhouder

registered
string

Registered is een optionele parameter, bij afwezigheid geeft deze methode alle BRO-IDs terug onafhankelijk of die wel/niet uit registratie zijn genomen.
registered = ja geeft alleen BRO-IDs terug die in registratie zijn genomen.
registered = nee geeft alleen BRO-IDs terug die uit registratie zijn genomen.

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "errorCode": 0
}

Haalt de karakteristieken op van een set van registratie objecten, gegeven een kenmerkenverzameling (kenset).

De karakteristieken geven een samenvatting van een object zodat een verdere selectie gemaakt kan worden. Het past in een twee-traps-benadering, waarbij de eerste stap bestaat uit het ophalen van de karakteristieken en de 2e stap uit het ophalen van de gewenste registratie objecten. Het resultaat van deze operatie is gemaximaliseerd op 2000.Zie hier en hier voor meer info.

query Parameters
requestReference
string
Example: requestReference=Mijn-aanvraag-000001

Een optionele referentie van de gebruiker. "-" wordt aangenomen bij afwezigheid.

Request Body schema: application/json

De set van kenmerken. Zie voor meer informatie: https://bro-productomgeving.nl/bpo/latest/

deliveryAccountableParty
string
qualityRegime
string (QualityRegime)
Enum: "IMBRO" "IMBRO_A"
object (DatePeriod)
object (DatePeriod)
underReview
string (YesNoEnumeration)
Enum: "JA" "NEE"
required
object (Area)
object (DatePeriod)
object (DatePeriod)
object (DepthInterval)
cptStandard
string
qualityClass
Array of strings
dissipationTestPerformed
string (YesNoEnumeration)
Enum: "JA" "NEE"
object (Parameters)
stopCriterion
string

Responses

Request samples

Content type
application/json
{
  • "registrationPeriod": {
    },
  • "area": {
    }
}

Response samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "errorCode": 0
}

Haalt een geotechnisch sondeeronderzoek (GeotechnicalSurvey, CPT) op op basis van een BRO-ID

Haal een sondeeronderzoek 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 en hier voor meer info.

path Parameters
broId
required
string

Het BRO-ID van het object.

query Parameters
requestReference
string
Example: requestReference=Mijn-object-aanvraag-000001

Een optionele referentie van de gebruiker. "-" wordt aangenomen bij afwezigheid.

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "errorCode": 0
}