RosterSwap

Roster swapping is where employees or managers can swap shifts. Instead of this automatically occurring, in many cases an invite to swap shifts is sent to another employee who then accepts or denies the request. The RosterSwap object stores and controls this flow.

πŸ“˜

For more information

For more information about how Deputy Shift/Roster swaps work see this Deputy Help Guide.


Endpoints

MethodEndpointSummaryEnterprise/Premium
GET/api/v1/resource/RosterSwapReturn a list of all RosterSwap recordsBoth
GET/api/v1/resource/RosterSwap/INFOReturn details of the RosterSwap resourceBoth
GET/api/v1/resource/RosterSwap/{RosterSwapId}Return details of a specific RosterSwap requestBoth
POST/api/v1/resource/RosterSwap/QUERYQuery for a specific record, can be used to view any associated objectsBoth
Data ElementData TypeWhat is itMandatory
IdIntegerThe unique id for this recordNo
SourceRosterIntegerThe unique id for the roster/shift attempting to be swappedYes
TargetRosterIntegerThe unique id for the roster/shift being swapped withYes
EmployeeIntegerThe unique id of the employee record for the TargetRosterYes
StatusIntegerThe status for the swap

0 = Not required
1 = Pending Out
2 = Pending In
3 = Pending In Out
4 = Pending Approval
5 = Approved
6 = Cancelled
7 = Declined
Yes
RequestMessageVarCharMessage being sent with the swap (eg. "Please swap shifts with me ")No
ResponseMessageVarCharResponse message to the employee of the source roster (eg. "Yes I will swap shifts with you)No
CreatorIntegerThe id of the user that created the recordNo
CreatedDateTimeWhen the record was createdNo
ModifiedDateTimeWhen the record was last modifiedNo

Additional Objects

SourceRosterObject - Roster
TargetRosterObject - Roster
EmployeeObject - Employee