Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB
ShiftOverrides

Replace ShiftOverrides for an employee.

Replace all ShiftOverrides for a given employee within the specified date range.

<Note>This endpoint uses a PUT semantic: all existing ShiftOverrides for the employee within the startsAt.between range will be removed and replaced by the ones provided in the request body. If none exist, then the provided ShiftOverrides will simply be created.</Note>

<Warning>Both employee.id and startsAt.between query parameters are required.</Warning>

put/schedule/api/shift-overrides

Query parameters

employee.idinteger required

The ID of the employee whose ShiftOverrides should be replaced.

startsAt.betweenstring required
Example:2023-01-01--2023-01-31

The date range within which existing ShiftOverrides will be replaced. Open-ended ranges can be defined with .. characters.

Request body

employeeIdinteger required

The ID of the employee this override applies to.

position'firstHalf' | 'secondHalf' | 'fullDay' required
startsAtstring date-time required

Start date-time of the override.

nature'worked' | 'off' | 'partTime' | 'weeklyRest' required

The nature of the shift override.

  • worked: the employee is working.
  • off: the employee is off.
  • partTime: part-time day.
  • weeklyRest: weekly rest day.
commentstring nullable

Optional comment associated with the override.

Response

OK