GET Playlist by PublicId

Overview

---

The following table contains important information about the GET method in regards to receiving the playlist by using the public ID.

GET Playlist by PublicId
Method	GET
URL or Endpoint	/api/projects/projectId/playlists/id
Headers	Authorization
Parameters	id, projectId, api-version
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
id	Yes	string	Unique Id of the playlist.
projectId	No	string	Unique Id of the project.
api-version	No	string	Correct api-version.

Request Body

The request does not contain a request body

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": {
    "publicId": "string",
    "title": "string",
    "description": "string",
    "playListPagePermalink": "string",
    "playListTypeId": 0,
    "playlistSortOptionId": 0,
    "includeTags": [
      "string"
    ],
    "excludeTags": [
      "string"
    ],
    "includeTagsState": true,
    "excludeTagsState": true,
    "folders": [
      0
    ],
    "excludeFlags": [
      0
    ],
    "includeFlags": [
      0
    ],
    "excludeFlagsState": true,
    "includeFlagsState": true,
    "includeTagModeId": 0,
    "excludeTagModeId": 0,
    "maxVideos": 0,
    "canEmbed": true,
    "includeTagMode": {
      "id": 0,
      "name": "string"
    },
    "excludeTagMode": {
      "id": 0,
      "name": "string"
    },
    "playlistType": {
      "id": 0,
      "name": "string",
      "value": "string",
      "description": "string"
    },
    "playlistSortOption": {
      "id": 0,
      "name": "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.
publicId	string	The id of the playlist.
title	string	The title of the playlist.
description	string	Returns information about the playlist.
playListPagePermalink	integer($int32)	The permalink of the playlist page.
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 exclude in the playlist.
includeTagsState	bool	Indicates whether the tags state is included.
excludeTagsState	bool	Indicates whether the tags state is excluded.
includeFlags	array[string]	An array that contains the flags you want to include in the playlist.
excludeFlags	array[string]	An array that contains the flags you want to exclude in the playlist.
includeFlagsState	bool	Indicates whether the flags state is included.
excludeFlagsState	bool	Indicates whether the flags state is excluded.
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.
id	string	The Id of the tag mode.
name	string	The name of the tag mode.
excludeTagMode	array[Object]	Returns the excludeTag mode as an array of objects.
id	integer($int32)	The Id of the tag mode.
name	string	The name of the tag mode.
playlistType	array[Object]	Returns the playlist type as an array of objects.
id	integer($int32)	The Id of the playlist type.
name	string	The name of the playlist type.
value	string	The value of the playlist type.
description	string	The description of the playlist type.
playlistSortOption	array[Object]	Returns the palylist sort option as ana array of objects.
id	integer($int32)	The Id of the playlist sort option.
name	string	The name of the playlist sort option.
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