Get registration gate data of a virtual event

GET /channels/{channelId}/virtual-events/{eventId}/gate.json
Copy to clipboard

Success response

Upon success, a response with HTTP status “200 OK” is returned with the following key-value pairs inside the gate root object.

KEY	TYPE	DESCRIPTION
`enabled`	boolean	Registration gate is enabled/disabled

Example of a success response:

{
  "gate": {
    "enabled": true
  }
}
Copy to clipboard

Error responses

Possible error responses:

HTTP RESPONSE CODE	ERROR VALUE	ERROR CONDITIONS
401 Unauthorized	`invalid_token`	The provided access token is missing, revoked, expired or malformed
402 Payment Required	`invalid_request`	The feature is not enabled for the user
403 Forbidden	`lack_of_ownership`	The API user is not allowed to manage the given channel or event
404 Not Found	`not_found`	Channel or event not found
500 Server Error	`server_error`	An error occurred
503 Service Unavailable		There is a temporary error on the server which makes it impossible to serve the request

Update registration gate data of a virtual event

PUT /channels/{channelId}/virtual-events/{eventId}/gate.json
Copy to clipboard

Parameters

PARAMETER	TYPE	IMPORTANCE	DESCRIPTION
`enable`	string	REQUIRED	`true` or `false`

The Content-Type of the request should be application/x-www-form-urlencoded.

Example of the request:

PUT /channels/123/virtual-events/100/gate.json HTTP/1.1
Host: api.video.ibm.com
Authorization: Bearer 3c2573673b782f6544405a22636f3d5d3b6f3950
Content-Type: application/x-www-form-urlencoded

enable=false
Copy to clipboard

Success response

Upon success, a response with HTTP status “204 No Content” is returned.

Error responses

Possible error responses:

HTTP RESPONSE CODE	ERROR VALUE	ERROR CONDITIONS
400 Bad Request	`bad_request`	Invalid value was supplied
401 Unauthorized	`invalid_token`	The provided access token is missing, revoked, expired or malformed
402 Payment Required	`invalid_request`	The feature is not enabled for the user
403 Forbidden	`lack_of_ownership`	The API user is not allowed to manage the given channel or event
404 Not Found	`not_found`	Channel or event not found
500 Server Error	`server_error`	An error occurred
503 Service Unavailable		There is a temporary error on the server which makes it impossible to serve the request

Get registration form publish status of a virtual event

GET /channels/{channelId}/virtual-events/{eventId}/form.json
Copy to clipboard

Success response

Upon success, a response with HTTP status “200 OK” is returned with the following key-value pairs inside the form root object.

KEY	TYPE	DESCRIPTION
`published`	boolean	Registration form is published or unpublished

Example of a success response:

{
  "form": {
    "published": true
  }
}
Copy to clipboard

Error responses

Possible error responses:

HTTP RESPONSE CODE	ERROR VALUE	ERROR CONDITIONS
401 Unauthorized	`invalid_token`	The provided access token is missing, revoked, expired or malformed
402 Payment Required	`invalid_request`	The feature is not enabled for the user
403 Forbidden	`lack_of_ownership`	The API user is not allowed to manage the given channel or event
404 Not Found	`not_found`	Channel or event not found
500 Server Error	`server_error`	An error occurred
503 Service Unavailable		There is a temporary error on the server which makes it impossible to serve the request

Get calendar data for an event

GET /channels/{channelId}/virtual-events/{eventId}/calendar.json
Copy to clipboard

Success response

Upon success, a response with HTTP status “200 OK” is returned with the following key-value pairs inside the calendar root object.

KEY	TYPE	DESCRIPTION
`ics`	string	String representation of the .ics file data

Example of a success response:

{
  "calendar": {
    "ics": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:icalendar-ruby\r\nCALSCALE:GREGORIAN\r\nMETHOD:PUBLISH\r\nBEGIN:VEVENT\r\nDTSTAMP:20201010T1010Z\r\nUID:8df6cc2f-75a0-456b-a067-55b42fabc9e8\r\nDTSTART;TZID=Europe/Budapest:20201010T101010\r\nDTEND;TZID=Europe/Budapest:20201011T10110\r\nDESCRIPTION:Event\r\nLOCATION:https://secure.video.ibm.com/channel/123/event/100\r\nSUMMARY:Event\r\nURL:https://secure.video.ibm.com/channel/123/event/100\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
  }
}
Copy to clipboard

Error responses

Possible error responses:

HTTP RESPONSE CODE	ERROR VALUE	ERROR CONDITIONS
401 Unauthorized	`invalid_token`	The provided access token is missing, revoked, expired or malformed
402 Payment Required	`invalid_request`	The feature is not enabled for the user
403 Forbidden	`lack_of_ownership`	The API user is not allowed to manage the given channel or event
404 Not Found	`not_found`	Channel or event not found
500 Server Error	`server_error`	An error occurred
503 Service Unavailable		There is a temporary error on the server which makes it impossible to serve the request

Edit this page on GitHub

Virtual Events: Basics

Virtual Events: CSV Export

Virtual Events Registration

Get registration gate data of a virtual event

Success response

Error responses

Update registration gate data of a virtual event

Parameters

Success response

Error responses

Get registration form publish status of a virtual event

Success response

Error responses

Get calendar data for an event

Success response

Error responses