GET Custom Screen Types

Overview

---

The table below provides key details about the GET method to receive Custom Screen Types

GET Custom Screen Types
Method	GET
URL or Endpoint	/api/custom-screens/select-list
Headers	Authorization

The method does not contain parameters or request body

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": 1,
      "name": "Prelive",
      "value": null,
      "description": null
    },
    {
      "id": 2,
      "name": "End",
      "value": null,
      "description": null
    },
    {
      "id": 3,
      "name": "Pause",
      "value": null,
      "description": null
    },
    {
      "id": 4,
      "name": "Problem",
      "value": null,
      "description": 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.
id	integer($int32)	Returns the unique identifier for the custom screen
name	string	Name of the type for the custom screen
value	string	A value associated with the custom screen
description	string	A description of the custom screen
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