GET Preview Statuses

Overview

---

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

GET Preview Statuses
Method	GET
URL or Endpoint	/api/preview-statuses/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 preview statuses returned by this endpoint are:

• 1 — Processing
• 2 — Completed
• 3 — Error

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 preview statuses.
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 preview status.
name	string	Name of the preview status (Processing, Completed or Error).
value	string	The value of the preview status. Not used for this endpoint (returns null).
description	string	Description of the preview status. Not used for this endpoint (returns null).

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