Bürgervorgänge - Web Service API

Join in

To get started

API key

Each request to this API must provide an API key.
It can be provided either as HTTP-Header Parameter or as Query String Parameter.

Examples
HTTP-Header Parameter
X-ApiKey: 42280EF3E32BE640CAEFE0238A07BFD0
Query String Parameter
/api/v1/?apiKey=42280EF3E32BE640CAEFE0238A07BFD0

REST Services

To get started

API key

Each request to this API must provide an API key.
It can be provided either as HTTP-Header Parameter or as Query String Parameter.

Examples
HTTP-Header Parameter
X-ApiKey: 42280EF3E32BE640CAEFE0238A07BFD0
Query String Parameter
/api/v1/?apiKey=42280EF3E32BE640CAEFE0238A07BFD0

Media Type

Each HTTP-Request to the REST API must provide the Parameters Content-Type and Accept.

Examples
Content-Type

defines the format that the request will have.

Use
Content-Type: application/json
or
Content-Type: application/xml
Accept

defines the format that the response has to be.

Use
Accept: application/json
or
Access: application/xml

SOAP Services

To get started

API key

Each request to this API must provide an API key.
It can be provided either as HTTP-Header Parameter or as Query String Parameter.

Examples
HTTP-Header Parameter
X-ApiKey: 42280EF3E32BE640CAEFE0238A07BFD0
Query String Parameter
/api/v1/?apiKey=42280EF3E32BE640CAEFE0238A07BFD0