Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
StaffSchedule
A Staff Schedule defines the
assigned schedules to a staff member.
StaffSchedule Fields
| Parameter | Data Type | Description |
|---|---|---|
calendarId | integer | The ID of the Calendar associated to this resource. |
icalUID | string | If created using ical import, a reference to the ical UID which generated this resource. |
minStaff | integer | The minimum staff number required. |
name | string | The name of the StaffSchedule, unique to a ShiftSchedule. |
recurrence | Recurrence | A valid repeat or period Recurrence. See Recurrences. |
staffAssignments | StaffingAssignment | A valid contact, group, or mixed staffing assignment. See Staff Assignments. |
seq | integer | Defines the order of the StaffSchedule layer. |
shiftScheduleId | integer | The ID of the ShiftSchedule associated to this resource. |
staffEachDay | boolean | Indicates whether staffing is different for each day of the shift. |
staffRotation | staffRotation | A valid staffRotation. See Staff Rotation. |
status | string | Indicates whether the resource is active or deleted. |
GET /scheduling/{organizationId}/staffSchedules
Description
Retrieve all staffSchedules for 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 StaffSchedule field Ex: name, seq, shiftScheduleId | 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", "shiftSchedule", "contact", "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. |
filter | n | string | Any non transient StaffSchedule field Ex: filter[shiftScheduleId], filter[seq] | 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 StaffSchedule field Ex: name, seq, shiftScheduleId | Specifies sort order. Comma-delimited 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}/staffSchedules
Description
Create staffSchedule(s) for an organization.
Return Type
staffSchedule 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 | A StaffSchedule object or array of substitution objects to be created. |
Example Request
Example Response
GET /scheduling/{organizationId}/staffSchedules/{ids}
Description
Retrieve one or more staffSchedule(s) by ID for an organization.
Return Type
staffSchedule 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 StaffSchedule field Ex: name, seq, shiftScheduleId | 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", "shiftSchedule", "contact", "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-delimited list of resource names. |
Example Response
PUT /scheduling/{organizationId}/staffSchedules/{ids}
Description
Update one or more staffSchedules by ID for an organization.
Return Type
staffSchedule 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 | A StaffSchedule object to be updated. Supports partial updates - one or more fields may be included in the request and only the fields specified will be updated. To remove a field, the field must be explicitly passed with a null value. PUT is treated as PATCH as object replacement is not supported. . |
Example Request
Example Response
DELETE /scheduling/{organizationId}/staffSchedules/{ids}
Description
Delete one or more staffSchedules for an organization.
Return Type
staffSchedule 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. |