Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
shiftSchedule
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. |
GET /scheduling/{organizationId}/shiftSchedules
Description
Return a list of shiftSchedules within an organization.
Return type
shiftSchedule Object
Parameters
| Name | Required? | Data Type | Options | Description |
|---|---|---|---|---|
credentials | y | string | Basic Authorization header. | |
organizationId | y | long | The ID of the organization that owns this resource. | |
fields | n | string | Any ShiftSchedule field Ex: name, numDays, colorindicator | Fields to be included in the response. Fields[resourceName} may be used to specify fields returned for included documents. When doing so, it is not necessary to also request to include the resource as the include is implied by the field’s request. |
include | n | string | "calendar", "shiftSubstitution", "staffSchedule", "group" | Specifying the includes parameter will result in a compound document response, adding resources to included which have been referenced by resources returned in data. Include may be specified as a comma delimmited list of resource names. |
filter | n | string | Any non transient ShiftSchedule field Ex: filter[name], filter[numDays], filter[colorIndicator] | Filter may be used to specify filter criteria for the request. Filters are specified in the format of filter[fieldName], where fieldName is any field supported by this resource. Multiple filter criteria will result in AND conditions, with the exception of multiple filters on the same field, in which case the criteria will be treated as an OR condition. |
sort | n | string | Any non transient ShiftSchedule field Ex: name, numDays, colorIndicator | Comma delimmited list of fields to sort by. +/- can precede the field name to indicate direction (ascending/descending) + is the default direction Ex. sort=status,-createdDate sorts by status ascending and createdDate descending |
pageSize | n | integer | default of 10 format - int32 | The number of records per page to be included in the response. |
pageNo | n | integer | default of 1 format - int32 | The page to be returned. |
Example Response
POST /scheduling/{organizationId}/shiftSchedules
Description
Create shiftSchedules within an organization.
Return Type
shiftScedule Object
Parameters
| Name | Required? | Data Type? | Description |
|---|---|---|---|
credentials | y | string | Basic Authorization header. |
organizationId | y | long | The ID of the Organization that owns this resource. |
data | y | httpRequestBody | The ID or IDs (comma-delimited) of the resources to delete. |
Example Request
Example Response
GET /scheduling/{organizationId}/shiftSchedules/{ids}
Description
Return a list of shiftSchedules by ID within an organization.
Return Type
shiftSchedule Object
Parameters
| Name | Required? | Data Type | Options | Description |
|---|---|---|---|---|
credentials | y | string | Basic Authorization header. | |
organizationId | y | long | The ID of the organization that owns this resource. | |
ids | y | string | The ID or IDs (comma-delimited) of the resources to find. | |
fields | n | string | Any non transient StaffSchedule field Ex: name, numDays, colorIndicator | Fields to be included in the response. Fields[resourceName] may be used to specify fields returned for included documents. When doing so, it is not necessary to also request to include the resource as the include is implied by the fields request. |
include | n | string | "calendar", "shiftSubstitution", "staffSchedule", "group" | Specifying the includes parameter will result in a compound document response, adding resources to included which have been referenced by resources returned in data. Include may be specified as a comma delimmited list of resource names. |
Example Response
PUT /scheduling/{organizationId}/shiftSchedules/{ids}
Description
Update one or more shiftSchedule's by ID within an organization.
Return Type
shiftSchedule Object
Parameters
| Name | Required? | Data Type? | Description |
|---|---|---|---|
credentials | y | string | Basic Authorization header. |
organizationId | y | long | The ID of the Organization that owns this resource. |
ids | y | string | The ID or IDs (comma-delimited) of the resources to update. |
data | y | httpRequestBody | The ID or IDs (comma-delimited) of the resources to delete. |
Example Request
Example Response
DELETE /scheduling/{organizationId}/shiftSchedules/{ids}
Description
Delete one or more shiftSchedules by ID within an organization.
Return Type
shiftSchedule Object
Parameters
| Name | Required? | Data Type? | Description |
|---|---|---|---|
credentials | y | string | Basic Authorization header. |
organizationId | y | long | The ID of the Organization that owns this resource. |
ids | y | string | The ID or IDs (comma-delimited) of the resources to update. |
Example Response
