Webex · Schema

ScheduleStartCodeObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
service string Service for schedule or sign up pages * `All` - Tracking codes apply to all services. * `MeetingCenter` - Users can set tracking codes when scheduling a meeting. * `EventCenter` - Users can set tracki
type string Type for meeting scheduler or meeting start pages. * `optional` - Available to be chosen but not compulsory. * `required` - Officially compulsory. * `adminSet` - The value is set by admin. This value
View JSON Schema on GitHub

JSON Schema

webex-schedulestartcodeobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScheduleStartCodeObject",
  "title": "ScheduleStartCodeObject",
  "type": "object",
  "required": [
    "service",
    "type"
  ],
  "properties": {
    "service": {
      "type": "string",
      "enum": [
        "All",
        "MeetingCenter",
        "EventCenter",
        "TrainingCenter",
        "SupportCenter"
      ],
      "description": "Service for schedule or sign up pages\n * `All` - Tracking codes apply to all services.\n * `MeetingCenter` - Users can set tracking codes when scheduling a meeting.\n * `EventCenter` - Users can set tracking codes when scheduling an event.\n * `TrainingCenter` - Users can set tracking codes when scheduling a training session.\n * `SupportCenter` - Users can set tracking codes when scheduling a support meeting.\n"
    },
    "type": {
      "type": "string",
      "enum": [
        "optional",
        "required",
        "adminSet",
        "notUsed",
        "notApplicable"
      ],
      "description": "Type for meeting scheduler or meeting start pages.\n * `optional` - Available to be chosen but not compulsory.\n * `required` - Officially compulsory.\n * `adminSet` - The value is set by admin. This value only applies when `hostProfileCode` is `adminSet`.\n * `notUsed` - The value cannot be used.\n * `notApplicable` - This value only applies to the service of `All`. When the type of `All` for a tracking code is `notApplicable`, there are different types for different services. For example, `required` for `MeetingCenter`, `optional` for `EventCenter` and `notUsed` for others.\n"
    }
  }
}