Table of Contents
- GET /{eventId}/metadata
- GET /new/metadata
- GET /jobs
- POST /{eventId}/copy
- POST /
- DELETE /{eventId}
- POST /{eventId}/metadata
Read methods
| Method / Path: | GET /{eventId}/metadata |
|---|---|
| Description: | Get the metadata of an existing event |
| Path params: | eventId: The event id |
| Optional (query) params: | NONE |
| Response formats: | application/json |
| Status codes: |
200: OK, Metadata is available and will be returned 404: Not Found, The event doesn't exist 401: Unauthorized, The event cannot be accessed |
| Notes: |
|
| Testing: |
Sample:
/{eventId}/metadata
Testing form (click to reveal)
|
| Method / Path: | GET /new/metadata |
|---|---|
| Description: | Get the metadata of a new event |
| Path params: | NONE |
| Optional (query) params: | NONE |
| Response formats: | application/json |
| Status codes: | 200: OK, A new event's metadata |
| Notes: |
|
| Testing: |
Sample:
/new/metadata
/lti-service/new/metadata
|
| Method / Path: | GET /jobs |
|---|---|
| Description: | List recent jobs for a specific series. |
| Path params: | NONE |
| Required (form) params: | seriesId: The id of the series you want jobs for |
| Optional (query) params: | NONE |
| Response formats: | application/json |
| Status codes: | 200: OK, The list of jobs |
| Testing: |
Sample:
/jobs
Testing form (click to reveal)
|
Write methods
| Method / Path: | POST /{eventId}/copy |
|---|---|
| Description: | Copy an event to a different series |
| Path params: | eventId: The event (id) to copy |
| Required (form) params: | seriesId: The series (id) to copy into |
| Optional (form) params: | NONE |
| Status codes: |
204: No Content, The event has been copied. 404: Not Found, The specified event does not exist. |
| Testing: |
Sample:
/{eventId}/copy
Testing form (click to reveal)
|
| Method / Path: | POST / |
|---|---|
| Description: | Creates an event by sending metadata in a multipart request. |
| Path params: | NONE |
| Required (form) params: |
metadata: Event metadata
presenter: Presenter movie track |
| Optional (form) params: |
captions:
Caption file captionFormat: Caption file format captionLanguage: Caption language isPartOf: Series id of the event eventId: ID of the event to update (if it's an update) |
| Status codes: |
200: OK, A new event is created or the event is updated 401: Unauthorized, No authorization to create or update events 404: Not Found, The event to be updated wasn't found |
| Testing: |
Sample:
/
Testing form (click to reveal)
|
| Method / Path: | DELETE /{eventId} |
|---|---|
| Description: | Deletes an event. |
| Path params: | eventId: The event id |
| Optional (query) params: | NONE |
| Status codes: |
204: No Content, The event has been deleted. 404: Not Found, The specified event does not exist. |
| Testing: |
Sample:
/{eventId}
Testing form (click to reveal)
|
| Method / Path: | POST /{eventId}/metadata |
|---|---|
| Description: | Set the metadata of an existing event |
| Path params: | eventId: The event id |
| Required (form) params: | metadataJson: Event metadata |
| Optional (form) params: | NONE |
| Response formats: | application/json |
| Status codes: |
200: OK, The event's metadata has been set 404: Not Found, The event doesn't exist 401: Unauthorized, The event cannot be accessed |
| Testing: |
Sample:
/{eventId}/metadata
Testing form (click to reveal)
|