724-746-5500 | blackbox.com
Page 10
724-746-5500 | blackbox.com
ServSwitch iPATH Manager API Documentation
- count_active_cp (the number of channel-receiver pairs in this preset that are already connected)
- connected_rx_count (the number of receivers in this preset that are already connected)
- view_button (disabled/enabled/hidden - whether the user can connect to the preset in view-only mode.
disabled = no, because something is in use by someone else. hidden = never. enabled = yes)
- shared_button (disabled/enabled /hidden - as above, but in shared mode)
- exclusive_button (disabled/enabled/ hidden - as above, but in exclusive mode)
Examples
Input:
/api/?v=1&method=get_presets&token=xxxxx
Output:
<api_response>
<version>1</version>
<ti mes ta mp> 2012-12-1 4 12 :12:12 </ tim es tam p>
<success>1</succe ss>
<page>1</page>
<results_per_page>10</results_per_page>
<total_presets >2</total_pr esets>
<count_presets >2</count_prese ts>
<connection_preset item="1">
<cp_id>3</cp_id >
<cp_name>Preset 1</cp _name>
<cp_description>Description for Preset 1</cp_description>
<cp_pairs>1</cp_pair s>
<problem_cp_pairs/>
<count_active_cp/>
<connected_r x_count>1</connec ted_rx_count >
<view_button>disabled</ view_button>
<shared_button>disabled </shared_button>
<exclusive_button>disable d</exclusive_button >
</connection_preset>
<connection_preset item="2">
<cp_id>4</ cp_id>
<cp_name>Preset 2</ cp_name>
<cp_description>Description for Preset 2</cp_description>
<cp_pairs>2< /cp_pairs>
<problem_cp_pairs/>
<count_active_cp/>
<connected_r x_count/>
<view_button>enabled</vi ew_button>
<shared_button>hidden< /shared_button>
<exclusive_button>hidden </exclusive_button>
</connection_preset>
</api_response>