PureBasic / Zoom API / Get a webinar poll
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.zoom.us/v2/webinars/:webinarId/polls/:pollId",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
name.s
v_type.s
answer_required.i
j.i
count_j.i
strVal.s
id.s = CkJsonObject::ckStringOf(jResp,"id")
status.s = CkJsonObject::ckStringOf(jResp,"status")
title.s = CkJsonObject::ckStringOf(jResp,"title")
anonymous.i = CkJsonObject::ckBoolOf(jResp,"anonymous")
poll_type.i = CkJsonObject::ckIntOf(jResp,"poll_type")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"questions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"questions[i].name")
v_type = CkJsonObject::ckStringOf(jResp,"questions[i].type")
answer_required = CkJsonObject::ckBoolOf(jResp,"questions[i].answer_required")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"questions[i].answers")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"questions[i].answers[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"questions[i].right_answers")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"questions[i].right_answers[j]")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
