PureBasic / Zoom API / Create a tracking field
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttpRequest.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
req.i = CkHttpRequest::ckCreate()
If req.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpRequest::setCkHttpVerb(req, "POST")
CkHttpRequest::setCkPath(req, "/v2/tracking_fields")
CkHttpRequest::setCkContentType(req, "multipart/form-data")
CkHttpRequest::ckAddParam(req,"field","anim incididunt qui ea")
CkHttpRequest::ckAddParam(req,"required","anim incididunt qui eatrue")
CkHttpRequest::ckAddParam(req,"visible","anim incididunt qui eatruetrue")
CkHttpRequest::ckAddParam(req,"recommended_values","anim incididunt qui eatruetrue[" + Chr(34) + "occaecat consectetur dolor" + Chr(34) + "," + Chr(34) + "est" + Chr(34) + "]")
CkHttpRequest::ckAddHeader(req,"Authorization","Bearer <access_token>")
resp.i = CkHttp::ckSynchronousRequest(http,"api.zoom.us",443,1,req)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "id": "s",
; "field": "quis dolore",
; "required": false,
; "visible": true,
; "recommended_values": [
; "commodo",
; "Lorem cillum ea veniam sed"
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
strVal.s
id.s = CkJsonObject::ckStringOf(jResp,"id")
field.s = CkJsonObject::ckStringOf(jResp,"field")
required.i = CkJsonObject::ckBoolOf(jResp,"required")
visible.i = CkJsonObject::ckBoolOf(jResp,"visible")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"recommended_values")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"recommended_values[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'field=anim incididunt qui ea'
--form 'required=anim incididunt qui eatrue'
--form 'visible=anim incididunt qui eatruetrue'
--form 'recommended_values=anim incididunt qui eatruetrue["occaecat consectetur dolor","est"]'
https://api.zoom.us/v2/tracking_fields
Postman Collection Item JSON
{
"name": "Create a tracking field",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "field",
"value": "anim incididunt qui ea",
"description": "Label/ Name for the tracking field.",
"type": "text"
},
{
"key": "required",
"value": "true",
"description": "Tracking Field Required",
"type": "text"
},
{
"key": "visible",
"value": "true",
"description": "Tracking Field Visible",
"type": "text"
},
{
"key": "recommended_values",
"value": "[\"occaecat consectetur dolor\",\"est\"]",
"description": "Array of recommended values",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/tracking_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"tracking_fields"
]
},
"description": "Use this API to create a new [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields). Tracking fields let you analyze usage by various fields within an organization. When scheduling a meeting, tracking fields will be included in the meeting options. \n\n**Scope:** `tracking_fields:write: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:** `201`<br>\nTracking Field created",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "field",
"value": "dolore adipisicing",
"description": "Label/ Name for the tracking field.",
"type": "text"
},
{
"key": "required",
"value": "false",
"description": "Tracking Field Required",
"type": "text"
},
{
"key": "visible",
"value": "false",
"description": "Tracking Field Visible",
"type": "text"
},
{
"key": "recommended_values",
"value": "[\"labore\",\"Duis qui\"]",
"description": "Array of recommended values",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/tracking_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"tracking_fields"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Location",
"value": "quis officia in reprehenderit",
"description": "Location of created tracking field"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"s\",\n \"field\": \"quis dolore\",\n \"required\": false,\n \"visible\": true,\n \"recommended_values\": [\n \"commodo\",\n \"Lorem cillum ea veniam sed\"\n ]\n}"
}
]
}
