ADDER AdderLink Infinity Manager - API Method: Get Presets

 sll




45
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 AIM 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
mis-configured
(e.g. receiver offline, receiver not defined)
- 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>
<timestamp>2012-12-1412:12:12</timestamp>
<success>1</success>
<page>1</page>
<results_per_page>10</results_per_page>
<total_presets>2</total_presets>
<count_presets>2</count_presets>
<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_pairs>
<problem_cp_pairs/>
<count_active_cp/>
<connected_rx_count>1</connected_rx_count>
<view_button>disabled</view_button>
<shared_button>disabled</shared_button>
<exclusive_button>disabled</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_rx_count/>
<view_button>enabled</view_button>
<shared_button>hidden</shared_button>
<exclusive_button>hidden</exclusive_button>
</connection_preset>
</api_response>