Skip to main content

GET Playlist Template

Overview


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

GET Playlist Template
MethodGET
URL or Endpoint/playlist/playlistId
HeadersAuthorization
ParametersplaylistId
BodyNot Applicable

The description of the URL parameter is as follows:

playlistId URL Parameter
URL Parameter NameplaylistId
MandatoryYes
Typestring
DescriptionUnique Id of the playlist.

Request Body

The request does not contain a request body

Response

{
"playlistId": "lzxikfcr",
"title": "untitled playlist 6666666",
"videos": [
{
"MediaID": "vjsmxlol",
"title": "Renault Clio R.S. a Toyota Yaris GRMN -u",
"thumbnailUrl": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxibk/thumbnails/retina.jpg",
"duration": 343
},
{
"MediaID": "vjsmxlok",
"title": "Škoda Fabia s milionem kilometrů: Historie auta",
"thumbnailUrl": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxibj/thumbnails/retina.jpg",
"duration": 202
}
]
}

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

Field NameTypeDescription
playlistIdstringThe id of the playlist.
titlestringThe title of the playlist.
videosarray[Object]Returns the videos of the playlist as an array of objects.
MediaIdstringThe id of the video.
titlestringThe title of the video.
thumbnailUrlstringThe URL of the thumbnail.
durationinteger($int32)The duration of the video in seconds.

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