Module: BagKadasterClient

Defined in:
lib/bag_kadaster_client/version.rb,
lib/bag_kadaster_client.rb,
lib/bag_kadaster_client/api_error.rb,
lib/bag_kadaster_client/api_client.rb,
lib/bag_kadaster_client/models/pand.rb,
lib/bag_kadaster_client/api/pand_api.rb,
lib/bag_kadaster_client/models/adres.rb,
lib/bag_kadaster_client/models/error.rb,
lib/bag_kadaster_client/models/point.rb,
lib/bag_kadaster_client/api/adres_api.rb,
lib/bag_kadaster_client/configuration.rb,
lib/bag_kadaster_client/models/polygon.rb,
lib/bag_kadaster_client/models/surface.rb,
lib/bag_kadaster_client/models/adres_io.rb,
lib/bag_kadaster_client/models/api_info.rb,
lib/bag_kadaster_client/models/hal_link.rb,
lib/bag_kadaster_client/models/indicatie.rb,
lib/bag_kadaster_client/models/ligplaats.rb,
lib/bag_kadaster_client/models/provincie.rb,
lib/bag_kadaster_client/models/voorkomen.rb,
lib/bag_kadaster_client/api/ligplaats_api.rb,
lib/bag_kadaster_client/models/bronhouder.rb,
lib/bag_kadaster_client/models/pand_links.rb,
lib/bag_kadaster_client/models/woonplaats.rb,
lib/bag_kadaster_client/api/bronhouder_api.rb,
lib/bag_kadaster_client/api/woonplaats_api.rb,
lib/bag_kadaster_client/models/pand_io_hal.rb,
lib/bag_kadaster_client/models/standplaats.rb,
lib/bag_kadaster_client/models/status_pand.rb,
lib/bag_kadaster_client/api/standplaats_api.rb,
lib/bag_kadaster_client/models/adres_io_hal.rb,
lib/bag_kadaster_client/models/gebruiksdoel.rb,
lib/bag_kadaster_client/models/punt_of_vlak.rb,
lib/bag_kadaster_client/models/geconstateerd.rb,
lib/bag_kadaster_client/models/multi_polygon.rb,
lib/bag_kadaster_client/models/multi_surface.rb,
lib/bag_kadaster_client/models/status_plaats.rb,
lib/bag_kadaster_client/models/adres_io_links.rb,
lib/bag_kadaster_client/models/bronhouder_hal.rb,
lib/bag_kadaster_client/models/invalid_params.rb,
lib/bag_kadaster_client/models/zoek_resultaat.rb,
lib/bag_kadaster_client/models/adres_io_all_of.rb,
lib/bag_kadaster_client/models/ligplaats_links.rb,
lib/bag_kadaster_client/models/openbare_ruimte.rb,
lib/bag_kadaster_client/models/verblijfsobject.rb,
lib/bag_kadaster_client/api/openbare_ruimte_api.rb,
lib/bag_kadaster_client/api/verblijfsobject_api.rb,
lib/bag_kadaster_client/models/adres_uitgebreid.rb,
lib/bag_kadaster_client/models/bronhouder_links.rb,
lib/bag_kadaster_client/models/ligplaats_all_of.rb,
lib/bag_kadaster_client/models/ligplaats_io_hal.rb,
lib/bag_kadaster_client/models/nummeraanduiding.rb,
lib/bag_kadaster_client/models/woonplaats_links.rb,
lib/bag_kadaster_client/api/adres_uitgebreid_api.rb,
lib/bag_kadaster_client/api/nummeraanduiding_api.rb,
lib/bag_kadaster_client/models/adres_io_embedded.rb,
lib/bag_kadaster_client/models/in_onderzoek_pand.rb,
lib/bag_kadaster_client/models/standplaats_links.rb,
lib/bag_kadaster_client/models/status_naamgeving.rb,
lib/bag_kadaster_client/models/status_woonplaats.rb,
lib/bag_kadaster_client/models/vlak_of_multivlak.rb,
lib/bag_kadaster_client/models/woonplaats_io_hal.rb,
lib/bag_kadaster_client/models/adres_in_onderzoek.rb,
lib/bag_kadaster_client/models/ligplaats_embedded.rb,
lib/bag_kadaster_client/models/standplaats_all_of.rb,
lib/bag_kadaster_client/models/standplaats_io_hal.rb,
lib/bag_kadaster_client/models/zoek_resultaat_hal.rb,
lib/bag_kadaster_client/models/adres_io_hal_all_of.rb,
lib/bag_kadaster_client/models/woonplaats_embedded.rb,
lib/bag_kadaster_client/api/algemene_informatie_api.rb,
lib/bag_kadaster_client/models/adres_uitgebreid_hal.rb,
lib/bag_kadaster_client/models/adresseerbaar_object.rb,
lib/bag_kadaster_client/models/hal_collection_links.rb,
lib/bag_kadaster_client/models/hal_pagination_links.rb,
lib/bag_kadaster_client/models/standplaats_embedded.rb,
lib/bag_kadaster_client/models/type_openbare_ruimte.rb,
lib/bag_kadaster_client/models/zoek_resultaat_links.rb,
lib/bag_kadaster_client/api/adresseerbaar_object_api.rb,
lib/bag_kadaster_client/models/historie_in_onderzoek.rb,
lib/bag_kadaster_client/models/openbare_ruimte_links.rb,
lib/bag_kadaster_client/models/verblijfsobject_links.rb,
lib/bag_kadaster_client/models/adres_uitgebreid_links.rb,
lib/bag_kadaster_client/models/in_onderzoek_ligplaats.rb,
lib/bag_kadaster_client/models/nummeraanduiding_links.rb,
lib/bag_kadaster_client/models/openbare_ruimte_io_hal.rb,
lib/bag_kadaster_client/models/pand_io_hal_collection.rb,
lib/bag_kadaster_client/models/status_verblijfsobject.rb,
lib/bag_kadaster_client/models/verblijfsobject_all_of.rb,
lib/bag_kadaster_client/models/verblijfsobject_io_hal.rb,
lib/bag_kadaster_client/models/adres_io_hal_collection.rb,
lib/bag_kadaster_client/models/adres_uitgebreid_all_of.rb,
lib/bag_kadaster_client/models/in_onderzoek_woonplaats.rb,
lib/bag_kadaster_client/models/nummeraanduiding_io_hal.rb,
lib/bag_kadaster_client/models/in_onderzoek_standplaats.rb,
lib/bag_kadaster_client/models/openbare_ruimte_embedded.rb,
lib/bag_kadaster_client/models/verblijfsobject_embedded.rb,
lib/bag_kadaster_client/models/bronhouder_hal_collection.rb,
lib/bag_kadaster_client/models/kenmerk_pand_in_onderzoek.rb,
lib/bag_kadaster_client/models/nummeraanduiding_embedded.rb,
lib/bag_kadaster_client/models/type_adresseerbaar_object.rb,
lib/bag_kadaster_client/models/zoek_resultaat_hal_all_of.rb,
lib/bag_kadaster_client/models/pand_io_lvc_hal_collection.rb,
lib/bag_kadaster_client/models/adres_uitgebreid_hal_all_of.rb,
lib/bag_kadaster_client/models/adresseerbaar_object_io_hal.rb,
lib/bag_kadaster_client/models/hal_pagination_links_all_of.rb,
lib/bag_kadaster_client/models/ligplaats_io_hal_collection.rb,
lib/bag_kadaster_client/models/in_onderzoek_openbare_ruimte.rb,
lib/bag_kadaster_client/models/in_onderzoek_verblijfsobject.rb,
lib/bag_kadaster_client/models/woonplaats_io_hal_collection.rb,
lib/bag_kadaster_client/models/adres_uitgebreid_in_onderzoek.rb,
lib/bag_kadaster_client/models/in_onderzoek_nummeraanduiding.rb,
lib/bag_kadaster_client/models/standplaats_io_hal_collection.rb,
lib/bag_kadaster_client/models/zoek_resultaat_hal_collection.rb,
lib/bag_kadaster_client/models/adres_uitgebreid_geconstateerd.rb,
lib/bag_kadaster_client/models/kenmerk_ligplaats_in_onderzoek.rb,
lib/bag_kadaster_client/models/adres_uitgebreid_hal_collection.rb,
lib/bag_kadaster_client/models/kenmerk_woonplaats_in_onderzoek.rb,
lib/bag_kadaster_client/models/ligplaats_io_lvc_hal_collection.rb,
lib/bag_kadaster_client/models/pand_io_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/adres_io_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/hal_pagination_links_all_of_last.rb,
lib/bag_kadaster_client/models/hal_pagination_links_all_of_next.rb,
lib/bag_kadaster_client/models/kenmerk_standplaats_in_onderzoek.rb,
lib/bag_kadaster_client/models/woonplaats_io_lvc_hal_collection.rb,
lib/bag_kadaster_client/models/hal_pagination_links_all_of_first.rb,
lib/bag_kadaster_client/models/openbare_ruimte_io_hal_collection.rb,
lib/bag_kadaster_client/models/standplaats_io_lvc_hal_collection.rb,
lib/bag_kadaster_client/models/verblijfsobject_io_hal_collection.rb,
lib/bag_kadaster_client/models/bronhouder_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/nummeraanduiding_io_hal_collection.rb,
lib/bag_kadaster_client/models/pand_io_lvc_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/adres_uitgebreid_in_onderzoek_all_of.rb,
lib/bag_kadaster_client/models/hal_pagination_links_all_of_previous.rb,
lib/bag_kadaster_client/models/kenmerk_openbare_ruimte_in_onderzoek.rb,
lib/bag_kadaster_client/models/kenmerk_verblijfsobject_in_onderzoek.rb,
lib/bag_kadaster_client/models/ligplaats_io_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/adres_uitgebreid_geconstateerd_all_of.rb,
lib/bag_kadaster_client/models/kenmerk_nummeraanduiding_in_onderzoek.rb,
lib/bag_kadaster_client/models/openbare_ruimte_io_lvc_hal_collection.rb,
lib/bag_kadaster_client/models/verblijfsobject_io_lvc_hal_collection.rb,
lib/bag_kadaster_client/models/woonplaats_io_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/nummeraanduiding_io_lvc_hal_collection.rb,
lib/bag_kadaster_client/models/standplaats_io_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/zoek_resultaat_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/adres_uitgebreid_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/adresseerbare_objecten_io_hal_collection.rb,
lib/bag_kadaster_client/models/ligplaats_io_lvc_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/woonplaats_io_lvc_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/adresseerbaar_object_lvc_io_hal_collection.rb,
lib/bag_kadaster_client/models/openbare_ruimte_io_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/standplaats_io_lvc_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/verblijfsobject_io_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/nummeraanduiding_io_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/openbare_ruimte_io_lvc_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/verblijfsobject_io_lvc_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/nummeraanduiding_io_lvc_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/adresseerbare_objecten_io_hal_collection_embedded.rb,
lib/bag_kadaster_client/models/adresseerbaar_object_lvc_io_hal_collection_embedded.rb

