Chilkat Online Tools

C++ / Zoom API / Get a webinar registrant

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

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

    CkHttp http;
    bool success;

    CkJsonObject queryParams;
    queryParams.UpdateString("occurrence_id","quis officia in reprehenderit");

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");

    CkHttpResponse *resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/webinars/:webinarId/registrants/:registrantId",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "page_count": "1",
    //   "page_number": "1",
    //   "page_size": "30",
    //   "total_records": "1",
    //   "registrants": [
    //     {
    //       "id": "24000002122",
    //       "email": "example@example.com",
    //       "first_name": "Jill",
    //       "last_name": "Chill",
    //       "address": "1800 Amphibious Blvd.",
    //       "city": "Mountain View",
    //       "country": "US",
    //       "zip": "94045",
    //       "state": "CA",
    //       "phone": "5550100",
    //       "industry": "Food",
    //       "org": "Cooking Org",
    //       "job_title": "Chef",
    //       "purchasing_time_frame": "1-3 months",
    //       "role_in_purchase_process": "Influencer",
    //       "no_of_employees": "10",
    //       "comments": "Looking forward to the Webinar",
    //       "custom_questions": [
    //         {
    //           "title": "What do you hope to learn from this Webinar?",
    //           "value": "Look forward to learning how you come up with new recipes and what other services you offer."
    //         }
    //       ],
    //       "status": "approved",
    //       "create_time": "2019-02-26T23:01:16.899Z",
    //       "join_url": "https://zoom.us/webinar/mywebinarissocooldighdghodghodg"
    //     }
    //   ]
    // }

    // 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.

    const char *id = 0;
    const char *email = 0;
    const char *first_name = 0;
    const char *last_name = 0;
    const char *address = 0;
    const char *city = 0;
    const char *country = 0;
    const char *zip = 0;
    const char *state = 0;
    const char *phone = 0;
    const char *industry = 0;
    const char *org = 0;
    const char *job_title = 0;
    const char *purchasing_time_frame = 0;
    const char *role_in_purchase_process = 0;
    const char *no_of_employees = 0;
    const char *comments = 0;
    const char *status = 0;
    const char *create_time = 0;
    const char *join_url = 0;
    int j;
    int count_j;
    const char *title = 0;
    const char *value = 0;

    const char *page_count = jResp.stringOf("page_count");
    const char *page_number = jResp.stringOf("page_number");
    const char *page_size = jResp.stringOf("page_size");
    const char *total_records = jResp.stringOf("total_records");
    int i = 0;
    int count_i = jResp.SizeOfArray("registrants");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("registrants[i].id");
        email = jResp.stringOf("registrants[i].email");
        first_name = jResp.stringOf("registrants[i].first_name");
        last_name = jResp.stringOf("registrants[i].last_name");
        address = jResp.stringOf("registrants[i].address");
        city = jResp.stringOf("registrants[i].city");
        country = jResp.stringOf("registrants[i].country");
        zip = jResp.stringOf("registrants[i].zip");
        state = jResp.stringOf("registrants[i].state");
        phone = jResp.stringOf("registrants[i].phone");
        industry = jResp.stringOf("registrants[i].industry");
        org = jResp.stringOf("registrants[i].org");
        job_title = jResp.stringOf("registrants[i].job_title");
        purchasing_time_frame = jResp.stringOf("registrants[i].purchasing_time_frame");
        role_in_purchase_process = jResp.stringOf("registrants[i].role_in_purchase_process");
        no_of_employees = jResp.stringOf("registrants[i].no_of_employees");
        comments = jResp.stringOf("registrants[i].comments");
        status = jResp.stringOf("registrants[i].status");
        create_time = jResp.stringOf("registrants[i].create_time");
        join_url = jResp.stringOf("registrants[i].join_url");
        j = 0;
        count_j = jResp.SizeOfArray("registrants[i].custom_questions");
        while (j < count_j) {
            jResp.put_J(j);
            title = jResp.stringOf("registrants[i].custom_questions[j].title");
            value = jResp.stringOf("registrants[i].custom_questions[j].value");
            j = j + 1;
        }

        i = i + 1;
    }
    }

