Get a Schedule Details
Retrieve a schedule by its schedule ID.
Schedules are used to support calling features and can be defined at the location or person level. businessHours schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. holidays schedules define exceptions to normal business hours by defining one or more events.
This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read.
URI Parameters
Unique identifier for the person.
Type of schedule, either businessHours or holidays.
Unique identifier for the schedule.
Query Parameters
ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
Response Properties
Identifier for a schedule.
Name for the schedule.
The Schedule type whether businessHours or holidays.
The Schedule type that specifies the business or working hours during the day.
The Schedule type that specifies the day when your organization is not open.
List of events.
Name for the event.
Start date of the event, or first occurrence if repeating, in the format of YYYY-MM-DD. This field is required if the allDayEnabled field is present.
End date of the event, or first occurrence if repeating, in the format of YYYY-MM-DD. This field is required if the allDayEnabled field is present.
Start time of the event in the format of HH:MM (24 hours format). This field is required if the allDayEnabled field is false or omitted.
End time of the event in the format of HH:MM (24 hours format). This field is required if the allDayEnabled field is false or omitted.
True if it is all-day event.
Recurrence scheme for an event.
True if the event repeats forever. Requires either recurDaily or recurWeekly to be specified.
End date for the recurring event in the format of YYYY-MM-DD. Requires either recurDaily or recurWeekly to be specified.
End recurrence after the event has repeated the specified number of times. Requires either recurDaily or recurWeekly to be specified.
Specifies the number of days between the start of each recurrence. Not allowed with recurWeekly.
Recurring interval in days. The number of days after the start when an event will repeat. Repetitions cannot overlap.
Specifies the event recur weekly on the designated days of the week. Not allowed with recurDaily.
Specifies the number of weeks between the start of each recurrence.
The Event occurs weekly on Sunday.
The Event occurs weekly on Monday.
The Event occurs weekly on Tuesday.
The Event occurs weekly on Wednesday.
The Event occurs weekly on Thursday.
The Event occurs weekly on Friday.
The Event occurs weekly on Saturday.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
{ "id": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ", "name": "Dallas_Office_Hours", "type": "businessHours", "events": [ { "name": "Day_Shift", "startDate": "2020-03-18", "endDate": "2020-03-18", "startTime": "08:00", "endTime": "17:00", "allDayEnabled": false, "recurrence": { "recurForEver": true, "recurEndDate": "2020-03-18", "recurEndOccurrence": 1, "recurDaily": { "recurInterval": 1 }, "recurWeekly": { "recurInterval": 1, "sunday": false, "monday": false, "tuesday": false, "wednesday": true, "thursday": false, "friday": false, "saturday": false } } } ] }