Skip to content

OpenGemeenten/kadaster-bag-api-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
docs
docs
 
 
lib
lib
 
 
test
test
 
 
.php_cs
.php_cs
 
 
.travis.yml
.travis.yml
 
 
GENERATE.md
GENERATE.md
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 
git_push.sh
git_push.sh
 
 
phpunit.xml.dist
phpunit.xml.dist
 
 

Repository files navigation

SwaggerClient-php

Dit is de BAG API Individuele Bevragingen van de Landelijke Voorziening Basisregistratie Adressen en Gebouwen (LVBAG). Meer informatie over de Basisregistratie Adressen en Gebouwen is te vinden op de website van het Ministerie van Binnenlandse Zaken en Koninkrijksrelaties en Kadaster. De BAG API levert informatie conform de BAG Catalogus 2018 en het informatiemodel IMBAG 2.0. De API specificatie volgt de Nederlandse API-Strategie specificatie versie van 20200204 en is opgesteld in OpenAPI Specificatie (OAS) v3. Het standaard mediatype HAL (application/hal+json) wordt gebruikt. Dit is een mediatype voor het weergeven van resources en hun relaties via hyperlinks. Deze API is vooral gericht op individuele bevragingen (op basis van de identificerende gegevens van een object). Om gebruik te kunnen maken van de BAG API is een API key nodig, deze kan verkregen worden door het aanvraagformulier in te vullen. Voor vragen, neem contact op met de LVBAG beheerder o.v.v. BAG API 2.0. We zijn aan het kijken naar een geschikt medium hiervoor, mede ook om de API iteratief te kunnen opstellen of doorontwikkelen samen met de community. Als de API iets (nog) niet kan, wat u wel graag wilt, neem dan contact op.

