Disconnectchannel | Black Box servswitch ipath manager api specs

ServSwitch iPATH Manager API Documentation

disconnect_channel

This method was last updated in API version 2 and is compatible with API requests from version 2 onwards.

This function disconnects a receiver, a number of receivers, or all connected receivers.

Input parameters:

-token

-v (the iPATH API version this request is designed for)

-rx_id (ID(s) of the receiver, as an integer, or comma-separated set of integers. Optional.

-force - whether to disconnect existing connections by other users, or for off-line receivers

Output values:

-version - the current API version number

-timestamp - the current server time

-success (0 = fail, 1 = success)

-errors (if anything failed, details are returned here)

Examples Input:

/api/?v=2&method=disconnect_channel&token=xxxxx&rx_id=1 /api/?v=2&method=disconnect_channel&token=xxxxx&rx_id=1,2,3 /api/?v=2&method=disconnect_channel&token=xxxxx&force=1

Output:

<api_response> <version>2</version> <timestamp>2012-12-12 12:12:12</timestamp> <success>1</success>

</api_response>

disconnect_preset

This method was last updated in API version 1 and is compatible with API requests from version 1 onwards.

This function disconnects all channel-receiver pairs in a preset, or disconnects ALL connections in the whole Agility network.

Input parameters:

-token

-v (the iPATH API version this request is designed for)

-id (optional. If not supplied, all connections will be ended)

-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 (if anything failed, details are returned here)

724-746-5500 blackbox.com

Page 13