GET Color Defaults

Overview

---

The following table contains important information about the GET method in regards to receiving the color defaults of the player.

GET Color Defaults
Method	GET
URL or Endpoint	​/api/projects/projectId/players/options/color-defaults
Headers	Authorization
Parameters	projectId, filter
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.

The description of the parameter is as follows:

filter Parameter
URL Parameter Name	filter
Mandatory	No
Type	string
Description	Indicates the field you want to know the color of.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "controlbartextcolor": "ffffff",
    "controlbariconsdefaultcolor": "ffffff",
    "controlbariconshovercolor": "ffffff",
    "controlbartimesliderprogresscolor": "cc0000",
    "controlbartimesliderrailcolor": "808080",
    "controlbartimesliderdraggercolor": "cc0000",
    "controlbartimesliderbuffercolor": "e2e2e2",
    "controlbarvolumedraggercolor": "ffffff",
    "controlbarvolumeprogresscolor": "ffffff",
    "controlbarvolumerailcolor": "9f9f9f",
    "controlbarvolumenotifiercolor": "ffffff",
    "menulinksdefaultcolor": "ffffff",
    "menulinkshovercolor": "cc0000",
    "menubackrounddefaultcolor": "000000",
    "menubackroundhovercolor": "000000",
    "menuautoplayoncolor": "cc0000",
    "menuautoplayoffcolor": "a7a7a7",
    "controlbarbackgroundcolor": "ffffff00",
    "tooltipstextcolor": "ffffff00",
    "tooltipsbackroundcolor": "ffffff00",
    "controlbartimeslideronaddraggercolor": "ffffff",
    "controlbartimeslideronadprogresscolor": "f5c338",
    "controlbartimeslideronadrailcolor": "808080"
  },
  "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.
controlbartextcolor	string	Indicates the color of the control bar.
controlbariconsdefaultcolor	string	Indicates the color of the control bar icon.
controlbariconshovercolor	string	Indicates the color of the control bar when hovering.
controlbartimesliderprogresscolor	string	Indicates the color of the control bar slider.
controlbartimesliderrailcolor	string	Indicates the color of the control bar timeslider.
controlbartimesliderdraggercolor	string	Indicates the color of the dragger of the control bar timeslider.
controlbartimesliderbuffercolor	string	Indicates the color of the buffer of the control bar timeslider.
controlbarvolumedraggercolor	string	Indicates the color of the control bar volume dragger.
controlbarvolumeprogresscolor	string	Indicates the color of the control bar volume progress.
controlbarvolumerailcolor	string	Indicates the color of the control bar volume rail.
controlbarvolumenotifiercolor	string	Indicates the color of the control bar volume notifier.
menulinksdefaultcolor	string	Indicates the color of the links menu.
menulinkshovercolor	string	Indicates the color of the links menu when hovering.
menubackrounddefaultcolor	string	Indicates the color of the menu background.
menubackroundhovercolor	string	Indicates the color of the menu background when hovering.
menuautoplayoncolor	string	Indicates the color of the menu auto-play when on.
menuautoplayoffcolor	string	Indicates the color of the menu auto-play when off.
controlbarbackgroundcolor	string	Indicates the color of the control bar background.
tooltipstextcolor	string	Indicates the color of the tooltips text.
tooltipsbackroundcolor	string	Indicates the color of the tooltips background.
controlbartimeslideronaddraggercolor	string	Indicates the color of the dragger of the control bar timeslider.
controlbartimeslideronadprogresscolor	string	Indicates the color of the ad progress of the control bar timeslider.
controlbartimeslideronadrailcolor	string	Indicates the color of the ad rail of the control bar timeslider.
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