To work with player themes

Collection /theme

To work with specific theme

GET, PUT and POST fields

The following fields can be GET'd via POST'd and PUT'd, all other fields will be denied.
Please note that not all players support or honour all theme attributes.

Current


  • title - string: the title of the theme in the control panel| limit 50
  • skin - string: the name of the theme in the control panel| limit 50 | Default NULL
  • background_colour - string: hexadecimal colour code defining the player background colour
  • text_colour - string: hexadecimal colour code defining the player text colour
  • icon_colour - string: hexadecimal colour code defining the player icon colour
  • control_bar_colour - string: hexadecimal colour code defining the player control bar colour
  • overlay_text_colour - string: hexadecimal colour code defining the text colour for Overlays
  • overlay_background_colour sstring: hexadecimal colour code defining the background colour for Overlays
  • overlay_link_colour string: hexadecimal colour code defining the hyperlink colour for Overlays

GET /theme/:id

to get a specific theme by ID

item value
Access system, user
Full url https://api.buto.tv/v2/theme/{id}
verb GET
params string:id:the specific theme id

Example

api_key=<your api key>
curl --include -X GET -u ${api_key}:x http://api.buto.tv/v2/theme/hs0922G

returns

HTTP/1.1 200 OK
...
Content-Type: application/json

{"id":"hs0922G", ...}

GET /theme?organisation_id=:id

to get a all themes for an organisation

item value
Access system, user
Full url https://api.buto.tv/v2/theme?organisation_id={id}
verb GET
params string:id:the specific organisation id

Example

api_key=<your api key>
curl --include -X GET -u ${api_key}:x http://api.buto.tv/v2/theme?organisation_id=Yhgftg

returns

HTTP/1.1 200 OK
...
Content-Type: application/json

[{"id":"hs0922G", ...},{"id":"hs0923G", ...},{"id":"hs0924G", ...}]

GET /theme/:id/videos

to get all videos associated with a particular theme

item value
Access system, user
Full url https://api.buto.tv/v2/theme/{id}/videos
verb GET
params string:id:the specific theme id

Example

api_key=<your api key>
curl --include -X GET -u ${api_key}:x http://api.buto.tv/v2/theme/hs0922G/videos

returns

HTTP/1.1 200 OK
...
Content-Type: application/json

[{"video_id":"hs0922G", "title":"Take 1"},{"video_id":"hs0923G", "title":"Take 2"}]

POST /theme/:organisation_id

Create a brand new player theme

Notes


  • This endpoint is protected with an API key, SYSTEM and USER ONLY

Data


  • organisation_id - string: the organisation_id you want to create a theme for : REQUIRED
item value
Access system, user
Full url https://api.buto.tv/v2/theme/{organisation_id}
verb POST
params string:organisation_id, The rest of the data should be POST'ed in as described above

Example

api_key=<your api key>
data="title=Chuck Norris Theme&skin=Default&background_colour=#ffffff&text_colour=#ffffff&icon_colour=#ffffff&control_bar_colour=#ffffff&overlay_text_colour=#ffffff&overlay_background_colour=#ffffff&overlay_link_colour=#ffffff"
org_id="Bbgwg"
curl --include -X POST -u ${api_key}:x --data-binary ${data} --include https://api.buto.tv/v2/theme/${org_id}

returns

HTTP/1.1 201 OK
...
Content-Type: application/json

{"status":"Created","message":{"created":"hs0922G"}}

PUT /theme/:theme_id

Update an existing theme profile

Notes


  • This endpoint is protected with an API key, SYSTEM and USER ONLY

Data


  • theme - string: the theme_id you wish to update : REQUIRED
item value
Access system, user
Full url https://api.buto.tv/v2/theme/{theme_id}
verb PUT
params string:theme_id, The rest of the data should be sent in, as described above

Example

api_key=<your api key>
data="background_colour=#cccccc"
theme_id="hs0922G"
curl --include -X PUT -u ${api_key}:x --data-binary ${data} --include https://api.buto.tv/v2/theme/${theme_id}

returns

HTTP/1.1 200 OK
...
Content-Type: application/json

{"status":"OK","message":{"updated":"hs0922G"}}

DELETE /theme/:theme_id

Remove existing theme

Notes


  • This endpoint is protected with an API key, SYSTEM and USER ONLY

Data


  • theme - string: the theme_id you wish to update : REQUIRED
item value
Access system, user
Full url https://api.buto.tv/v2/theme/{theme_id}
verb DELETE
params string:theme_id

Example

api_key=<your api key>
theme_id="hs0922G"
curl --include -X DELETE -u ${api_key}:x --include https://api.buto.tv/v2/theme/${theme_id}

returns

HTTP/1.1 200 OK
...
Content-Type: application/json

{"status":"OK","message":{"deleted":"hs0922G"}}