POST to Get Videos for a Specific Playlist

The following table contains important information about the POST method in regards to getting videos for a specific playlist.

POST to Get Videos for a Specific Playlist
Method	POST
URL or Endpoint	/api/projects/projectId/playlists/getVideos
Headers	Authorization
Parameters	projectId
Body	Check the request body below.

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "publicId": "lzxikfcg",
    "title": "Playlist 2",
    "description": null,
    "playListTypeId": 2,
    "playlistSortOptionId": 1,
    "includeTags": [],
    "excludeTags": [],
    "includeTagModeId": null,
    "excludeTagModeId": null,
    "maxVideos": null,
    "canEmbed": true,
    "includeTagMode": null,
    "excludeTagMode": null,
    "playlistType": null,
    "playlistSortOption": null
  },
  "resultInfo": null,
  "statusCode": 200
}

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.
publicId	string	The id of the playlist.
title	string	The title of the playlist.
description	string	Returns information about the playlist.
playlistTypeId	integer($int32)	The id of the playlist type.
playlistSortOptionId	integer($int32)	The id of the playlist sorting option.
includeTags	array[string]	An array that contains the tags you want to include in the playlist.
excludeTags	array[string]	An array that contains the tags you want to include in the playlist.
includeTagModeId	integer($int32)	The id of the includeTag mode.
excludeTagModeId	integer($int32)	The id of the excludeTag mode.
maxVideos	integer($int32)	The number of maximum videos in the playlist.
canEmbed	bool	A boolean that indicates whether the playlist can be embedded or not.
includeTagMode	array[Object]	Returns the includeTag mode as an array of objects.
excludeTagMode	array[Object]	Returns the excludeTag mode as an array of objects.
playlistType	array[Object]	Returns the playlist type as an array of objects.
playlistSortOption	array[Object]	Returns the palylist sort option as ana array of objects.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "MediaID": "vjsmxlol",
      "title": "Renault Clio R.S. a Toyota Yaris GRMN",
      "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
    },
    {
      "MediaID": "vjsmxloj",
      "title": " Nové BMW X5 na prvních fotkách létá vzduchem. Zvládne každý terén? \t ",
      "thumbnailUrl": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxibi/thumbnails/retina.jpg",
      "duration": 60
    },
    {
      "MediaID": "vjsmxloi",
      "title": "Dakar 2019, Peterhansel, Sainz, Despres",
      "thumbnailUrl": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxibh/thumbnails/retina.jpg",
      "duration": 204
    },
    {
      "MediaID": "vjsmxloh",
      "title": "Chrysler TV-8 (1950-1956): Obojživelný atomový brouk s pásy",
      "thumbnailUrl": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxibg/thumbnails/retina.jpg",
      "duration": 292
    },
    {
      "MediaID": "vjsmxlog",
      "title": "Hliníková karoserie nové Audi A8",
      "thumbnailUrl": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxibf/thumbnails/retina.jpg",
      "duration": 185
    },
    {
      "MediaID": "vjsmxlof",
      "title": "Škoda Vision E - elektrické otevírání dveří",
      "thumbnailUrl": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxibe/thumbnails/retina.jpg",
      "duration": 43
    },
    {
      "MediaID": "vjsmxloe",
      "title": "Citroën C5 Aircross - oficiální video k premiéře v Šanghaji",
      "thumbnailUrl": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxibd/thumbnails/retina.jpg",
      "duration": 95
    },
    {
      "MediaID": "vjsmxlod",
      "title": "Mercedes-Benz S: Představení modernizované verze",
      "thumbnailUrl": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxibc/thumbnails/retina.jpg",
      "duration": 168
    },
    {
      "MediaID": "vjsmxloc",
      "title": "Nissan Leaf, Budapest, video, prezentace, auto.cz",
      "thumbnailUrl": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxibb/thumbnails/retina.jpg",
      "duration": 41
    }
  ],
  "resultInfo": null,
  "statusCode": 200
}

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.
MediaID	string	The Id of the video.
title	string	The title of the video.
thumbnailUrl	string	The URL of the thumbnail.
duration	integer($int32)	The duration of the video in seconds.
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