Filter
Top Products
724-746-5500 | blackbox.com
724-746-5500 | blackbox.com
Page 5
ServSwitch iPATH Manager API Documentation
or
<api_response>
<version>1</version>
<timestamp>2012-12-12 12:12:12< /timestamp>
<success>0</success>
<errors>
<error>
<code>3</code>
<msg>Error logging out (you may already have logged out)</msg>
</error>
</errors>
</api_response>
get_devices
This method was last updated in API version 2 and is compatible with API requests from version 2 onwards.
This function returns a list of devices.
Input parameters:
- token
- v (the IPATH API version this request is designed for)
- device_type ('rx' = receivers, 'tx' = transmitters. Default = 'rx')
- filter_d_name (Optional. Device name search string)
- filter_d_description (Optional. Device description search string)
- filter_d_location (Optional. Device location search string)
- sort (Optional. Sort results by 'name'/'description'/'location'. Default = 'name')
- sort_dir (Optional. Sort direction for results 'asc'/'desc'. Default = 'asc')
- status (Optional. '','outdated_iPATH_ip','rebooting','offline','outdated_firmware','invalid_backup_firmware','rebooting','upgrading'
- show_all (Optional. If set and not blank, shows all receivers, not just those the logged-in user is permitted to use)
- page (page number to start showing results for, default = 1)
- results_per_page (number of results per page, default = 1000)
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)
- total_devices - the total number of devices
- count_devices - the number of devices on this page
- for each device:
- attribute: item (e.g. 17th device)
- d_id (device id)
- d_mac_address (device MAC address)
- d_name (device name)
- d_description (device description)
- d_location (device location)
- d_online (0 = offline, 1 = online, 2 = rebooting, 3 = factory_resetting, 4 = firmware_upgrading, 6 = running backup
firmware)
- d_type (rx, tx)