Webex · Schema

UserScheduleGetResponse

Lists the schedule and it's events' details for the requested Schedule.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique identifier for the schedule.
name	string	Name of the schedule.
type	string	* `businessHours` - The schedule is for business hours. * `holidays` - The schedule is for holidays.
events	array	List of events in the schedule.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserScheduleGetResponse",
  "title": "UserScheduleGetResponse",
  "type": "object",
  "description": "Lists the schedule and it's events' details for the requested Schedule.",
  "required": [
    "id",
    "type",
    "name"
  ],
  "example": {
    "id": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvVTJOb1pXUjFiR1V4",
    "type": "businessHours",
    "name": "Schedule1",
    "events": [
      {
        "id": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUlZaRlRsUk9RVTFG",
        "name": "EVENTNAME",
        "startDate": "2023-02-06",
        "endDate": "2023-02-06",
        "allDayEnabled": true,
        "recurrence": {
          "recurForEver": true,
          "recurDaily": {
            "recurInterval": 1
          }
        }
      },
      {
        "id": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUm5KcFpHRjVJREk9",
        "name": "Friday 2",
        "startDate": "2020-10-30",
        "endDate": "2020-10-30",
        "startTime": "13:00",
        "endTime": "17:00",
        "allDayEnabled": false,
        "recurrence": {
          "recurForEver": true,
          "recurWeekly": {
            "sunday": false,
            "monday": false,
            "tuesday": false,
            "wednesday": false,
            "thursday": false,
            "friday": true,
            "saturday": false
          }
        }
      }
    ]
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the schedule.",
      "example": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvVTJOb1pXUjFiR1V4"
    },
    "name": {
      "type": "string",
      "description": "Name of the schedule.",
      "example": "Schedule1"
    },
    "type": {
      "type": "string",
      "enum": [
        "businessHours",
        "holidays"
      ],
      "description": " * `businessHours` - The schedule is for business hours.\n * `holidays` - The schedule is for holidays.\n"
    },
    "events": {
      "type": "array",
      "description": "List of events in the schedule.",
      "items": {
        "$ref": "#/components/schemas/UserScheduleEvent"
      }
    }
  }
}