Black Box ACR1000A-CTL-24 Manual page 87

Ipath agility controller
Hide thumbs Also See for ACR1000A-CTL-24:
Table of Contents

Advertisement

connect_preset
This method was last updated in API version 1, and is compatible with API requests from version 1 onwards
This simple function connects all channel-receiver pairs in a preset.
Input parameters:
- token
- v (the iPATH API version this request is designed for)
- id - the ID of the preset (acquired from get_presets)
- view_only (optional, 0/1 - defaults to 0)
- exclusive (optional, 0/1 - defaults to 0)
- force (optional, 0/1 - defaults to 0) - whether to ignore errors with some of the preset's pairs or not
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (optional, if anything went wrong with connecting the presets)
Examples
Input:
/api/?v=1&method=connect_preset&token=xxxxx&id=1&force=1
Output:
<api_response>
<version>1</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
or
<api_response>
<version>1</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>0</success>
<errors>
<error>
<code>210</code>
<msg>".$config['error_codes'][210]."</msg>
</error>
</errors>
</api_response>
724-746-5500 | blackbox.com
Appendices
Page 87

Advertisement

Table of Contents
loading

Table of Contents