BRP Bewoning

Getting Started

De ‘BRP bewoning’ Web API is gespecificeerd in OpenAPI specifications (OAS).

Wil je de API gebruiken? Dit kun je doen:

  1. Bekijk de functionaliteit en specificaties
  2. Implementeer de API Client
  3. Probeer en test de API

Functionaliteit en specificaties

Met de bewoning API kun je:

  • de samenstelling van bewoners van een woning raadplegen op een peildatum
  • de samenstelling(en) van bewoners van een woning raadplegen binnen een periode.

De bewoning API kun je op twee manieren gebruiken:

  1. Met een peildatum. Je krijgt dan de bewoners van de woning op de opgegeven datum.
  2. Met een periode (datumVan en datumTotEnMet). Je krijgt dan de samenstelling(en) van bewoners van de woning binnen de opgegeven periode.

Bekijk de OAS specificaties in Redoc

Implementeer de API client

Client code kun je genereren met de “genereervariant” van de API-specificaties en een code generator. Een overzicht met codegeneratoren kun je vinden op OpenAPI.Tools.

Deze repo bevat scripts waarmee je met OpenAPI Generator client code kunt genereren in JAVA, .NET (Full Framework & Core) en Python. De makkelijkste manier om de code generatie scripts te gebruiken, is door deze repo te clonen. Na het clonen kun je met npm install de benodigde packages installeren en kun je met npm run

  • oas:generate-java-client (voor JAVA client code)
  • oas:generate-netcore-client (voor .NET Core client code)
  • oas:generate-net-client (voor .NET Full Framework client code)
  • oas:generate-python-client (voor Python client code)

Een lijst met andere ondersteunde generator opties kun je vinden in de Generators List van OpenAPI Generator.

Note. De prerequisite van OpenAPI Generator is JAVA. Je moet een JAVA runtime installeren voordat je OpenAPI Generator kunt gebruiken

Probeer en test de API

Volgt binnenkort