PowerBuilder / Zoom API / Get a meeting survey
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Name
string ls_V_type
integer li_Show_as_dropdown
integer li_Answer_required
integer li_Rating_min_value
integer li_Rating_max_value
string ls_Rating_min_label
string ls_Rating_max_label
integer li_Answer_min_character
integer li_Answer_max_character
integer j
integer li_Count_j
string ls_StrVal
integer li_Anonymous
integer li_Show_in_the_browser
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://api.zoom.us/v2/meetings/:meetingId/survey",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "custom_survey": {
// "anonymous": true,
// "questions": [
// {
// "name": "Single Choice",
// "type": "single",
// "show_as_dropdown": false,
// "answer_required": false,
// "answers": [
// "option1",
// "option2",
// "option3"
// ]
// },
// {
// "name": "Multiple Choice",
// "type": "multiple",
// "answer_required": false,
// "answers": [
// "option1",
// "option2",
// "option3"
// ]
// },
// {
// "name": "Rating Scale",
// "type": "rating_scale",
// "answer_required": false,
// "rating_min_value": 0,
// "rating_max_value": 4,
// "rating_min_label": "Not likely",
// "rating_max_label": "Extremely Likely"
// },
// {
// "name": "Long Answer",
// "type": "long_answer",
// "answer_required": false,
// "answer_min_character": 1,
// "answer_max_character": 200
// }
// ]
// },
// "show_in_the_browser": true
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
li_Anonymous = loo_JResp.BoolOf("custom_survey.anonymous")
li_Show_in_the_browser = loo_JResp.BoolOf("show_in_the_browser")
i = 0
li_Count_i = loo_JResp.SizeOfArray("custom_survey.questions")
do while i < li_Count_i
loo_JResp.I = i
ls_Name = loo_JResp.StringOf("custom_survey.questions[i].name")
ls_V_type = loo_JResp.StringOf("custom_survey.questions[i].type")
li_Show_as_dropdown = loo_JResp.BoolOf("custom_survey.questions[i].show_as_dropdown")
li_Answer_required = loo_JResp.BoolOf("custom_survey.questions[i].answer_required")
li_Rating_min_value = loo_JResp.IntOf("custom_survey.questions[i].rating_min_value")
li_Rating_max_value = loo_JResp.IntOf("custom_survey.questions[i].rating_max_value")
ls_Rating_min_label = loo_JResp.StringOf("custom_survey.questions[i].rating_min_label")
ls_Rating_max_label = loo_JResp.StringOf("custom_survey.questions[i].rating_max_label")
li_Answer_min_character = loo_JResp.IntOf("custom_survey.questions[i].answer_min_character")
li_Answer_max_character = loo_JResp.IntOf("custom_survey.questions[i].answer_max_character")
j = 0
li_Count_j = loo_JResp.SizeOfArray("custom_survey.questions[i].answers")
do while j < li_Count_j
loo_JResp.J = j
ls_StrVal = loo_JResp.StringOf("custom_survey.questions[i].answers[j]")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/meetings/:meetingId/survey
Postman Collection Item JSON
{
"name": "Get a meeting survey",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/survey",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"survey"
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
},
"description": "Use this API to return information about a [meeting survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting). \n\n **Scopes:** `meeting:read`, `meeting:read:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n **Prerequisites:** \n* The host must be a **Pro** user type. \n* The [**Meeting Survey**](https://support.zoom.us/hc/en-us/articles/4404939095053-Enabling-meeting-surveys) feature enabled in the host's account. \n* The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled."
},
"response": [
{
"name": "**HTTP Status Code:** `200` <br>\n Meeting survey object returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/survey",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"survey"
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_survey\": {\n \"anonymous\": true,\n \"questions\": [\n {\n \"name\": \"Single Choice\",\n \"type\": \"single\",\n \"show_as_dropdown\": false,\n \"answer_required\": false,\n \"answers\": [\n \"option1\",\n \"option2\",\n \"option3\"\n ]\n },\n {\n \"name\": \"Multiple Choice\",\n \"type\": \"multiple\",\n \"answer_required\": false,\n \"answers\": [\n \"option1\",\n \"option2\",\n \"option3\"\n ]\n },\n {\n \"name\": \"Rating Scale\",\n \"type\": \"rating_scale\",\n \"answer_required\": false,\n \"rating_min_value\": 0,\n \"rating_max_value\": 4,\n \"rating_min_label\": \"Not likely\",\n \"rating_max_label\": \"Extremely Likely\"\n },\n {\n \"name\": \"Long Answer\",\n \"type\": \"long_answer\",\n \"answer_required\": false,\n \"answer_min_character\": 1,\n \"answer_max_character\": 200\n }\n ]\n },\n \"show_in_the_browser\": true\n}"
},
{
"name": "**HTTP Status Code:** `400` <br> Bad Request \n\n **Error Code:** `300` <br>\n Invalid meeting ID. \n\n **Error Code:** `3000` <br>\n * Cannot access Webinar information. <br>\n * Meeting survey disabled. To enable this feature, enable the \"Meeting Survey\" setti",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/survey",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"survey"
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404` <br> Not Found \n\n **Error Code:** `300` <br>\n Meeting ID does not exist. \n\n **Error Code:** `3001` <br>\n Meeting does not exist: {meetingId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/survey",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"survey"
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
