Here you will learn how to create, update and delete Workstation and person exceptions. Exceptions are breaks in a Workstation’s capacities or person’s shifts. A machine exception can be for example a service or maintenance break and a person exception a holiday, Sick Leave or a vacation.
Workstation exceptions #
Workstation exceptions can be accessed from the /Workstation-exceptions endpoint.
Person exceptions can be accessed from the /person-exceptions endpoint.
Fetching exceptions #
You fetch existing exceptions by sending GET-requests like this:
You can fetch Workstation exceptions by type, workstation_id, external_id or modified conditions.
You can fetch person exceptions by type, person_id or modified conditions
Creating an exception #
You can create a Workstation exception by sending a POST request like this:
To specify which Workstation the exception is scheduled to you use the workstation_id field.
The allowed types of exceptions for workstations are: Maintenance, Cleaning and Move/Organize.
Note that you can also give an external_id for a Workstation exception.
To create a person exception send a POST request like this:
To specify which person the exception is created for you need to use the person_id.
The allowed types of exceptions for people are: Holiday, Sick Leave, Flexi Leave, Unpaid Leave.
Updating an exception #
To update an exception you need to use the exception id you can get by sending GET-requests or from the response message when creating said exception.
Deleting exceptions #
Deleting Workstation exceptions can be done by providing internal exception ids, external_ids or workstation_ids.
Deleting person exceptions can be done by providing internal exception ids or person_ids.
Multiple sets of exceptions can be deleted in a single request by giving the ids in an array:
The response message from a DELETE-request will tell you how many exceptions have been deleted.