SQL Server / Zoom API / Get a webinar registrant
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'occurrence_id', 'quis officia in reprehenderit'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.zoom.us/v2/webinars/:webinarId/registrants/:registrantId', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @id nvarchar(4000)
DECLARE @email nvarchar(4000)
DECLARE @first_name nvarchar(4000)
DECLARE @last_name nvarchar(4000)
DECLARE @address nvarchar(4000)
DECLARE @city nvarchar(4000)
DECLARE @country nvarchar(4000)
DECLARE @zip nvarchar(4000)
DECLARE @state nvarchar(4000)
DECLARE @phone nvarchar(4000)
DECLARE @industry nvarchar(4000)
DECLARE @org nvarchar(4000)
DECLARE @job_title nvarchar(4000)
DECLARE @purchasing_time_frame nvarchar(4000)
DECLARE @role_in_purchase_process nvarchar(4000)
DECLARE @no_of_employees nvarchar(4000)
DECLARE @comments nvarchar(4000)
DECLARE @status nvarchar(4000)
DECLARE @create_time nvarchar(4000)
DECLARE @join_url nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @title nvarchar(4000)
DECLARE @value nvarchar(4000)
DECLARE @page_count nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @page_count OUT, 'page_count'
DECLARE @page_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @page_number OUT, 'page_number'
DECLARE @page_size nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @page_size OUT, 'page_size'
DECLARE @total_records nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @total_records OUT, 'total_records'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'registrants'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'registrants[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @email OUT, 'registrants[i].email'
EXEC sp_OAMethod @jResp, 'StringOf', @first_name OUT, 'registrants[i].first_name'
EXEC sp_OAMethod @jResp, 'StringOf', @last_name OUT, 'registrants[i].last_name'
EXEC sp_OAMethod @jResp, 'StringOf', @address OUT, 'registrants[i].address'
EXEC sp_OAMethod @jResp, 'StringOf', @city OUT, 'registrants[i].city'
EXEC sp_OAMethod @jResp, 'StringOf', @country OUT, 'registrants[i].country'
EXEC sp_OAMethod @jResp, 'StringOf', @zip OUT, 'registrants[i].zip'
EXEC sp_OAMethod @jResp, 'StringOf', @state OUT, 'registrants[i].state'
EXEC sp_OAMethod @jResp, 'StringOf', @phone OUT, 'registrants[i].phone'
EXEC sp_OAMethod @jResp, 'StringOf', @industry OUT, 'registrants[i].industry'
EXEC sp_OAMethod @jResp, 'StringOf', @org OUT, 'registrants[i].org'
EXEC sp_OAMethod @jResp, 'StringOf', @job_title OUT, 'registrants[i].job_title'
EXEC sp_OAMethod @jResp, 'StringOf', @purchasing_time_frame OUT, 'registrants[i].purchasing_time_frame'
EXEC sp_OAMethod @jResp, 'StringOf', @role_in_purchase_process OUT, 'registrants[i].role_in_purchase_process'
EXEC sp_OAMethod @jResp, 'StringOf', @no_of_employees OUT, 'registrants[i].no_of_employees'
EXEC sp_OAMethod @jResp, 'StringOf', @comments OUT, 'registrants[i].comments'
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'registrants[i].status'
EXEC sp_OAMethod @jResp, 'StringOf', @create_time OUT, 'registrants[i].create_time'
EXEC sp_OAMethod @jResp, 'StringOf', @join_url OUT, 'registrants[i].join_url'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'registrants[i].custom_questions'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @title OUT, 'registrants[i].custom_questions[j].title'
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'registrants[i].custom_questions[j].value'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
