TCL / Zoom API / Get a tracking field
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://api.zoom.us/v2/tracking_fields/:fieldId" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "id": "fdfgdfgr23gr1",
# "field": "Meeting Purpose",
# "required": true,
# "visible": false,
# "recommended_values": [
# "Support",
# "Onboarding",
# "Sales",
# "Other"
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set id [CkJsonObject_stringOf $jResp "id"]
set field [CkJsonObject_stringOf $jResp "field"]
set required [CkJsonObject_BoolOf $jResp "required"]
set visible [CkJsonObject_BoolOf $jResp "visible"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "recommended_values"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "recommended_values[i]"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/tracking_fields/:fieldId
Postman Collection Item JSON
{
"name": "Get a tracking field",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/tracking_fields/:fieldId",
"host": [
"{{baseUrl}}"
],
"path": [
"tracking_fields",
":fieldId"
],
"variable": [
{
"key": "fieldId",
"value": "quis officia in reprehenderit",
"description": "(Required) The Tracking Field ID"
}
]
},
"description": "Use this API to return information about a [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields). \n\n**Scopes:** `tracking_fields:read:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n**Prerequisites:** \n* A Business, Education, API or higher plan."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nTracking Field object returned",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/tracking_fields/:fieldId",
"host": [
"{{baseUrl}}"
],
"path": [
"tracking_fields",
":fieldId"
],
"variable": [
{
"key": "fieldId",
"value": "quis officia in reprehenderit",
"description": "(Required) The Tracking Field ID"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"fdfgdfgr23gr1\",\n \"field\": \"Meeting Purpose\",\n \"required\": true,\n \"visible\": false,\n \"recommended_values\": [\n \"Support\",\n \"Onboarding\",\n \"Sales\",\n \"Other\"\n ]\n}"
},
{
"name": "**HTTP Status Code:** `404`<br>\nTracking Field not found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/tracking_fields/:fieldId",
"host": [
"{{baseUrl}}"
],
"path": [
"tracking_fields",
":fieldId"
],
"variable": [
{
"key": "fieldId",
"value": "quis officia in reprehenderit",
"description": "(Required) The Tracking Field ID"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}