GET Encoding Priorities

Overview

---

The following table contains important information about the GET method used to retrieve all possible encoding priorities as a select list.

GET Encoding Priorities
Method	GET
URL or Endpoint	/api/encoding-priorities/select-list
Headers	Authorization
Parameters	Not Applicable
Body	Not Applicable

Request Body

The GET method does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": 0,
      "name": "{name}",
      "value": null,
      "description": null
    }
  ],
  "resultInfo": null,
  "statusCode": 200
}

info

The possible encoding priorities returned by this endpoint are:

• 0 — Normal
• 1 — High

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

Top-Level Properties

Field Name	Type	Description
success	boolean	If the response is successful it will return true. Otherwise it will return false.
errors	array[string]	Indicates if there was an error.
messages	array[string]	Returns the response message from the back-end.
result	array[object]	Returns the list of encoding priorities.
resultInfo	string	Returns extra information about the result.
statusCode	integer	Returns the HTTP Status Code.

result Properties

Field Name	Type	Description
id	integer	Unique identifier of the encoding priority. Use this value for the priority field when encoding a video.
name	string	Name of the encoding priority (Normal or High).
value	string	The value of the encoding priority. Not used for this endpoint (returns null).
description	string	Description of the encoding priority. Not used for this endpoint (returns null).

If the action is successful, the service sends back an HTTP 200 or 201 response.

tip

High priority must be enabled for your project before it takes effect. For details on how a requested priority is applied, visit POST Video or PUT Re encode Video.

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