GET All Select Options

Overview

---

The following table contains important information about the GET method in regards to receiving all the select options.

GET All Select Options
Method	GET
URL or Endpoint	/api/projects/projectId/playlists/select-options
Headers	Authorization
Parameters	projectId
Body	Not Applicable

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

The request does not contain a request body

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": {
    "success": true,
    "errors": [
      "string"
    ],
    "messages": [
      "string"
    ],
    "result": {
      "playlistTypeOptions": [
        {
          "id": 0,
          "name": "string",
          "value": "string",
          "description": "string"
        }
      ],
      "playlistSortOptions": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "tagModeOptions": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "playlistDisplayTypeOptions": [
        {
          "id": "string",
          "name": "string",
          "value": "string"
        }
      ]
    },
    "resultInfo": "string",
    "statusCode": 0
  },
  "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.
playlistTypeOptions	array[Object]	Returns the playlist types as an array of objects.
id	integer($int32)	The id of the the playlist type.
name	string	The name of the playlist type. It can either be "Manual" or "Dynamic".
value	string	The value of the playlist type. It can either be "MANUAL" or "DYNAMIC".
description	string	The description of the playlist type.
playlistSortOptions	array[Object]	Returns the playlist sorting options as an array of objects.
id	integer($int32)	The id of the playlist sorting option.
name	string	The name of the playlist sorting option. It can be "Most Recently Published", "Older First", "Title A-Z", or "Title Z-A". These options are linked each to their IDs, which go from 1 to 4 respectively.
tagModeOptions	array[Object]	Returns the tag mode options as an array of objects.
id	integer($int32)	The id of the the tag mode.
name	string	The name of the tag mode. It can be "All" or "Any". These are linked to their IDs, 1 and 2 respectively.
playlistDisplayTypeOptions	array[Object]	Returns the playlist display types as an array of objects.
id	integer($int32)	The id of the the playlist display type.
name	string	The name of the playlist display type
value	string	The value of the playlist display type.
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