Black Box ACR1000A-CTL API Home Theater Server User Manual


 
724-746-5500 | blackbox.com
724-746-5500 | blackbox.com
Page 9
ServSwitch iPATH Manager API Documentation
<count_channels>2</count_channels>
<channel item="1">
<c_id>3</c_id>
<c_name>Channel 1</c_name>
<c_description>Description for Channel 1</c_description>
<c_location>Location of Channel 1</c_location>
<c_favorite>false</c_favorite>
<view_button>disabled</view_button>
<shared_button>disabled</shared_button>
<exclusive_button>disabled</exclusive_button>
</channel>
<channel item="2">
<c_id>5</c_id>
<c_name>Channel 2</c_name>
<c_description>Description for Channel 2</c_description>
<c_location>Location of Channel 2</c_location>
<c_favorite>2</c_favorite>
<view_button>disabled</view_button>
<shared_button>enabled</shared_button>
<exclusive_button>hidden</exclusive_button>
</channel>
</api_response>
get_presets
This method was last updated in API version 1 and is compatible with API requests from version 1 onwards.
This simple function returns a list of presets available to the authenticated user.
Input parameters:
- token
- v (the iPATH API version this request is designed for)
- results_per_page (number of results per page, default = 1000)
- page (page number to start showing results for, default = 1)
Output values:
- version - the current API version number
- timestamp - the current server time
- success
- page (page number)
- results_per_page (number of results per page, default = unlimited)
- total_presets - the total number of presets available to the authenticaed user
- count_presets - the number of presets on this page, available to the authenticated user
- for each connection_preset:
- attribute: item (e.g. 17th preset)
- cp_id (preset id)
- cp_name (preset name)
- cp_description (preset description)
- cp_pairs (the number of channel-receiver pairs in this preset)
- problem_cp_pairs (the number of channel-receiver pairs that are misconfigured
(e.g. receiver offline, receiver not defined)