This topic describes this integration.
Virtual Roster is the system of record for schedules and time-off requests Request subtypes that employees use to request time off for vacation, illness or recovery, appointments, personal time, or other absences. Time-off requests can be configured to support many different employment scenarios..
This integration imports the following schedule data from Virtual Roster by way of API calls:
- Scheduled shifts
- Start and end dates and times
- (Optional) Break start and end dates and times
- Job transfers with location and role
- Work rule
- Time-off requests: Time-off requests in Dimensions are not used. Time-off requests are imported from Virtual Roster as paycode A category of time or money that employees earn, for example, Regular Hours, Bonus, or Sick. edits.
- Type of time off
- Start time
- Hours
- Job transfers with location and role
- Work rule
This is an API-based integration Initiates and delivers the payload by API calls from an application to Integration Hub, but not by way of the user interface. that is installed on-premises with Virtual Roster.
This integration runs continuously as schedules change in Virtual Roster.
Before you start
- Make sure that scheduling and time-off requests are not enabled in Dimensions. Managers can run schedule reports but must not edit schedules in Dimensions.
- This integration is not an integration pack; it sends API calls directly.
- Get the AppKey for the APIGatewayServer; see Generate and Access App Keys.
APIs
| API | Resource path |
|---|---|
| Authentication | /authentication/access_token |
| Scheduling | /v1/scheduling/schedule/multi_read |
| Scheduling | /v1/scheduling/schedule/shifts/multi_delete |
| Scheduling | /v1/scheduling/schedule/shifts |
| Scheduling | /v1/scheduling/schedule/shifts/{shiftID} |
| Scheduling | /v1/scheduling/schedule/multi_update |
| Scheduling | /v1/scheduling/schedule_management_actions/apply_update |
| Timekeeping | /v1/timekeeping/timecard/multi_read |
| Timekeeping | /v1/timekeeping/timecard |
| Timekeeping | /v1/timekeeping/pay_code_edits/import |
| Timekeeping | /v1/timekeeping/pay_code_edits/multi_delete |
| Commons/Timekeeping | /v1/commons/locations/multi_read |
| Commons/Data | /v1/commons/data/multi_read |
| Commons | /v1/commons/comments |