Get Roster Shifts

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.

Request

GET http:///api/v2/business/{businessId}/rostershift

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
FromDate date-time
ToDate date-time
ShiftStatus string

Possible values are:

  • All
  • Published
  • Unpublished
  • Accepted
ShiftStatuses array of string, multiple occurances

Possible values are:

  • All
  • Published
  • Unpublished
  • Accepted
SelectedLocations array of string, multiple occurances
SelectedEmployees array of string, multiple occurances
SelectedRoles array of string, multiple occurances
EmployeeId int32
LocationId int32
EmployeeGroupId int32
UnassignedShiftsOnly boolean
SelectAllRoles boolean
ExcludeShiftsOverlappingFromDate boolean
PageSize int32
CurrentPage int32
IncludeWarnings boolean

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 MyRosterShiftGenerateTimesheetModel