Chilkat Online Tools

Swift3 / Zoom API / Get a webinar survey

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://api.zoom.us/v2/webinars/:webinarId/survey", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = http.lastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.lastHeader!)")
        print("Failed.")
        return
    }

    // 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,
    //   "show_in_the_follow_up_email": false
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var name: String?
    var v_type: String?
    var show_as_dropdown: Bool
    var answer_required: Bool
    var rating_min_value: Int
    var rating_max_value: Int
    var rating_min_label: String?
    var rating_max_label: String?
    var answer_min_character: Int
    var answer_max_character: Int
    var j: Int
    var count_j: Int
    var strVal: String?

    var Anonymous: Bool = jResp.bool(of: "custom_survey.anonymous")
    var show_in_the_browser: Bool = jResp.bool(of: "show_in_the_browser")
    var show_in_the_follow_up_email: Bool = jResp.bool(of: "show_in_the_follow_up_email")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "custom_survey.questions").intValue
    while i < count_i {
        jResp.i = i
        name = jResp.string(of: "custom_survey.questions[i].name")
        v_type = jResp.string(of: "custom_survey.questions[i].type")
        show_as_dropdown = jResp.bool(of: "custom_survey.questions[i].show_as_dropdown")
        answer_required = jResp.bool(of: "custom_survey.questions[i].answer_required")
        rating_min_value = jResp.int(of: "custom_survey.questions[i].rating_min_value").intValue
        rating_max_value = jResp.int(of: "custom_survey.questions[i].rating_max_value").intValue
        rating_min_label = jResp.string(of: "custom_survey.questions[i].rating_min_label")
        rating_max_label = jResp.string(of: "custom_survey.questions[i].rating_max_label")
        answer_min_character = jResp.int(of: "custom_survey.questions[i].answer_min_character").intValue
        answer_max_character = jResp.int(of: "custom_survey.questions[i].answer_max_character").intValue
        j = 0
        count_j = jResp.size(ofArray: "custom_survey.questions[i].answers").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "custom_survey.questions[i].answers[j]")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/webinars/:webinarId/survey

Postman Collection Item JSON

{
  "name": "Get a webinar survey",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/webinars/:webinarId/survey",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "webinars",
        ":webinarId",
        "survey"
      ],
      "variable": [
        {
          "key": "webinarId",
          "value": "68423085",
          "description": "(Required) The webinar's ID."
        }
      ]
    },
    "description": "Use this API to return information about a [webinar survey](https://support.zoom.us/hc/en-us/articles/360048745651). \n\n **Scopes:** `webinar:read`, `webinar:read:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n **Prerequisites:** \n* A Pro or higher plan with the Webinar add-on. \n* The [**Webinar Survey**](https://support.zoom.us/hc/en-us/articles/360061293191-Enabling-webinar-survey) feature enabled in the host's account."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200` <br>\n Webinar survey object returned.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId/survey",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "survey"
          ],
          "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 \"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 \"show_in_the_follow_up_email\": false\n}"
    },
    {
      "name": "**HTTP Status Code:** `400` <br> Bad Request \n\n **Error Code:** `300` <br>\n Invalid webinar ID. \n\n **Error Code:** `3000` <br>\n Webinar survey disabled. To enable this feature, enable the \"Webinar Survey\" setting in the Zoom web portal's \"Settings\" interf",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId/survey",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "survey"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "68423085",
              "description": "(Required) The webinar's ID."
            }
          ]
        }
      },
      "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 Webinar ID does not exist. \n\n **Error Code:** `3001` <br>\n Webinar does not exist: {webinarId}.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId/survey",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "survey"
          ],
          "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": ""
    }
  ]
}