Gets roster shifts, optionally filtered by a number of parameters. Query parameters 'fromDate' and 'toDate' are required. NOTE: By default, only shifts with no role assigned are returned. To return shifts with roles, either specify some SelectedRoles, or specify SelectAllRoles = true.
GET https://apimy.yourpayroll.io/api/v2/business/{businessId}/rostershift
Parameter name | Value | Description | Additional |
---|---|---|---|
businessId | string | Required |
Parameter name | Value | Description | Additional |
---|---|---|---|
filter.fromDate | date-time | ||
filter.toDate | date-time | ||
filter.shiftStatus | string |
Possible values are:
|
|
filter.shiftStatuses | array of string, multiple occurances |
Possible values are:
|
|
filter.selectedLocations | array of string, multiple occurances | ||
filter.selectedEmployees | array of string, multiple occurances | ||
filter.selectedRoles | array of string, multiple occurances | ||
filter.employeeId | int32 | ||
filter.locationId | int32 | ||
filter.employeeGroupId | int32 | ||
filter.unassignedShiftsOnly | boolean | ||
filter.selectAllRoles | boolean | ||
filter.excludeShiftsOverlappingFromDate | boolean | ||
filter.pageSize | int32 | ||
filter.currentPage | int32 | ||
filter.includeWarnings | boolean |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
MyRosterShiftGenerateTimesheetModel |
Powered by DapperDox