DataFlex / Zoom API / Get a webinar poll
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sName
String sV_type
Boolean iAnswer_required
Integer j
Integer iCount_j
String sStrVal
String sId
String sStatus
String sTitle
Boolean iAnonymous
Integer iPoll_type
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://api.zoom.us/v2/webinars/:webinarId/polls/:pollId" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
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
Get ComStringOf Of hoJResp "id" To sId
Get ComStringOf Of hoJResp "status" To sStatus
Get ComStringOf Of hoJResp "title" To sTitle
Get ComBoolOf Of hoJResp "anonymous" To iAnonymous
Get ComIntOf Of hoJResp "poll_type" To iPoll_type
Move 0 To i
Get ComSizeOfArray Of hoJResp "questions" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "questions[i].name" To sName
Get ComStringOf Of hoJResp "questions[i].type" To sV_type
Get ComBoolOf Of hoJResp "questions[i].answer_required" To iAnswer_required
Move 0 To j
Get ComSizeOfArray Of hoJResp "questions[i].answers" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "questions[i].answers[j]" To sStrVal
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "questions[i].right_answers" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "questions[i].right_answers[j]" To sStrVal
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
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": ""
}
]
}
