ADDER A.I.M. User Manual page 56

connect_channel
This method was last updated in API version 2, and is compatible with API requests from
version 2 onwards
This simple function connects a receiver to a channel.
Input parameters:
- token
- v (the A.I.M. API version this request is designed for)
- c_id - the ID of the channel (acquired from get_channels)
- rx_id - the ID of the receiver (acquired from get_receivers)
- view_only (optional, 0/1 - defaults to 0)
- exclusive (optional, 0/1 - defaults to 0)
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 channel)
Examples
Input:
/api/?v=2&method=connect_channel&token=xxxxx&c_id=1&rx_id=2&exclusive=1
Output:
<api_response>
<version>2</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
or
<api_response>
<version>2</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>0</success>
<errors>
<error>
<code>231</code>
<msg>ERROR - exclusive connection not available</msg>
</error>
</errors>
</api_response>
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 A.I.M. 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 - 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>A Receiver is in use by another User</msg>
</error>
</errors>
</api_response>
55