Swift3 / Zoom API / Get a webinar registrant
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
let queryParams = CkoJsonObject()!
queryParams.update("occurrence_id", value: "quis officia in reprehenderit")
// Adds the "Authorization: Bearer <access_token>" header.
http.authToken = "<access_token>"
var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.zoom.us/v2/webinars/:webinarId/registrants/:registrantId", json: queryParams)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var id: String?
var email: String?
var first_name: String?
var last_name: String?
var address: String?
var city: String?
var country: String?
var zip: String?
var state: String?
var phone: String?
var industry: String?
var org: String?
var job_title: String?
var purchasing_time_frame: String?
var role_in_purchase_process: String?
var no_of_employees: String?
var comments: String?
var status: String?
var create_time: String?
var join_url: String?
var j: Int
var count_j: Int
var title: String?
var value: String?
var page_count: String? = jResp.string(of: "page_count")
var page_number: String? = jResp.string(of: "page_number")
var page_size: String? = jResp.string(of: "page_size")
var total_records: String? = jResp.string(of: "total_records")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "registrants").intValue
while i < count_i {
jResp.i = i
id = jResp.string(of: "registrants[i].id")
email = jResp.string(of: "registrants[i].email")
first_name = jResp.string(of: "registrants[i].first_name")
last_name = jResp.string(of: "registrants[i].last_name")
address = jResp.string(of: "registrants[i].address")
city = jResp.string(of: "registrants[i].city")
country = jResp.string(of: "registrants[i].country")
zip = jResp.string(of: "registrants[i].zip")
state = jResp.string(of: "registrants[i].state")
phone = jResp.string(of: "registrants[i].phone")
industry = jResp.string(of: "registrants[i].industry")
org = jResp.string(of: "registrants[i].org")
job_title = jResp.string(of: "registrants[i].job_title")
purchasing_time_frame = jResp.string(of: "registrants[i].purchasing_time_frame")
role_in_purchase_process = jResp.string(of: "registrants[i].role_in_purchase_process")
no_of_employees = jResp.string(of: "registrants[i].no_of_employees")
comments = jResp.string(of: "registrants[i].comments")
status = jResp.string(of: "registrants[i].status")
create_time = jResp.string(of: "registrants[i].create_time")
join_url = jResp.string(of: "registrants[i].join_url")
j = 0
count_j = jResp.size(ofArray: "registrants[i].custom_questions").intValue
while j < count_j {
jResp.j = j
title = jResp.string(of: "registrants[i].custom_questions[j].title")
value = jResp.string(of: "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": ""
}
]
}
