LOloket
Employee

Set the date on which to revoke ESS access

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

This endpoint allows the user to set the 'revokeEmployeeSelfServiceAccessOn'. This date indicates on what day the access to WerknemerLoket (Employee Self Service) will be revoked (this is done by scheduled tasks that run during the night). This is particularly useful for situations where for example the employer wants to restrict access at a specific date in the future, for example 1st of May in the next year.

The value may be set to NULL and thus clearing the date on which access would be revoked. Please note that this endpoint will not automatically 'unblock' an Employee, as that would require a specific action.

patch/v2/providers/employers/employees/{employeeId}/revokeEmployeeSelfServiceAccess

Request

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

revokeEmployeeSelfServiceAccessOnstring date nullable

The date on which the Employees access to ESS (werknemer.loket) will be automatically revoked.

Example request

{
  "revokeEmployeeSelfServiceAccessOn": "2018-10-23"
}

Response

OK

contentobject

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ]
}

Changes

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