Workflow employee

Initiate the change partner information workflow for an employee

Activity name: <a href="https://developer.loket.nl/Activities/PostInitiateManagePartnersWorkflowByEmployeeId" target="_blank">PostInitiateManagePartnersWorkflowByEmployeeId</a><br> <br><br>Allows the user to trigger a workflow to manage the partners (Create, update and delete). The workflow may 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 : none<br>

post/v2/providers/employers/employees/{employeeId}/workflow/InitiateManagePartners

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/{employeeId}/workflow/InitiateManagePartners
  • 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

OR
OR

Example request

{
  "startDate": "1995-05-21",
  "endDate": "1995-05-21",
  "firstName": "Susan",
  "lastName": "Bergen",
  "prefix": "van",
  "initials": "S.L.",
  "dateOfBirth": "1995-05-21",
  "placeOfBirth": "Amsterdam",
  "howToFormatLastName": {
    "key": 2,
    "value": "last name + last name partner"
  },
  "title": {
    "key": 2,
    "value": "e.g. Msc, PHD or Baron"
  },
  "gender": {
    "key": 2,
    "value": "female"
  },
  "waoClassification": {
    "key": 2,
    "value": "15 - 24"
  },
  "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.