Get a Tracking Code
Retrieves details for a tracking code by an admin user.
If
siteUrlis specified, the tracking code is retrieved from the specified site; otherwise, the tracking code is retrieved from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the Get Site List API.Admins can switch any Control Hub managed site from using classic tracking codes to mapped tracking codes in Control Hub, this is a one-time irreversible operation. Once the tracking codes are mapped to custom or user profile attributes, the response returns details for a mapped tracking code.
URI Parameters
Unique identifier for the tracking code whose details are being requested.
Query Parameters
URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the Get Site List API.
Response Properties
Unique identifier for tracking code.
Name for tracking code.
Site URL for the tracking code.
Tracking code option list.
The value of a tracking code option.
Whether or not the option is the default option of a tracking code.
An option for how an admin user can provide a code value.
Text input.
Drop down list which requires options.
Both text input and select from list.
An input method is only available for the host profile and sign-up pages.
Type for the host profile.
Available to be chosen but not compulsory.
Officially compulsory.
The value is set by admin.
The value cannot be used.
Specify how tracking codes are used for each service on the meeting scheduler or meeting start pages.
Service for schedule or sign up pages
Tracking codes apply to all services.
Users can set tracking codes when scheduling a meeting.
Users can set tracking codes when scheduling an event.
Users can set tracking codes when scheduling a training session.
Users can set tracking codes when scheduling a support meeting.
Type for meeting scheduler or meeting start pages.
Available to be chosen but not compulsory.
Officially compulsory.
The value is set by admin. This value only applies when hostProfileCode is adminSet.
The value cannot be used.
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.
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
- URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and the preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.
{
"id": "1",
"name": "Department",
"siteUrl": "example.webex.com",
"inputMode": "select",
"options": [
{
"value": "Engineering",
"defaultValue": false
},
{
"value": "Design",
"defaultValue": true
},
{
"value": "Sales",
"defaultValue": false
}
],
"hostProfileCode": "optional",
"scheduleStartCodes": [
{
"service": "All",
"type": "notApplicable"
},
{
"service": "MeetingCenter",
"type": "required"
},
{
"service": "EventCenter",
"type": "optional"
},
{
"service": "TrainingCenter",
"type": "notUsed"
},
{
"service": "SupportCenter",
"type": "notUsed"
}
]
}