Manage Webcast Files
This section contains APIs associated with files associated with or linked to a Webcast. Standard RESTful API routes generally apply for each type of file.
Background Images
This set of APIs uploads and deletes background images on Webcast events.
Upload a Background Image
This API uploads a background image to a Webcast event. Note that when you upload a background image Rev will always scale it to fit the various screen sizes. When a background image is returned in a subsequent call, the available scale sizes available will also be returned.
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| eventId | string | GUID of the Webcast event to upload the background image to. | Yes |
| image file | formData | FileName = string with file name and extension that you may include as a background image type. Accepted types include jpg, png, and gif.You must provide Content-Type Header for each file type you upload. | Yes |
Response Codes
| Code | Description |
|---|---|
| 200 | ok |
| 401 | Unauthorized error |
| 500 | Internal server error |
Delete a Background Image
This API deletes a previously uploaded background image from a Webcast event.
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| eventId | string | GUID of the Webcast event to delete the associated background image. | Yes |
Response Codes
| Code | Description |
|---|---|
| 200 | ok |
| 401 | Unauthorized error |
| 500 | Internal server error |
PowerPoint Presentation Files
This set of APIs uploads, edits, gets, and deletes PowerPoint Presentation files associated with Webcast event.
Upload a Presentation File
This API uploads a presentation file to an event. Presentation files accepted include .ppt and .pptx. Content-Type headers must be provided for the uploaded files.
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| eventId | string | GUID of the Webcast event to upload the presentation file to. | Yes |
| presentation file | formData | FileName = string with file name and extension that you may include as a presentation. Accepted types include .ppt and .pptx.You must provide Content-Type Header for each file type you upload. | Yes |
Response Codes
| Code | Description |
|---|---|
| 200 | ok |
| 401 | Unauthorized error |
| 500 | Internal server error |
Edit a Presentation File
This API edits a previously uploaded presentation file.
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| eventId | string | GUID of the Webcast event to edit the presentation file upload. | Yes |
| presentation file | formData | FileName = string with file name and extension that you may include as a presentation. Accepted types include .ppt and .pptx.You must provide Content-Type Header for each file type you upload. | Yes |
Response Codes
| Code | Description |
|---|---|
| 200 | ok |
| 401 | Unauthorized error |
| 500 | Internal server error |
Get a Presentation File
This API returns the currently uploaded Presentation file deck.
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| eventId | string | GUID of the Webcast event to get the current presentation file. | Yes |
Response Codes
| Code | Description |
|---|---|
| 200 | ok |
| 401 | Unauthorized error |
| 500 | Internal server error |
Delete a Presentation File
This API deletes the current Presentation file associated with a Webcast event.
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| eventId | string | GUID of the Webcast event to delete the associated Presentation file. | Yes |
Response Codes
| Code | Description |
|---|---|
| 200 | ok |
| 401 | Unauthorized error |
| 500 | Internal server error |
- Background Images
-
Background Images
This set of APIs uploads and deletes background images on Webcast events.
Upload a Background Image
This API uploads a background image to a Webcast event. Note that when you upload a background image Rev will always scale it to fit the various screen sizes. When a background image is returned in a subsequent call, the available scale sizes available will also be returned.
POST/api/uploads/background-image/{eventId}Request Parameters
Name Type Description Required eventId string GUID of the Webcast event to upload the background image to. Yes image file formData FileName = string with file name and extension that you may include as a background image type. Accepted types include jpg, png, and gif.You must provide Content-Type Header for each file type you upload. Yes Response Codes
Code Description 200 ok 401 Unauthorized error 500 Internal server error Delete a Background Image
This API deletes a previously uploaded background image from a Webcast event.
DELETE/api/v2/scheduled-events/{eventId}/background-imageRequest Parameters
Name Type Description Required eventId string GUID of the Webcast event to delete the associated background image. Yes Response Codes
Code Description 200 ok 401 Unauthorized error 500 Internal server error - PowerPoint Presentations
-
PowerPoint Presentation Files
This set of APIs uploads, edits, gets, and deletes PowerPoint Presentation files associated with Webcast event.
Upload a Presentation File
This API uploads a presentation file to an event. Presentation files accepted include .ppt and .pptx. Content-Type headers must be provided for the uploaded files.
POST/api/uploads/presentation/{eventId}Request Parameters
Name Type Description Required eventId string GUID of the Webcast event to upload the presentation file to. Yes presentation file formData FileName = string with file name and extension that you may include as a presentation. Accepted types include .ppt and .pptx.You must provide Content-Type Header for each file type you upload. Yes Response Codes
Code Description 200 ok 401 Unauthorized error 500 Internal server error Edit a Presentation File
This API edits a previously uploaded presentation file.
PUT/api/uploads/presentation/{eventId}Request Parameters
Name Type Description Required eventId string GUID of the Webcast event to edit the presentation file upload. Yes presentation file formData FileName = string with file name and extension that you may include as a presentation. Accepted types include .ppt and .pptx.You must provide Content-Type Header for each file type you upload. Yes Response Codes
Code Description 200 ok 401 Unauthorized error 500 Internal server error Get a Presentation File
This API returns the currently uploaded Presentation file deck.
GET/api/v2/scheduled-events/{eventId}/presentationRequest Parameters
Name Type Description Required eventId string GUID of the Webcast event to get the current presentation file. Yes Response Codes
Code Description 200 ok 401 Unauthorized error 500 Internal server error Delete a Presentation File
This API deletes the current Presentation file associated with a Webcast event.
DELETE/api/v2/scheduled-events/{eventId}/presentationRequest Parameters
Name Type Description Required eventId string GUID of the Webcast event to delete the associated Presentation file. Yes Response Codes
Code Description 200 ok 401 Unauthorized error 500 Internal server error