|
Http Verb |
PATCH |
|---|---|
|
Url |
/workforce/calendars/r1/work-shifts/{workShiftId} |
|
Permissions required |
|
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 |
|
Released since |
|
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
|
Business Logic
This API modify an existing Work Shift.
Validations:
-
The resourceId in input should not be related to a resource on loan.
The work shift update can be performed in two different ways:
-
by switching to another typeId
-
by manually entering data in the call. In this case, the business logic checks the breakStart and breakEnd fields, which must be within the range of the shift's startDate and endDate.
Path Parameters
|
Field |
Note |
|---|---|
|
workShiftId |
|
Header Parameters
Default.
Request Body Parameters
|
Field |
Validations |
Note |
|---|---|---|
|
typeId |
Max Length: 10 |
|
|
startDate |
Format: HH:mm (String) |
|
|
endDate |
Format: HH:mm (String) |
|
|
expectedStartDate |
Format: HH:mm (String) |
|
|
expectedEndDate |
Format: HH:mm (String) |
|
|
breakStart |
Format: HH:mm (String) |
|
|
breakEnd |
Format: HH:mm (String) |
|
|
clockingTypeId |
Max Length: 10 |
|
|
transferTimeEvaluationTypeId |
Max Length: 10 |
|
|
availabilityTypeId |
Max Length: 10 |
|
|
overtimeMinute |
Max Length: 10 |
|
|
note |
|
|
Response documentation
Response error codes
NOT_FOUND, BASE_0003, BASE_0012, CALENDAR_007, CALENDAR_002, WORKFORCE_007