Chilkat Online Tools

delphiDll / Zoom API / Get a tracking field

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
strVal: PWideChar;
id: PWideChar;
field: PWideChar;
required: Boolean;
visible: Boolean;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://api.zoom.us/v2/tracking_fields/:fieldId',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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

id := CkJsonObject__stringOf(jResp,'id');
field := CkJsonObject__stringOf(jResp,'field');
required := CkJsonObject_BoolOf(jResp,'required');
visible := CkJsonObject_BoolOf(jResp,'visible');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'recommended_values');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    strVal := CkJsonObject__stringOf(jResp,'recommended_values[i]');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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": ""
    }
  ]
}