LOloket
Workflow employee

Initiate the change personal information workflow for an employee

Activity name: <a href="https://developer.loket.nl/Activities/PostInitiateChangePersonalInformationWorkflowByEmployeeId" target="_blank">PostInitiateChangePersonalInformationWorkflowByEmployeeId</a><br> <br><br>Allows the user to trigger a workflow to change his personal information for an employee. 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/InitiateChangePersonalInformation

Request

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

effectiveFromDatestring date

The effective from date refers to the specific date on which the change outlined in the request should becomes operational

lastNamePartnerstring nullable

The last name of the employee's partner.

prefixPartnerstring nullable

The prefix to the last name of the employee's partner.

commentstring nullable

An extra comment for the change request

Example request

{
  "effectiveFromDate": "2024-09-31",
  "civilStatus": {
    "key": 2,
    "value": "Maried"
  },
  "howToFormatLastName": {
    "key": 2,
    "value": "last name + last name partner"
  },
  "lastNamePartner": "Wiel",
  "prefixPartner": "van de",
  "comment": "I got married !!!!!!!"
}

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.