Overview

#IMBAG API - van de LVBAG

#Dit is de [BAG API](zakelijk.kadaster.nl/-/bag-api) Individuele Bevragingen van de Landelijke Voorziening Basisregistratie Adressen en Gebouwen (LVBAG). <br/> Meer informatie over de Basisregistratie Adressen en Gebouwen is te vinden op de website van het [Ministerie van Binnenlandse Zaken en Koninkrijksrelaties](www.geobasisregistraties.nl/basisregistraties/adressen-en-gebouwen) en [Kadaster](zakelijk.kadaster.nl/bag). <br/> <br/> De BAG API levert informatie conform de [BAG Catalogus 2018](www.geobasisregistraties.nl/documenten/publicatie/2018/03/12/catalogus-2018) en het informatiemodel IMBAG 2.0. De API specificatie volgt de [Nederlandse API-Strategie](docs.geostandaarden.nl/api/API-Strategie) specificatie versie van 20200204 en is opgesteld in [OpenAPI Specificatie](www.forumstandaardisatie.nl/standaard/openapi-specification) (OAS) v3. <br/> Het standaard mediatype HAL (`application/hal+json`) wordt gebruikt. Dit is een mediatype voor het weergeven van resources en hun relaties via hyperlinks. <br/> <br/> 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](formulieren.kadaster.nl/aanvraag_bag_api_individuele_bevragingen_productie) in te vullen. <br/> <br/> 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.

