Ga naar hoofdinhoud

Open Source Register

BRO Bodemkundig Booronderzoek (BHR-P) uitgifte en validatie - API specificatie

Binnenlandse Zaken en Koninkrijksrelaties

Originele specificatie

API documentatie

Bodemkundig Booronderzoek (BHR-P) (2.185.2)

Download OpenAPI specification:Download

Landelijke Voorziening Basisregistratie Ondergrond (BRO), uitgifte en validatie bodemkundig booronderzoek (BHR-P).

Lijst van BHR-P BRO-IDs

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

query Parameters
bronhouder
required
string
Example: bronhouder=12345678

Het kvk (kamer van koophandel) nummer van een BHR-P bronhouder

registered
string

Registered is een optionele parameter, bij afwezigheid geeft deze methode alle BHR-P 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 voor meer info.

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

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

Request Body schema: application/json

De set van kenmerken. Zie voor meer informatie: https://www.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 (VerticalInterval)
boreholeSamplesDescribed
string (YesNoEnumeration)
Enum: "JA" "NEE"
boreholeSamplesAnalyzed
string (YesNoEnumeration)
Enum: "JA" "NEE"
boreholeSamplesPhotographed
string (YesNoEnumeration)
Enum: "JA" "NEE"
fractionDistributionDetermined
string (YesNoEnumeration)
Enum: "JA" "NEE"
toolUsed
string
discipline
string
object (DatePeriod)
object (DatePeriod)
analysisType
string
characteristicModelled
string (YesNoEnumeration)
Enum: "JA" "NEE"

Responses

Request samples

Content type
application/json
"{\n \"registrationPeriod\": {\n \"beginDate\": \"2017-02-01\",\n \"endDate\": \"2021-02-01\"\n },\n \"area\": {\n \"enclosingCircle\": {\n \"center\": {\n \"lat\": 52.038297852,\n \"lon\": 5.31447958948\n },\n \"radius\": 0.5\n }\n }\n}"

Response samples

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

Haalt een bodemkundig booronderzoek ( pedological boreholeresearch survey, BHRP) op op basis van een BRO-ID

Haal een bodemkundig booronderzoek 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 voor meer info.

path Parameters
broId
required
string

Het BRO-ID van het BHR-P object.

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

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

Responses

Response samples

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