unicodeC / Zoom API / List registration questions
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *field_name;
const wchar_t *required;
const wchar_t *title;
const wchar_t *v_type;
int j;
int count_j;
const wchar_t *strVal;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
sbResponseBody = CkStringBuilderW_Create();
success = CkHttpW_QuickGetSb(http,L"https://api.zoom.us/v2/webinars/:webinarId/registrants/questions",sbResponseBody);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpW_getLastStatus(http);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpW_lastHeader(http));
wprintf(L"Failed.\n");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "questions": [
// {
// "field_name": "string",
// "required": "boolean"
// }
// ],
// "custom_questions": [
// {
// "title": "string",
// "type": "string",
// "required": "boolean",
// "answers": [
// "array of answer choices"
// ]
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"questions");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
field_name = CkJsonObjectW_stringOf(jResp,L"questions[i].field_name");
required = CkJsonObjectW_stringOf(jResp,L"questions[i].required");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"custom_questions");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
title = CkJsonObjectW_stringOf(jResp,L"custom_questions[i].title");
v_type = CkJsonObjectW_stringOf(jResp,L"custom_questions[i].type");
required = CkJsonObjectW_stringOf(jResp,L"custom_questions[i].required");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"custom_questions[i].answers");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
strVal = CkJsonObjectW_stringOf(jResp,L"custom_questions[i].answers[j]");
j = j + 1;
}
i = i + 1;
}
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/webinars/:webinarId/registrants/questions
Postman Collection Item JSON
{
"name": "List registration questions",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/registrants/questions",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"registrants",
"questions"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
},
"description": "Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.<br>Use this API to list registration questions and fields that are to be answered by users while registering for a Webinar.<br>\n**Prerequisites:**<br> \n* Pro or higher plan with a Webinar Add-on.\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 Registrant Question object returned",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/registrants/questions",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"registrants",
"questions"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"questions\": [\n {\n \"field_name\": \"string\",\n \"required\": \"boolean\"\n }\n ],\n \"custom_questions\": [\n {\n \"title\": \"string\",\n \"type\": \"string\",\n \"required\": \"boolean\",\n \"answers\": [\n \"array of answer choices\"\n ]\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `404`<br>Webinar not found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/registrants/questions",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"registrants",
"questions"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
