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
| Method | Endpoint | Summary | Enterprise/Premium |
|---|---|---|---|
| GET | /api/v1/resource/RosterSwap | Return a list of all RosterSwap records | Both |
| GET | /api/v1/resource/RosterSwap/INFO | Return details of the RosterSwap resource | Both |
| GET | /api/v1/resource/RosterSwap/{RosterSwapId} | Return details of a specific RosterSwap request | Both |
| POST | /api/v1/resource/RosterSwap/QUERY | Query for a specific record, can be used to view any associated objects | Both |
| Data Element | Data Type | What is it | Mandatory |
|---|---|---|---|
| Id | Integer | The unique id for this record | No |
| SourceRoster | Integer | The unique id for the roster/shift attempting to be swapped | Yes |
| TargetRoster | Integer | The unique id for the roster/shift being swapped with | Yes |
| Employee | Integer | The unique id of the employee record for the TargetRoster | Yes |
| Status | Integer | The 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 |
| RequestMessage | VarChar | Message being sent with the swap (eg. "Please swap shifts with me ") | No |
| ResponseMessage | VarChar | Response message to the employee of the source roster (eg. "Yes I will swap shifts with you) | No |
| Creator | Integer | The id of the user that created the record | No |
| Created | DateTime | When the record was created | No |
| Modified | DateTime | When the record was last modified | No |
Additional Objects
SourceRosterObject - Roster
TargetRosterObject - Roster
EmployeeObject - Employee
Updated 5 months ago