Getting Started

The ‘BRP update’ Web API is specified in OpenAPI specifications (OAS).

Do you want to use the API? This is what you can do:

1. View the functionality and specifications
2. Implement the API client

Functionality and specifications

With this API you can keep a local copy current. You can manage which persons you want to follow, and request for which followed persons data has changed from a particular date onwards.

You can view a visual representation of the specification with Swagger UI or Redoc.

You can read the functional documentation in features.

Managing which persons are followed

• You can switch on the following of a person with or without an end date
• You can stop following a person by supplying an end date for the following
• You can change an end date for following by supplying a new end date
• Where you have followed a person before, you can follow the person again by removing the end date or supplying an end date in the future
• You can request which persons you are following

Requesting changes to persons

• Fill in the date “from” to receive all changes from that date onwards
• The answer contains the citizen service numbers of persons whose data changed on or after that date
• Use the citizen service numbers to request the current data of the person

Implement the API client

You can generate client code with the “genereervariant” of the API specifications and a code generator. An overview of code generators can be found at OpenAPI.Tools.

This repo contains scripts with which you can generate client code in JAVA, .NET (Full Framework and Core) and Python using OpenAPI Generator. The easiest way to use the code generation scripts is to clone this repo. After cloning you can install the packages needed with npm install, and with npm run <script name> you can run one of the following scripts:

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

A list of other supported generator options can be found in the Generators List of OpenAPI Generator.

Note. The prerequisite of OpenAPI Generator is JAVA. You must install a JAVA runtime before you can use OpenAPI Generator.

Trying and testing

Ask your municipality about demo and test environments that they make available to their consumers.