List Shift Schedules

A Shift Schedule defines a pattern of shifts that should occur in sequence over a fixed period of time.

shiftSchedule Fields

Parameter	Data Type	Description
calendarId	integer	The ID of the Calendar associated to this resource.
colorIndicator	string	Defines the color used for shifts by the Calendar in the UI.
datesApplicable.from	string	The start date of date range.
datesApplicable.to	string	The end date of the date range.
groupIds	integer	The ID of the groups to which this ShiftSchedule is linked.
groupLinkAllowed	boolean	A transient field indicating if the ShiftSchedule may be linked to a group.
hasMinStaff	boolean	A transient field indicating whether minimum staff requirements exist.
icalUID	string	If created using ical import, a reference to the ical UID which generated this resource.
minStaffAllowed	boolean	A transient field indicating whether minimum staff requirements may be added to the ShiftSchedule. It is not permitted if staffing by group exists.
name	string	The name of the ShiftSchedule, unique to a Calendar.
numDays	integer	For variable day shifts, the number of days. Not required when weekStartsWith is set, as 7 is implied.
schedule.days	array of integers	Is an array of days in the schedule for which shift times apply.
schedule.shift	string	Defined the start and end times for the shift. An end time that is before starrt time will be treated as an overnight shift.
schedule.shift.start	string	Defines the start time for a shift, HH:MM format.
schedule.shift.end	string	Defines the end time for a shift, HH:MM format.
sequenceAllowed	boolean	A transient field indicating whether the ShiftSchedule may be sequenced. It is not permitted if staffing by group exists.
sequenced	boolean	If true, assignments will be notified in the order they are configured.
status	string	Indicates whether the resource is active or deleted.
timeZoneString	string	The time zone in which the shift is located. Since DST is not observed in all time zones and observed at different time in the year for many time zones, to avoid issues this should be the time zone where contacts are physically located when possible.
weekStartsWith	string	For week based shifts, the day of week for which the ShiftSchedule starts. Must be SUNDAY or may be null if numDays is configured.

Common Parameters and Options

The services support common parameters, modeled after the JSON API Specification, are as follows:

Includes parameter permits requesting compound documents - responses including resources related to the requested resource.
- Include may be a comma-delimited list of valid resource names for which the resource supports includes.
- For example, /staffSchedules?include=calendar,shiftSchedule
Sparse Field Sets permit requesting which fields are returned by the service using the fields or fields[resourceName] (ex fields[calendar]) parameters. Paging permits requests for paged data using the pageSize and pageNo parameters.
- The parameter value must be a comma-delimited list of valid fields for the resource.
  - For example, ?fields=name,status
- If specifying sparse fields on an included resource, the include parameter is redundant and not required.
  - For example, ?include=calendar&fields[calendar]=name can be simplified to ?fields[calendar]=name
Sort permits sorting list responses using the sort parameter. Filters permit "querying" list responses using the filter[fieldName] (ex filter[status]) parameter
- The parameter value must be a comma-delimited list of valid fields for the resource.
  - For example, ?sort=name,status.
- The sort direction may be specified using +,- for ascending, descending respectively. Ascending is the default so + is not required.

Common Fields

The following fields are common to Calendar, ShiftSchedule, StaffSchedule, StaffSubstitution and ShiftSubstitution configurations.

Parameter	Data Type	Description
accountId	integer	The ID of the account that owns this resource.
createdDate	integer	The ID of the user who created the resource.
createdName	string	The name of the user who created the resource.
createdProxyName	string	The name of the proxy user who created the resource.
lastModifiedDate	string	The date and time the resource was last modified.
lastModifiedId	integer	The ID of the user who last modified the resource.
lastModifiedName	string	The name of the user who last modified the resource.
lastModifiedProxyName	string	The name of the proxy user who last modified the resource.
organizationID	integer	The ID of the organization that owns this resource.
resourceBundleId	integer	The ID of the Role which owns this resource.