Organizational entity

Edit the details of an organizational entity

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

Edit the details for an organizational entity

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

put/v2/providers/employers/employees/employments/organizationalentities/{organizationalEntityId}

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/organizationalentities/{organizationalEntityId}
  • Auth
    none required

Path parameters

organizationalEntityIdstring uuid required

The unique identifier of the organizational entity

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)

startDatestring date

The start date of the entity.

A (linked chain)[./#section/Data/Date-chains] is maintained within this resource.

endDatestring date nullable

The end date of the entity. The date is up to and including.

deviatingFunctionGroupstring nullable

The deviating function group description of the employment. Only applies when a deviating function description is defined.

deviatingFunctionDescriptionstring nullable

The deviating function description of the employment. This description deviates from the value of the function field.

placeOfEmploymentstring nullable

The standard working location (standplaats) for the employment.

internalTelephoneExtensionNumberstring nullable

The phone number of the standard working location (standplaats) for the employment.

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "startDate": "2018-01-01",
  "endDate": "2018-10-23",
  "function": {
    "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "description": "Directeur",
    "group": "internal"
  },
  "deviatingFunctionGroup": "9A",
  "deviatingFunctionDescription": "Directeur",
  "standardFunction": {
    "key": 1,
    "value": "Administrateur",
    "code": "A21",
    "category": 1
  },
  "department": {
    "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "code": 2,
    "description": "Verkoop"
  },
  "distributionUnit": {
    "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "code": 2,
    "description": "Sales"
  },
  "placeOfEmployment": "Amsterdam office",
  "internalTelephoneExtensionNumber": "678"
}

Response

OK

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",
    "startDate": "2018-01-01",
    "endDate": "2018-10-23",
    "function": {
      "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "description": "Directeur",
      "group": "internal"
    },
    "deviatingFunctionGroup": "9A",
    "deviatingFunctionDescription": "Directeur",
    "standardFunction": {
      "key": 1,
      "value": "Administrateur",
      "code": "A21",
      "category": 1
    },
    "department": {
      "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "code": 2,
      "description": "Verkoop"
    },
    "distributionUnit": {
      "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "code": 2,
      "description": "Sales"
    },
    "placeOfEmployment": "Amsterdam office",
    "internalTelephoneExtensionNumber": "678"
  }
}

Changes

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