Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
Calendars
A calendar is the top level
container for Scheduling configurations, which represents a Calendar.
Calendar Fields
Parameter | Data Type | Description |
---|---|---|
active | boolean | When active is true, the calendar may be used for notifications. Otherwise, it is only visible to define a schedule. |
emailNotificationEnabled | boolean | If true, alerts are sent for changes made to the calendar. |
emailNotificationList | array | A distribution list to receive change notifications. |
externalId | string | A client defined ID for mapping to external resources. |
icalUID | string | If created using ical import, a reference to the ical UID which generated this resource. |
name | string | The name of the Calendar. |
notifyScheduled | boolean | If true, staff impacted by configuration changes will receive change notifications. |
status | string | Indicates whether the resource is active or deleted. |
type | string | The name of the Resource (constant). |
visibility | string | Defines whether the calendar is visible to the organization or only to those staffed to the calendar. |
GET /scheduling/{organizationId}/calendars
Description
Return a list of all calendars for an organization.
Return type
Calendar Object
Parameters
Name | Required? | Data Type | Parameters |
---|---|---|---|
credentials | y | string | Basic Authorization header. |
organizationId | y | long | The ID of the organization that owns this resource. |
holidayCalendarCodes | n | array of strings | An array containing country codes for the countries/regions to which this calendar is related. No validation is done. Invalid codes will be ignored. |
Example Response
POST /scheduling/{organizationId}/calendars
Description
Create a calendar within an organization.
Return type
Calendar 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 calendar’s object to be created. |
holidayCalendarCodes | n | array of strings | An array containing country codes for the countries/regions to which this calendar is related. No validation is done. Invalid codes will be ignored. |
Example Request
Example Response
GET /scheduling/{organizationId}/calendars/{ids}
Description
Return one or more calendars by ID for an organization.
Return type
Calendar 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. |
id | y | string | The ID or IDs (comma-delimited) of the resources to find. |
holidayCalendarCodes | n | array of strings | An array containing country codes for the countries/regions to which this calendar is related. No validation is done. Invalid codes will be ignored. |
Example Response
PUT /scheduling/{organizationId}/calendars/{ids}
Description
Update one or more calendars by ID for an organization.
Return type
Calendar 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. |
id | y | string | The ID or IDs (comma-delimited) of the resources to find. |
data | y | httpRequestBody | A calendar’s 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. |
holidayCalendarCodes | n | array of strings | An array containing country codes for the countries/regions to which this calendar is related. No validation is done. Invalid codes will be ignored. |
Example Request
Example Response
DELETE /scheduling/{organizationId}/calendars/{ids}
Description
Delete one or more calendars by ID for an organization.
Return type
Calendar 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. |
id | y | string | The ID or IDs (comma-delimited) of the resources to delete. |
holidayCalendarCodes | n | array of strings | An array containing country codes for the countries/regions to which this calendar is related. No validation is done. Invalid codes will be ignored. |
Example Response