Curl Command

curl -G -d "occurrence_id=quis%20officia%20in%20reprehenderit"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/webinars/:webinarId/registrants/:registrantId

Postman Collection Item JSON

{
  "name": "Get a webinar registrant",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/webinars/:webinarId/registrants/:registrantId?occurrence_id=quis officia in reprehenderit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "webinars",
        ":webinarId",
        "registrants",
        ":registrantId"
      ],
      "query": [
        {
          "key": "occurrence_id",
          "value": "quis officia in reprehenderit",
          "description": "The meeting or webinar occurrence ID."
        }
      ],
      "variable": [
        {
          "key": "webinarId",
          "value": "68423085",
          "description": "(Required) The webinar's ID."
        },
        {
          "key": "registrantId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The registrant ID."
        }
      ]
    },
    "description": "Zoom users with a [Webinar Plan](https://zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. 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 before receiving the link to join the Webinar.<br>Use this API to get details on a specific user who has registered for the Webinar.<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**Prerequisites:**<br>\n* The account must have a Webinar plan."
  },
  "response": [
    {
      "name": "Success.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId/registrants/:registrantId?occurrence_id=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "registrants",
            ":registrantId"
          ],
          "query": [
            {
              "key": "occurrence_id",
              "value": "quis officia in reprehenderit"
            }
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "68423085",
              "description": "(Required) The webinar's ID."
            },
            {
              "key": "registrantId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The registrant ID."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"page_count\": \"1\",\n \"page_number\": \"1\",\n \"page_size\": \"30\",\n \"total_records\": \"1\",\n \"registrants\": [\n  {\n   \"id\": \"24000002122\",\n   \"email\": \"example@example.com\",\n   \"first_name\": \"Jill\",\n   \"last_name\": \"Chill\",\n   \"address\": \"1800 Amphibious Blvd.\",\n   \"city\": \"Mountain View\",\n   \"country\": \"US\",\n   \"zip\": \"94045\",\n   \"state\": \"CA\",\n   \"phone\": \"5550100\",\n   \"industry\": \"Food\",\n   \"org\": \"Cooking Org\",\n   \"job_title\": \"Chef\",\n   \"purchasing_time_frame\": \"1-3 months\",\n   \"role_in_purchase_process\": \"Influencer\",\n   \"no_of_employees\": \"10\",\n   \"comments\": \"Looking forward to the Webinar\",\n   \"custom_questions\": [\n    {\n     \"title\": \"What do you hope to learn from this Webinar?\",\n     \"value\": \"Look forward to learning how you come up with new recipes and what other services you offer.\"\n    }\n   ],\n   \"status\": \"approved\",\n   \"create_time\": \"2019-02-26T23:01:16.899Z\",\n   \"join_url\": \"https://zoom.us/webinar/mywebinarissocooldighdghodghodg\"\n  }\n ]\n}"
    },
    {
      "name": "Invalid webinar ID.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId/registrants/:registrantId?occurrence_id=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "registrants",
            ":registrantId"
          ],
          "query": [
            {
              "key": "occurrence_id",
              "value": "quis officia in reprehenderit"
            }
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "68423085",
              "description": "(Required) The webinar's ID."
            },
            {
              "key": "registrantId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The registrant ID."
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `400`<br>\nBad request<br>\n**Error Code:** `1010`<br>\nUser does not belong to this account:{accountId}.<br>",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId/registrants/:registrantId?occurrence_id=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "registrants",
            ":registrantId"
          ],
          "query": [
            {
              "key": "occurrence_id",
              "value": "quis officia in reprehenderit"
            }
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "68423085",
              "description": "(Required) The webinar's ID."
            },
            {
              "key": "registrantId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The registrant 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:** `1001`<br>\nUser {userId} does not exist or does not belong to this account.<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/registrants/:registrantId?occurrence_id=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "registrants",
            ":registrantId"
          ],
          "query": [
            {
              "key": "occurrence_id",
              "value": "quis officia in reprehenderit"
            }
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "68423085",
              "description": "(Required) The webinar's ID."
            },
            {
              "key": "registrantId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The registrant ID."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}