Chilkat Online Tools

delphiDll / Zoom API / Get a webinar poll

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
name: PWideChar;
v_type: PWideChar;
answer_required: Boolean;
j: Integer;
count_j: Integer;
strVal: PWideChar;
id: PWideChar;
status: PWideChar;
title: PWideChar;
anonymous: Boolean;
poll_type: Integer;
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/webinars/:webinarId/polls/:pollId',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": "cdjfhdsdfd",
//   "status": "ended",
//   "title": "Learn something new",
//   "anonymous": false,
//   "poll_type": 2,
//   "questions": [
//     {
//       "name": "How are you?",
//       "type": "multiple",
//       "answer_required": false,
//       "answers": [
//         "Good",
//         "Not so good"
//       ],
//       "right_answers": [
//         "Good"
//       ]
//     }
//   ]
// }

// 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');
status := CkJsonObject__stringOf(jResp,'status');
title := CkJsonObject__stringOf(jResp,'title');
anonymous := CkJsonObject_BoolOf(jResp,'anonymous');
poll_type := CkJsonObject_IntOf(jResp,'poll_type');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'questions');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    name := CkJsonObject__stringOf(jResp,'questions[i].name');
    v_type := CkJsonObject__stringOf(jResp,'questions[i].type');
    answer_required := CkJsonObject_BoolOf(jResp,'questions[i].answer_required');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'questions[i].answers');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        strVal := CkJsonObject__stringOf(jResp,'questions[i].answers[j]');
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'questions[i].right_answers');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        strVal := CkJsonObject__stringOf(jResp,'questions[i].right_answers[j]');
        j := j + 1;
      end;

    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/webinars/:webinarId/polls/:pollId

Postman Collection Item JSON

{
  "name": "Get a webinar poll",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/webinars/:webinarId/polls/:pollId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "webinars",
        ":webinarId",
        "polls",
        ":pollId"
      ],
      "variable": [
        {
          "key": "webinarId",
          "value": "68423085",
          "description": "(Required) The webinar's ID."
        },
        {
          "key": "pollId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The poll ID"
        }
      ]
    },
    "description": "Get a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) details.<br><br>\n**Scopes:** `webinar:read:admin` `webinar:read`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`<br>\n\n"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nWebinar Poll object returned",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId/polls/:pollId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "polls",
            ":pollId"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "68423085",
              "description": "(Required) The webinar's ID."
            },
            {
              "key": "pollId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The poll ID"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": \"cdjfhdsdfd\",\n \"status\": \"ended\",\n \"title\": \"Learn something new\",\n \"anonymous\": false,\n \"poll_type\": 2,\n \"questions\": [\n  {\n   \"name\": \"How are you?\",\n   \"type\": \"multiple\",\n   \"answer_required\": false,\n   \"answers\": [\n    \"Good\",\n    \"Not so good\"\n   ],\n   \"right_answers\": [\n    \"Good\"\n   ]\n  }\n ]\n}"
    },
    {
      "name": "**HTTP Status Code:** `400` **Bad Request** <br>\n **Error Code:** `4400` <br> Webinar polls disabled. To enable this feature, enable the \"Webinar Polls/Quizzes\" setting in the Zoom web portal's \"Settings\" interface.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId/polls/:pollId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "polls",
            ":pollId"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "68423085",
              "description": "(Required) The webinar's ID."
            },
            {
              "key": "pollId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The poll ID"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404`<br>\nWebinar not found.<br>\n**Error Code:** `3001`<br>\nWebinar {webinarId} not found or has expired.<br>",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId/polls/:pollId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "polls",
            ":pollId"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "68423085",
              "description": "(Required) The webinar's ID."
            },
            {
              "key": "pollId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The poll ID"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}