Black Box ACR1000A-CTL API, servswitch ipath manager api manual Getchannels

Page 8

ServSwitch iPATH Manager API Documentation

get_channels

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

This simple function returns a list of channels available to the authenticated user, for a specific receiver.

Input parameters:

-token

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

-page (page number to start showing results for, default = 1)

-results_per_page (number of results per page, default = 1000)

-device_id (ID of the receiver that this channel will be connected to. Recommended to ensure full checks for connection mode availability.

-filter_c_name (channel name search string)

-filter_c_description (channel description search string)

-filter_c_location (channel location search string)

-filter_favorites (set this non-empty to only show a user's favorites)

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)

-count_channels - the number of channels on this page, available to the authenticated user

-for each channel:

-attribute: item (e.g. 17th channel)

-c_id (channel id)

-c_name (channel name)

-c_description (channel description)

-c_location (channel location)

-c_favorite (true if this channel is in the user's favorites, 0-9 if it's a numbered shortcut)

-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.

If the device_id of the proposed receiver to be used in the connection is not provided, this will not necessarily be an accurate indication of whether other connections may actually interfere)

-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=2&method=get_channels&token=xxxxx

Output:

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

<page>1</page>

<results_per_page>10</results_per_page>

Page 8

724-746-5500 blackbox.com

Image 8
Contents Application Programming Interface API Manual ServSwitch iPATH Manager API Documentation Methods LoginAPI version Changelog Logout Getdevices Device item=4 did170/did Device item=1 did64/did Getchannels Getpresets Connectionpreset /apiresponse Connectchannel Connectpreset Disconnectpreset DisconnectchannelServSwitch iPATH Manager API Documentation Blackbox.com Black Box Tech Support FREE! Live /7