ServSwitch iPATH Manager API Documentation
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 iPATH 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>
</api_response>
or
<api_response> <version>2</version>
<errors>
<error>
<code>231</code>
<msg>ERROR - exclusive connection not available</msg>
</error>
</errors>
</api_response>
Page 11 |