This PHP package is automatically generated by the Swagger Codegen project:

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/git_user_id/git_repo_id.git"
    }
  ],
  "require": {
    "git_user_id/git_repo_id": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKeyBAG
$config = Kadaster\BagApiClient\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Kadaster\BagApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');

$apiInstance = new Kadaster\BagApiClient\Api\AdresApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$zoekresultaat_identificatie = "zoekresultaat_identificatie_example"; // string | De identificatie van een gekozen zoekresultaat uit de  zoekResultatenHalCollectie verkregen bij een GET /adressen/zoek.
$postcode = "postcode_example"; // string | Postcode behorende bij een nummeraanduiding.
$huisnummer = 56; // int | Huisnummer behorende bij een nummeraanduiding.
$huisnummertoevoeging = "huisnummertoevoeging_example"; // string | Huisnummertoevoeging behorende bij een nummeraanduiding.
$huisletter = "huisletter_example"; // string | Huisletter behorende bij een nummeraanduiding.
$exacte_match = false; // bool | Een indicatie of de resultaten van een zoekoperatie exact overeen  moeten komen met de zoekcriteria, zie  [functionele specificatie exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature).
$adresseerbaar_object_identificatie = new \Kadaster\BagApiClient\Model\AdresseerbaarObjectIdentificatie(); // \Kadaster\BagApiClient\Model\AdresseerbaarObjectIdentificatie | Identificatie van een adresseerbaar object uit de BAG.
$woonplaats_naam = "woonplaats_naam_example"; // string | Naam van een woonplaats.
$openbare_ruimte_naam = "openbare_ruimte_naam_example"; // string | Naam van een openbare ruimte.
$pand_identificatie = new \Kadaster\BagApiClient\Model\PandIdentificatie(); // \Kadaster\BagApiClient\Model\PandIdentificatie | De identificatie van een pand uit de BAG.
$expand = "expand_example"; // string | Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.
$page = 1; // int | Pagina nummer
$page_size = 20; // int | Aantal resultaten per pagina
$q = "q_example"; // string | Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter,  huisnummertoevoeging.
$inclusief_eind_status = false; // bool | Een indicatie of ook actuele voorkomens met een eind status geleverd moeten worden.
$openbare_ruimte_identificatie = new \Kadaster\BagApiClient\Model\OpenbareRuimteIdentificatie(); // \Kadaster\BagApiClient\Model\OpenbareRuimteIdentificatie | De identificatie van een openbare ruimte uit de BAG.

try {
    $result = $apiInstance->bevraagAdressen($zoekresultaat_identificatie, $postcode, $huisnummer, $huisnummertoevoeging, $huisletter, $exacte_match, $adresseerbaar_object_identificatie, $woonplaats_naam, $openbare_ruimte_naam, $pand_identificatie, $expand, $page, $page_size, $q, $inclusief_eind_status, $openbare_ruimte_identificatie);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdresApi->bevraagAdressen: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: apiKeyBAG
$config = Kadaster\BagApiClient\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Kadaster\BagApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');

$apiInstance = new Kadaster\BagApiClient\Api\AdresApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$nummeraanduiding_identificatie = new \Kadaster\BagApiClient\Model\NummeraanduidingIdentificatie(); // \Kadaster\BagApiClient\Model\NummeraanduidingIdentificatie | De identificatie van een nummeraanduiding uit de BAG.
$expand = "expand_example"; // string | Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.
$inclusief_eind_status = false; // bool | Een indicatie of ook actuele voorkomens met een eind status geleverd moeten worden.

try {
    $result = $apiInstance->bevraagAdressenMetNumId($nummeraanduiding_identificatie, $expand, $inclusief_eind_status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdresApi->bevraagAdressenMetNumId: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: apiKeyBAG
$config = Kadaster\BagApiClient\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Kadaster\BagApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');

$apiInstance = new Kadaster\BagApiClient\Api\AdresApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$zoek = "zoek_example"; // string | Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter,  huisnummertoevoeging.
$page = 1; // int | Pagina nummer
$page_size = 20; // int | Aantal resultaten per pagina

try {
    $result = $apiInstance->zoek($zoek, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdresApi->zoek: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2

Class Method HTTP request Description
AdresApi bevraagAdressen GET /adressen Bevragen van huidige adressen met een (combinatie van) zoek parameters.
AdresApi bevraagAdressenMetNumId GET /adressen/{nummeraanduidingIdentificatie} Bevragen van een huidig adres met de identificatie van een nummeraanduiding.
AdresApi zoek GET /adressen/zoek Zoeken van huidige adressen
AdresUitgebreidApi bevraagAdresUitgebreidMetNumId GET /adressenuitgebreid/{nummeraanduidingIdentificatie} Bevragen van de uitgebreide informatie van één huidig adres met de identificatie van een nummeraanduiding.
AdresUitgebreidApi zoekAdresUitgebreid GET /adressenuitgebreid Bevragen van de uitgebreide informatie van één of meer huidige adressen op basis van verschillende combinaties van parameters.
AdresseerbaarObjectApi bevragenAdresseerbaarObject GET /adresseerbareobjecten/{adresseerbaarObjectIdentificatie} Bevragen van één adresseerbaar object met een adresseerbaar object identificatie.
AdresseerbaarObjectApi bevragenAdresseerbaarObjectLvc GET /adresseerbareobjecten/{adresseerbaarObjectIdentificatie}/lvc Bevragen van de levenscyclus van een adresseerbaar object met een adresseerbaar object identificatie.
AdresseerbaarObjectApi zoekAdresseerbareObjecten GET /adresseerbareobjecten Bevragen van één of meer adresseerbare objecten op basis van een nummeraanduiding identificatie.
AlgemeneInformatieApi getInfo GET /info Algemene info van de API
BronhouderApi bevragenBronhouder GET /bronhouders/{identificatie} Bevragen bronhouder met de bronhouder identificatie (gemeentecode).
BronhouderApi bronhouderIdentificatieVoorkomen GET /bronhouders/{identificatie}/{versie}/{timestampRegistratieLv} bevragen voorkomen van een bronhouder met de identificatie van een bronhouder en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
BronhouderApi zoekBronhouder GET /bronhouders Bevragen bronhouder met een object identificatie.
LigplaatsApi ligplaatsGeometrie POST /ligplaatsen bevragen van een ligplaats, op basis van een geometrische locatie.
LigplaatsApi ligplaatsIdentificatie GET /ligplaatsen/{identificatie} bevragen 1 ligplaats met de identificatie van een ligplaats.
LigplaatsApi ligplaatsIdentificatieVoorkomen GET /ligplaatsen/{identificatie}/{versie}/{timestampRegistratieLv} bevragen voorkomen van een ligplaats met de identificatie van een ligplaats en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
LigplaatsApi ligplaatsLvcIdentificatie GET /ligplaatsen/{identificatie}/lvc bevragen levenscyclus van een ligplaats met de identificatie van een ligplaats.
LigplaatsApi zoekLigplaatsen GET /ligplaatsen Zoeken van ligplaatsen met een geometrische locatie of binnen een bounding box.
NummeraanduidingApi nummeraanduidingIdentificatie GET /nummeraanduidingen/{nummeraanduidingIdentificatie} bevragen van een nummeraanduiding op basis van de identificatie van een nummeraanduiding
NummeraanduidingApi nummeraanduidingIdentificatieVoorkomen GET /nummeraanduidingen/{nummeraanduidingIdentificatie}/{versie}/{timestampRegistratieLv} bevragen van een voorkomen van een nummeraanduiding, op basis van de identificatie van een nummeraanduiding en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
NummeraanduidingApi nummeraanduidingLvcIdentificatie GET /nummeraanduidingen/{nummeraanduidingIdentificatie}/lvc bevragen levenscyclus van een nummeraanduiding met de identificatie van een nummeraanduiding.
NummeraanduidingApi zoekNummeraanduiding GET /nummeraanduidingen bevragen nummeraanduiding(en) op basis van verschillende combinaties van parameters.
OpenbareRuimteApi openbareruimteIdentificatie GET /openbareruimten/{openbareRuimteIdentificatie} bevragen van een openbare ruimte met de identificatie van een openbare ruimte.
OpenbareRuimteApi openbareruimteIdentificatieVoorkomen GET /openbareruimten/{openbareRuimteIdentificatie}/{versie}/{timestampRegistratieLv} bevragen van een voorkomen van een openbare ruimte met de identificatie van een openbare ruimte en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
OpenbareRuimteApi openbareruimteLvcIdentificatie GET /openbareruimten/{openbareRuimteIdentificatie}/lvc bevragen levenscyclus van een openbare ruimte met de identificatie van een openbare ruimte.
OpenbareRuimteApi zoekOpenbareRuimten GET /openbareruimten bevragen openbare ruimte(n) op basis van de verschillende combinaties van parameters.
PandApi pandGeometrie POST /panden bevragen panden met een geometrische locatie.
PandApi pandIdentificatie GET /panden/{identificatie} bevragen van een pand met de identificatie van een pand.
PandApi pandIdentificatieVoorkomen GET /panden/{identificatie}/{versie}/{timestampRegistratieLv} bevragen voorkomen van een pand met de identificatie van een pand en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
PandApi pandLvcIdentificatie GET /panden/{identificatie}/lvc bevragen levenscyclus van een pand met de identificatie van een pand.
PandApi zoekPanden GET /panden Zoek panden met een geometrische locatie, binnen een bounding box, met een adresseerbaar object identificatie of met een nummeraanduiding identificatie.
StandplaatsApi standplaatsGeometrie POST /standplaatsen bevragen van een standplaats met een geometrische locatie.
StandplaatsApi standplaatsIdentificatie GET /standplaatsen/{identificatie} bevragen van een standplaats met de identificatie van een standplaats.
StandplaatsApi standplaatsIdentificatieVoorkomen GET /standplaatsen/{identificatie}/{versie}/{timestampRegistratieLv} bevragen van een voorkomen van een standplaats met de identificatie van een standplaats en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
StandplaatsApi standplaatsLvcIdentificatie GET /standplaatsen/{identificatie}/lvc bevragen levenscyclus van een standplaats met de identificatie van een standplaats.
StandplaatsApi zoekStandplaatsen GET /standplaatsen zoeken van standplaatsen met een geometrische locatie of binnen een bounding box.
VerblijfsobjectApi verblijfsobjectIdentificatie GET /verblijfsobjecten/{identificatie} bevragen 1 verblijfsobject met de identificatie van een verblijfsobject.
VerblijfsobjectApi verblijfsobjectIdentificatieVoorkomen GET /verblijfsobjecten/{identificatie}/{versie}/{timestampRegistratieLv} bevragen voorkomen van een verblijfsobject, op basis van de identificatie van een verblijfsobject en de identificatie van een voorkomen
VerblijfsobjectApi verblijfsobjectLvcIdentificatie GET /verblijfsobjecten/{identificatie}/lvc bevragen levenscyclus van een verblijfsobject met de identificatie van een verblijfsobject.
VerblijfsobjectApi zoekVerblijfsobjecten GET /verblijfsobjecten Zoeken van alle aan een pand gerelateerde verblijfsobjecten of binnen een bounding box (met paginering).
WoonplaatsApi woonplaatsGeometrie POST /woonplaatsen bevragen van een woonplaats met een geometrische locatie.
WoonplaatsApi woonplaatsIdentificatie GET /woonplaatsen/{identificatie} bevragen van een woonplaats met de identificatie van een woonplaats.
WoonplaatsApi woonplaatsIdentificatieVoorkomen GET /woonplaatsen/{identificatie}/{versie}/{timestampRegistratieLv} bevragen van een voorkomen van een woonplaats met de identificatie van een woonplaats en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
WoonplaatsApi woonplaatsLvcIdentificatie GET /woonplaatsen/{identificatie}/lvc bevragen van de levenscyclus van een woonplaats met de identificatie van een woonplaats.
WoonplaatsApi zoekWoonplaatsen GET /woonplaatsen Zoeken van één of meer woonplaatsen met een woonplaatsnaam, geometrische locatie of binnen een bounding box.

Documentation For Models

Documentation For Authorization

apiKeyBAG

  • Type: API key
  • API key parameter name: X-Api-Key
  • Location: HTTP header

Author

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases 1

1.0.0 Latest
Mar 15, 2024

Packages

No packages published

Languages