GET Playlist Template

Overview

---

The following table contains important information about the GET method in regards to receiving the playlist template.

GET Playlist Template
Method	GET
URL or Endpoint	/playlist/playlistId
Headers	Authorization
Parameters	playlistId
Body	Not Applicable

The description of the URL parameter is as follows:

playlistId URL Parameter
URL Parameter Name	playlistId
Mandatory	Yes
Type	string
Description	Unique Id of the playlist.

Request Body

The request does not contain a request body

Response

{
  "playlistId": "{playlistId}",
  "title": "{title}",
  "videos": [
    {
      "MediaID": "{mediaId}",
      "title": "{title}",
      "description": "{description}",
      "thumbnailUrl": "{thumbnailUrl}",
      "duration": 0,
      "durationString": "{durationString}",
      "hlsUrl": "{hlsUrl}",
      "shareUrl": "{shareUrl}",
      "author": "{author}",
      "publishDate": "2024-05-28T11:44:17.062Z",
      "customParameters": [
        {
          "name": "{name}",
          "value": "{value}"
        }
      ]
    }
  ]
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
playlistId	string	The id of the playlist.
title	string	The title of the playlist.
videos	array[object]	Returns the videos of the playlist as an array of objects.
MediaId	string	The id of the video.
title	string	The title of the video.
thumbnailUrl	string	The URL of the thumbnail.
duration	double	The duration of the video in seconds.
description	string	The description of the video.
durationString	string	The duration of the video formatted as a string (mm:ss).
hlsUrl	string	The HLS URL used to play the video.
shareUrl	string	The URL used to share the video.
author	string	The author of the video.
publishDate	string($date-time)	The date the video was published.
customParameters	array[object]	Custom parameters associated with the video. Returned for manual and trending playlists.

customParameters Properties

Field Name	Type	Description
name	string	The name of the custom parameter.
value	string	The value of the custom parameter.

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