Skip to main content

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
MethodGET
URL or Endpoint​/api/projects/projectId/playlists/id/videos
HeadersAuthorization
ParametersprojectId, id
BodyNot Applicable

The description of the URL parameter is as follows:

URL Parameter NameMandatoryTypeDescription
idYesstringUnique Id of the playlist.
projectIdYesstringUnique Id of the project.

Request Body

The request does not contain a request body.

Response

{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": [
{
"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 NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
MediaIdstringThe unique ID of the video.
titlestringThe title of the video.
descriptionstringThe description of the video.
thumbnailUrlstringThe URL of the thumbnail.
durationinteger($int32)Duration of the video in seconds.
durationStringstringDuration of the video in reable format.
hlsUrlstringThe HLS URL of the video.
resultInfostringReturns extra information about the result.
statusCodeinteger($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