The version of the OpenAPI document: 2.1.6

Generated by: openapi-generator.tech OpenAPI Generator version: 5.4.0-SNAPSHOT

Defined Under Namespace

Classes: APIInfo, Adres, AdresApi, AdresIO, AdresIOAllOf, AdresIOEmbedded, AdresIOHal, AdresIOHalAllOf, AdresIOHalCollection, AdresIOHalCollectionEmbedded, AdresIOLinks, AdresInOnderzoek, AdresUitgebreid, AdresUitgebreidAllOf, AdresUitgebreidApi, AdresUitgebreidGeconstateerd, AdresUitgebreidGeconstateerdAllOf, AdresUitgebreidHal, AdresUitgebreidHalAllOf, AdresUitgebreidHalCollection, AdresUitgebreidHalCollectionEmbedded, AdresUitgebreidInOnderzoek, AdresUitgebreidInOnderzoekAllOf, AdresUitgebreidLinks, AdresseerbaarObject, AdresseerbaarObjectApi, AdresseerbaarObjectIOHal, AdresseerbaarObjectLvcIOHalCollection, AdresseerbaarObjectLvcIOHalCollectionEmbedded, AdresseerbareObjectenIOHalCollection, AdresseerbareObjectenIOHalCollectionEmbedded, AlgemeneInformatieApi, ApiClient, ApiError, Bronhouder, BronhouderApi, BronhouderHal, BronhouderHalCollection, BronhouderHalCollectionEmbedded, BronhouderLinks, Configuration, Error, Gebruiksdoel, Geconstateerd, HalCollectionLinks, HalLink, HalPaginationLinks, HalPaginationLinksAllOf, HalPaginationLinksAllOfFirst, HalPaginationLinksAllOfLast, HalPaginationLinksAllOfNext, HalPaginationLinksAllOfPrevious, HistorieInOnderzoek, InOnderzoekLigplaats, InOnderzoekNummeraanduiding, InOnderzoekOpenbareRuimte, InOnderzoekPand, InOnderzoekStandplaats, InOnderzoekVerblijfsobject, InOnderzoekWoonplaats, Indicatie, InvalidParams, KenmerkLigplaatsInOnderzoek, KenmerkNummeraanduidingInOnderzoek, KenmerkOpenbareRuimteInOnderzoek, KenmerkPandInOnderzoek, KenmerkStandplaatsInOnderzoek, KenmerkVerblijfsobjectInOnderzoek, KenmerkWoonplaatsInOnderzoek, Ligplaats, LigplaatsAllOf, LigplaatsApi, LigplaatsEmbedded, LigplaatsIOHal, LigplaatsIOHalCollection, LigplaatsIOHalCollectionEmbedded, LigplaatsIOLvcHalCollection, LigplaatsIOLvcHalCollectionEmbedded, LigplaatsLinks, MultiPolygon, MultiSurface, Nummeraanduiding, NummeraanduidingApi, NummeraanduidingEmbedded, NummeraanduidingIOHal, NummeraanduidingIOHalCollection, NummeraanduidingIOHalCollectionEmbedded, NummeraanduidingIOLvcHalCollection, NummeraanduidingIOLvcHalCollectionEmbedded, NummeraanduidingLinks, OpenbareRuimte, OpenbareRuimteApi, OpenbareRuimteEmbedded, OpenbareRuimteIOHal, OpenbareRuimteIOHalCollection, OpenbareRuimteIOHalCollectionEmbedded, OpenbareRuimteIOLvcHalCollection, OpenbareRuimteIOLvcHalCollectionEmbedded, OpenbareRuimteLinks, Pand, PandApi, PandIOHal, PandIOHalCollection, PandIOHalCollectionEmbedded, PandIOLvcHalCollection, PandIOLvcHalCollectionEmbedded, PandLinks, Point, Polygon, Provincie, PuntOfVlak, Standplaats, StandplaatsAllOf, StandplaatsApi, StandplaatsEmbedded, StandplaatsIOHal, StandplaatsIOHalCollection, StandplaatsIOHalCollectionEmbedded, StandplaatsIOLvcHalCollection, StandplaatsIOLvcHalCollectionEmbedded, StandplaatsLinks, StatusNaamgeving, StatusPand, StatusPlaats, StatusVerblijfsobject, StatusWoonplaats, Surface, TypeAdresseerbaarObject, TypeOpenbareRuimte, Verblijfsobject, VerblijfsobjectAllOf, VerblijfsobjectApi, VerblijfsobjectEmbedded, VerblijfsobjectIOHal, VerblijfsobjectIOHalCollection, VerblijfsobjectIOHalCollectionEmbedded, VerblijfsobjectIOLvcHalCollection, VerblijfsobjectIOLvcHalCollectionEmbedded, VerblijfsobjectLinks, VlakOfMultivlak, Voorkomen, Woonplaats, WoonplaatsApi, WoonplaatsEmbedded, WoonplaatsIOHal, WoonplaatsIOHalCollection, WoonplaatsIOHalCollectionEmbedded, WoonplaatsIOLvcHalCollection, WoonplaatsIOLvcHalCollectionEmbedded, WoonplaatsLinks, ZoekResultaat, ZoekResultaatHal, ZoekResultaatHalAllOf, ZoekResultaatHalCollection, ZoekResultaatHalCollectionEmbedded, ZoekResultaatLinks

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

BagKadasterClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



184
185
186
187
188
189
190
 
# File 'lib/bag_kadaster_client.rb', line 184

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end