Roster
A roster is a single shift within Deputy. Each schedule in Deputy is made up of multiple rosters/shifts. Shifts can be in a state of open (meaning no one has accepted the shift and an employee is not assigned), locked (a timesheet has been generated so no changes are allowed) and filled (an employee has accepted the shift and it has been published).
TITLE:
Roster
DESCRIPTION:
A roster is a single shift within Deputy. Each schedule in Deputy is made up of multiple rosters/shifts. Shifts can be in a state of open (meaning no one has accepted the shift and an employee is not assigned), locked (a timesheet has been generated so no changes are allowed) and filled (an employee has accepted the shift and it has been published).
BODY:
Data Element | Data Type | What is it | Mandatory |
|---|---|---|---|
Id | Integer | The unique id for this record | No |
StartTime | Integer | The start time of the shift in unix time | Yes |
EndTime | Integer | The end time of the shift in unix time | Yes |
Mealbreak | Time | The total length of meal breaks in the shift | No |
Date | Date | The Date of the shift | No |
Slots | Array | Can contain multiple entries for meal breaks if there was paid and unpaid breaks in one shift etc | No |
TotalTime | Float | The total time of the planned shift length | No |
Cost | Float | The cost in dollars of the shift | No |
OperationalUnit | Integer | The area of the shift is planned for | No |
Employee | Integer | The id of the employee linked to the shift | No |
Comment | VarChar | Any comments added to the shift detail | No |
Warning | VarChar | Details reasons why the assigned employee may not be suitable for this shift, for example missing required training | No |
WarningOverrideComment | VarChar | Stored when a manager enters a reason as to why a shift warning was overridden | No |
Published | Boolean True/False | Determines whether the shift is in a draft or published state | No |
MatchedByTimesheet | Integer | If a timesheet exists which is linked to the shift it will appear here | No |
CustomFieldData | CustomFieldData | If any custom field data is present against this record it will appear here | No |
Open | Boolean True/False | Determines if a shift is marked open or not | No |
ApprovalRequired | Boolean True/False | Determines whether a manager has to approve an employee picking up an open shift | No |
ConfirmStatus | Integer | Determines whether a shift has to be confirmed by the employee and also determines if that confirmation has occurred. 0 = Not Required | No |
ConfirmComment | VarChar | If a comment has been left during the confirmation process it will appear here | No |
ConfirmBy | Integer | The id of the employee who confirmed the shift | No |
ConfirmTime | Integer | The timestamp in unix time when the confirmation occured | No |
SwapStatus | Integer | The swap status of the shift 0 = Not required | No |
SwapManageBy | Integer | The id of the employee who approved the swap | No |
ConnectStatus | Integer | Whether the shift has been locked by being linked to a timesheet | No |
Creator | Integer | The id of the user who created the record | No |
Created | DateTime | When the record was originally created | No |
Modified | DateTime | When the record was last modified | No |
Foreign Objects which can be linked with the Resource API
OperationalUnitObject - OperationalUnit
EmployeeObject - Employee
MatchedByTimesheetObject - Timesheet
ConfirmByObject - Employee
CustomFieldDataObject - CustomFieldData
Updated 13 days ago