Employee custom field

Add an employee custom field for an employee

Activity name : <a href="https://developer.loket.nl/Activities/PostEmployeeCustomFieldByEmployeeId" target="_blank">PostEmployeeCustomFieldByEmployeeId</a>

Metadata: Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.

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

Request

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

idstring uuid

The unique identifier of an object (GUID/UUID)

valuestring

The value for the custom field for the employee

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "customField": {
    "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
    "description": "Shoe size"
  },
  "value": "41"
}

Response

Created

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",
    "customField": {
      "id": "025ce09b-bff2-4b05-bcf0-711a89da7c08",
      "description": "Shoe size"
    },
    "value": "41"
  }
}

Changes

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