GET Default Bandwidth Estimate Options

Overview

---

The following table contains important information about the GET method in regards to receiving default bandwidth estimate options.

GET Default Bandwidth Estimate Options
Method	GET
URL or Endpoint	​/api/projects/projectId/players/options/default-bandwidth-estimate
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": [],
  "messages": [],
  "result": [
    {
      "id": 1,
      "name": "None",
      "value": "0"
    },
    {
      "id": 2,
      "name": "LTE (1mb/s)",
      "value": "1000000"
    },
    {
      "id": 3,
      "name": "Standard Definition Broadband (2mb/s)",
      "value": "2000000"
    },
    {
      "id": 4,
      "name": "High Definition Broadband (5mb/s)",
      "value": "5000000"
    }
  ],
  "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)	Id of the default bandwidth estimate option.
name	string	Name of the default bandwidth estimate option.
value	string	Value of the default bandwidth estimate 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