Webex · Schema

GetTrackingCodeObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique identifier for tracking code.
name	string	Name for tracking code.
siteUrl	string	Site URL for the tracking code.
options	array	Tracking code option list.
inputMode	string	An option for how an admin user can provide a code value. * `text` - Text input. * `select` - Drop down list which requires `options`. * `editableSelect` - Both text input and select from list. * `hos
hostProfileCode	string	Type for the host profile. * `optional` - Available to be chosen but not compulsory. * `required` - Officially compulsory. * `adminSet` - The value is set by admin. * `notUsed` - The value cannot be u
scheduleStartCodes	array	Specify how tracking codes are used for each service on the meeting scheduler or meeting start pages.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetTrackingCodeObject",
  "title": "GetTrackingCodeObject",
  "type": "object",
  "required": [
    "id",
    "name",
    "siteUrl",
    "options",
    "inputMode",
    "hostProfileCode",
    "scheduleStartCodes"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "1",
      "description": "Unique identifier for tracking code."
    },
    "name": {
      "type": "string",
      "example": "Department",
      "description": "Name for tracking code."
    },
    "siteUrl": {
      "type": "string",
      "example": "example.webex.com",
      "description": "Site URL for the tracking code."
    },
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OptionsForTrackingCodeObject"
      },
      "description": "Tracking code option list."
    },
    "inputMode": {
      "type": "string",
      "enum": [
        "text",
        "select",
        "editableSelect",
        "hostProfileSelect"
      ],
      "description": "An option for how an admin user can provide a code value.\n * `text` - Text input.\n * `select` - Drop down list which requires `options`.\n * `editableSelect` - Both text input and select from list.\n * `hostProfileSelect` - An input method is only available for the host profile and sign-up pages.\n"
    },
    "hostProfileCode": {
      "type": "string",
      "enum": [
        "optional",
        "required",
        "adminSet",
        "notUsed"
      ],
      "description": "Type for the host profile.\n * `optional` - Available to be chosen but not compulsory.\n * `required` - Officially compulsory.\n * `adminSet` - The value is set by admin.\n * `notUsed` - The value cannot be used.\n"
    },
    "scheduleStartCodes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ScheduleStartCodeObject"
      },
      "description": "Specify how tracking codes are used for each service on the meeting scheduler or meeting start pages."
    }
  }
}