SQL Server / Zoom API / Create a tracking field
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @req int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.HttpRequest', @req OUT
EXEC sp_OASetProperty @req, 'HttpVerb', 'POST'
EXEC sp_OASetProperty @req, 'Path', '/v2/tracking_fields'
EXEC sp_OASetProperty @req, 'ContentType', 'multipart/form-data'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'field', 'anim incididunt qui ea'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'required', 'anim incididunt qui eatrue'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'visible', 'anim incididunt qui eatruetrue'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'recommended_values', 'anim incididunt qui eatruetrue["occaecat consectetur dolor","est"]'
EXEC sp_OAMethod @req, 'AddHeader', NULL, 'Authorization', 'Bearer <access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'SynchronousRequest', @resp OUT, 'api.zoom.us', 443, 1, @req
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @strVal nvarchar(4000)
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @field nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @field OUT, 'field'
DECLARE @required int
EXEC sp_OAMethod @jResp, 'BoolOf', @required OUT, 'required'
DECLARE @visible int
EXEC sp_OAMethod @jResp, 'BoolOf', @visible OUT, 'visible'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'recommended_values'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'recommended_values[i]'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
