Gets roster shifts, optionally filtered by a number of parameters.

Request

GET https://api.yourpayroll.com.au/api/v2/business/{businessId}/rostershift

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
filter.fromDate date-time
filter.toDate date-time
filter.resourceView string

Possible values are:

  • Employee
  • Location
filter.shiftStatus string

Possible values are:

  • All
  • Published
  • Unpublished
  • Accepted
filter.shiftStatuses array of string, multiple occurances

Possible values are:

  • All
  • Published
  • Unpublished
  • Accepted
filter.selectedLocations array of string, multiple occurances
filter.selectedEmployees array of string, multiple occurances
filter.selectedRoles array of string, multiple occurances
filter.includeSublocations boolean
filter.currentView string

Possible values are:

  • resourceDay
  • resourceWeek
  • resourceNextWeeks
filter.budgetWarningPercent double
filter.employeeId int32
filter.locationId int32
filter.employeeGroupId int32
filter.unassignedShiftsOnly boolean
filter.showCosts boolean
filter.groupBy string

Possible values are:

  • Business
  • Location
filter.groupByThen string

Possible values are:

  • Employee
  • Role
  • StartingTime
filter.excludeUnassignedEmployees boolean
filter.selectAllRoles boolean

Response

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

Status code Description Resource
200 OK

OK

RosterShiftGenerateTimesheetModel