GET Videos for a Specific Playlist
Overview
The following table contains important information about the GET method in regards to receiving videos of a specific playlist.
| GET Videos for Playlist | |
|---|---|
| Method | GET |
| URL or Endpoint | /api/projects/projectId/playlists/id/videos |
| Headers | Authorization |
| Parameters | projectId, id |
| Body | Not Applicable |
The description of the URL parameter is as follows:
| URL Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
id | Yes | string | Unique Id of the playlist. |
projectId | Yes | string | Unique Id of the project. |
Request Body
The request does not contain a request body.
Response
{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": [
{
"customParameters": [
{
"name": "string",
"value": "string"
}
],
"mediaId": "string",
"title": "string",
"description": "string",
"thumbnailUrl": "string",
"duration": 0,
"durationString": "string",
"hlsUrl": "string"
}
],
"resultInfo": "string",
"statusCode": 0
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful it will return true. Otherwise will return false. |
| errors | array[] | Indicates if there was an error. |
| messages | array[] | Returns the response message from back-end. |
| result | array[Object] | Returns the response object. |
| customParameters | array[Object] | Custom parameters related to the video, such as metadata. |
| name | string | The name(key) of the custom parameter. |
| value | string | The value of the custom parameter. |
| MediaId | string | The unique ID of the video. |
| title | string | The title of the video. |
| description | string | The description of the video. |
| thumbnailUrl | string | The URL of the thumbnail. |
| duration | integer($int32) | Duration of the video in seconds. |
| durationString | string | Duration of the video in reable format. |
| hlsUrl | string | The HLS URL of the video. |
| resultInfo | string | Returns extra information about the result. |
| statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed