LOloket
Change address request

Start the change address workflow for an employee

Activity name: <a href="https://developer.loket.nl/Activities/PostChangeAddressRequestByEmployeeId" target="_blank">PostChangeAddressRequestByEmployeeId</a><br> <br><br>Allows the user to submit a change address request. Request because this request will trigger a workflow that might require the change to be approved.<br><br>Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.<br><br>Defaults : Default values for a new object can be acquired by adding `/defaults' to the POST URL.<br>

post/v2/providers/employers/employees/{employeeId}/changeaddressrequest

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/{employeeId}/changeaddressrequest
  • Auth
    none required

Path parameters

employeeIdstring uuid required

The unique identifier of the employee

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

commentstring nullable

An extra comment for the change request

Example request

{
  "address": {
    "street": "Voordijk",
    "city": "Leiden",
    "houseNumber": 12,
    "houseNumberAddition": "D",
    "postalCode": "1234 AA",
    "country": {
      "key": 1,
      "value": "Netherlands",
      "isoCode": "NL"
    }
  },
  "comment": "We move house September 26th"
}

Response

Accepted

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab"
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.