Black Box Home Theater Server servswitch ipath manager api User's Manual
Contents
1. api v 1 amp method get_presets amp token xxxxx Output lt api_response gt lt version gt 1 lt version gt lt timestamp gt 2012 12 14 12 12 12 lt timestamp gt lt success gt 1 lt success gt lt page gt 1 lt page gt lt results_per_page gt 10 lt results_per_page gt lt total_presets gt 2 lt total_presets gt lt count_presets gt 2 lt count_presets gt lt connection_preset item 1 gt lt cp_id gt 3 lt cp_id gt lt cp_name gt Preset 1 lt cp_name gt lt cp_description gt Description for Preset 1 lt cp_description gt lt cp_pairs gt 1 lt cp_pairs gt lt problem_cp_pairs gt lt count_active_cp gt lt connected_rx_count gt 1 lt connected_rx_count gt lt view_button gt disabled lt view_button gt lt shared_button gt disabled lt shared_button gt lt exclusive_button gt disabled lt exclusive_button gt lt connection_preset gt lt connection_preset ttem 2 gt lt cp_id gt 4 lt cp_id gt lt cp_name gt Preset 2 lt cp_name gt lt cp_description gt Description for Preset 2 lt cp_description gt lt cp_pairs gt 2 lt cp_pairs gt lt problem_cp_pairs gt lt count_active_cp gt lt connected_rx_count gt lt view_button gt enabled lt view_button gt lt shared_button gt hidden lt shared_button gt lt exclusive_button gt hidden lt exclusive_button gt lt connection_preset gt lt api_response gt Page 10 724 746 5500 blackbox com ServSwitch iPATH Manager API Documentation connect_chan2. current API version number token an authentication code for future API requests SUCCESS NOTE login examples are on the next page 724 746 5500 blackbox com Page 3 ServSwitch iPATH Manager API Documentation Examples Input api v 1 amp method login amp username xXxxxx amp passSword XXXXX Output lt api_response gt lt version gt 1 lt version gt lt timestamp gt 2012 12 14 12 12 12 lt timestamp gt lt success gt 1 lt success gt lt token gt 5cf494a71c29e9465a57a81e0a2d602c lt token gt lt api_response gt or lt api_response gt lt version gt 1 lt version gt lt timestamp gt 2012 12 14 12 12 12 lt timestamp gt lt success gt 0 lt success gt lt errors gt lt error gt lt code gt 2 lt code gt lt msg gt lInvalid username or password lt msg gt lt error gt lt errors gt lt api_response gt logout This method was last updated in API version 1 and is compatible with API requests from version 1 onwards The authentication token provided by the login function can be used until the logout function is called Input parameters token v the IPATH API version this request is designed for Output values timestamp the current server time success 0 fail 1 success Examples Input api method logout amp token xxxxx amp v 1 Output lt api_response gt lt version gt 1 lt version gt lt timestamp gt 2011 02 04 15 24 15 lt time gt lt success gt 1 lt success
3. gt s lt api_response gt Page 4 724 746 5500 blackbox com ServSwitch iPATH Manager API Documentation or lt api_response gt lt version gt 1 lt version gt lt timestamp gt 2012 12 12 12 12 12 lt timestamp gt lt success gt 0 lt success gt lt errors gt lt error gt lt code gt 3 lt code gt lt msg gt Error logging out you may already have logged out lt msg gt lt error gt lt errors gt lt api_response gt 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
4. 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 724 746 5500 blackbox com Page 5 ServSwitch iPATH Manager API Documentation d_version 1 ACR1000A 2 ACR1002A d_variant b ACR1002A d_ip_address d_configured 0 no 1 yes d_valid_firmware 0 no 1 yes d_valid_backup_firmware 0 no 1 yes d_firmware firmware version e g 2 5 17879 d_backup_firmware backup firmware version d_date_added Date device added to iPATH network e g 2012 07 13 22 17 22 The following property is only returned for transmitters count_transmitter_channels the number of channels containing this transmitter The following properties are only returned for receivers con_start_time start time of last connection e g 2012 09 07 13 33 17 con_end_tim
5. 12 12 12 lt timestamp gt lt success gt 1 lt success gt lt page gt 1 lt page gt lt results_per_page gt 10 lt results_per_page gt Page 8 724 746 5500 blackbox com ServSwitch iPATH Manager API Documentation lt count_channels gt 2 lt count_channels gt lt channel item 1 gt lt c_id gt 3 lt c_id gt lt c_name gt Channel 1 lt c_name gt lt c_description gt Description for Channel 1 lt c_description gt lt c_location gt Location of Channel 1 lt c_location gt lt c_favorite gt false lt c_favorite gt lt view_button gt disabled lt view_button gt lt shared_button gt disabled lt shared_button gt lt exclusive_button gt disabled lt exclusive_button gt lt channel gt lt channel item 2 gt lt c_id gt 5 lt c_id gt lt c_name gt Channel 2 lt c_name gt lt c_description gt Description for Channel 2 lt c_description gt lt c_location gt Location of Channel 2 lt c_location gt lt c_favorite gt 2 lt c_favorite gt lt view_button gt disabled lt view_button gt lt shared_button gt enabled lt shared_button gt lt exclusive_button gt hidden lt exclusive_button gt lt channel gt lt api_response gt get_presets This method was last updated in API version 1 and is compatible with API requests from version 1 onwards This simple function returns a list of presets available to the authenticated user Input parameters token v the iPATH API version this request is designed for resul
6. ACR1000A CTL API lt gt BLACK BOX NETWORK SERVICES BLACK BOX www blackbox com ETHI servswitch i y MANAGER Customer Order toll free in the U S Call 877 877 BBOX outside U S call 724 746 5500 Support FREE technical support 24 hours a day 7 days a week Call 724 746 5500 or fax 724 746 0746 Inf ti Mailing address Black Box Corporation 1000 Park Drive Lawrence PA 15055 1018 JIU tt Web site www blackbox com E mail info blackbox com ServSwitch iPATH Manager API Documentation Table of Contents Methods OON espe cee cee ce tees ce cee eg sree hee cae eee eee gcse pees cee ence gus cneee gece eecyariecens Marsnnei cea senn tat ecceeu neuen cceeeaeaseam epee te 3 LOGUE eee aces sates estate ge che A t te ceneipa deny Bey acces sheehct scrape schactast te AAE A ATTE 4 oS 0 210 6 stone ee Re eee ee eee er ee eet eee ene reer pee eee Peet eet ees ene erect 5 SL IAIN Ss Peachy EAA A EA E E E E E E A E STEET 8 STAD COS CUS aana A E ag TE A A EEE E E E S E N E 9 connect eha NNE esenea an adp ei dadapa apaia Taa ae E daai rue dane aeaa 11 conNECtPrESE T monang na a a E A a E a a E a A eeatangite ds 12 CUISCOMMME CE CHANING a s iega E E aa ea Sa ee a aea aa Ea A aa 13 disconnect Preset aerem ata Eana aE E A E E E N E EOE AE AEAEE ON RE 13 We re here to help If you have any questions about your application or our products contact Black Box Tech Support at 724 746 5500 or go to blackbox com and click on Tal
7. PI requests from version 1 onwards This simple function connects all channel receiver pairs in a preset Input parameters token v the iPATH 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 amp method connect_preset amp token xxxxx amp id 1 amp force 1 Output lt api_response gt lt version gt 1 lt version gt lt timestamp gt 2012 12 12 12 12 12 lt timestamp gt lt success gt 1 lt success gt lt api_response gt or lt api_response gt lt version gt 1 lt version gt lt timestamp gt 2012 12 12 12 12 12 lt timestamp gt lt success gt 0 lt success gt lt errors gt lt error gt lt code gt 210 lt code gt lt msg gt A Receiver is in use by another User lt msg gt lt error gt lt errors gt lt api_response gt Page 12 724 746 5500 blackbox com 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 receive
8. e empty if connection still active else date time the connection was ended e g 2012 09 07 13 33 17 con_exclusive 0 1 if the last connection is was in exclusive mode con_control 0 1 if the last connection has had USB enabled u_username username of the user who initiated the last connection u_id user ID of the user who initiated the last connection c_name name of the channel last connected count_receiver_groups the number of receiver groups this receiver is a part of count_users the number of users who have access to this receiver Examples Input api v 2 amp method get_devices amp token xxxxx api v 2 amp method get_devices amp device_type tx amp page 2 amp results_per_page 3 amp token xxxxx Output lt apl_response gt lt version gt 2 lt version gt lt timestamp gt 2012 09 12 14 56 11 lt timestamp gt lt success gt 1 lt success gt lt page gt 2 lt page gt lt results_per_page gt 3 lt results_per_page gt lt total_devices gt 12 lt total_devices gt lt count_devices gt 3 lt count_devices gt lt devices gt lt device item 4 gt lt d_id gt 170 lt d_id gt lt d_mac_address gt 00 0F 58 01 6E 3D lt d_mac_address gt lt d_name gt RX 123 lt d_name gt lt d_online gt 1 lt d_online gt lt d_type gt rx lt d_type gt lt d_version gt 2 lt d_version gt lt d_variant gt lt d_variant gt lt d_ip_address gt 10 10 10 66 lt d_ip_address gt lt d_description gt lt d_d
9. escription gt lt d_location gt Server Rack 3 lt d_location gt lt d_configured gt 1 lt d_configured gt lt d_valid_firmware gt 1 lt d_valid_firmware gt Page 6 724 746 5500 blackbox com ServSwitch iPATH Manager API Documentation lt d_valid_backup_firmware gt 1 lt d_valid_backup_firmware gt lt d_firmware gt 2 3 16682 lt d_firmware gt lt d_backup_firmware gt 2 3 16682 lt d_backup_firmware gt lt d_date_added gt 2012 07 14 01 37 07 lt d_date_added gt lt con_exclusive gt 0 lt con_exclusive gt lt con_control gt 1 lt con_control gt lt con_start_time gt 2012 09 07 13 33 19 lt con_start_time gt lt con_end_time gt lt u_username gt admin lt u_username gt lt u_id gt 1 lt u_id gt lt c_name gt Channel 1 lt c_name gt lt count_receiver_groups gt 1 lt count_receiver_groups gt lt count_users gt 1 lt count_users gt lt custom_settings gt 0 lt custom_settings gt lt device gt lt devices gt lt api_response gt lt apl_response gt lt version gt 2 lt version gt lt timestamp gt 2012 09 12 14 56 11 lt timestamp gt lt success gt 1 lt success gt lt page gt 1 lt page gt lt results_per_page gt 1 lt results_per_page gt lt total_devices gt 1 lt total_devices gt lt count_devices gt 1 lt count_devices gt lt devices gt lt device ttem 1 gt lt d_id gt 64 lt d_id gt lt d_mac_address gt 00 0F 58 01 56 85 lt d_mac_address gt lt d_name gt TX 456 lt d_name gt lt d_onl
10. ine gt 0 lt d_online gt lt d_type gt tx lt d_type gt lt d_version gt 1 lt d_version gt lt d_variant gt lt d_variant gt lt d_ip_address gt 1 1 201 31 lt d_ip_address gt lt d_description gt lt d_description gt lt d_location gt lt d_location gt lt d_configured gt 1 lt d_configured gt lt d_valid_firmware gt 1 lt d_valid_firmware gt lt d_valid_backup_firmware gt 1 lt d_valid_backup_firmware gt lt d_firmware gt 2 1 15747 lt d_firmware gt lt d_backup_firmware gt 2 1 15747 lt d_backup_firmware gt lt d_date_added gt 2012 07 13 17 50 04 lt d_date_added gt lt count_transmitter_channels gt 3 lt count_transmitter_channels gt lt custom_settings gt 0 lt custom_settings gt lt device gt lt devices gt lt api_response gt 724 746 5500 blackbox com Page 7 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 channe
11. k to Black Box You ll be live with one of our technical experts in less than 30 seconds Page 2 724 746 5500 blackbox com ServSwitch iPATH Manager API Documentation API Documentation API version 2 Changelog v2 IPATH v2 3 added get_devices get_channels connect_channel disconnect_channel Updated version compatibility information v1 IPATH v1 3 added ogin logout get_presets connect_preset disconnect_preset Methods login logout get_devices get_channels get_presets connect_channel connect_preset disconnect_channel disconnect_preset login This method was last updated in API version 1 and is compatible with API requests from version 1 onwards The API will require a valid IPATH user s login credentials to be presented in the first request The API will return an authentication code which must be passed in all future requests This authentication code can be re used until a logout request is made at which point the authentication code will no longer be valid The concept of an anonymous user can apply to the API If no login username and password are provided the API will return an authentication token for the anonymous user either the same one as for the OSD or else an anonymous API user account can be created Input parameters username password v the IPATH API version this request is designed for Output values timestamp the current server time version the
12. l 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 amp method get_channels amp token xxxxx Output lt apl_response gt lt version gt 2 lt version gt lt timestamp gt 2012 12 14
13. mber timestamp the current server time success O fail 1 success errors if anything failed details are returned here 724 746 5500 blackbox com Page 13 ServSwitch iPATH Manager API Documentation Examples Input api v 1 amp method disconnect_preset amp token xxxxx amp id 1 amp force 1 Output lt api_response gt lt version gt 1 lt version gt lt timestamp gt 2012 12 12 12 12 12 lt timestamp gt lt success gt 1 lt success gt lt api_response gt Page 14 724 746 5500 blackbox com NOTES 724 746 5500 blackbox com Page 15 Black Box Tech Support FREE Live 24 7 Tech support the way it should be a Great tech support is just 30 seconds away at 724 746 5500 or blackbox com lt BLACK BOX About Black Box Black Box provides an extensive range of networking and infrastructure products You ll find everything from cabinets and racks and power and surge protection products to media converters and Ethernet switches all supported by free live 24 7 Tech support available in 30 seconds or less Copyright 2013 Black Box Corporation All rights reserved Black Box and the Double Diamond logo are registered trademarks and ServSwitch is a trademark of BB Technologies Inc Any third party trademarks appearing in this manual are acknowledged to be the property of their respective owners ACR1000A CTL API version 1 724 746 5500 blackbox com
14. nel 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 amp method connect_channel amp token xxxxx amp c_id 1 amp rx_id 2 amp exclusive 1 Output lt api_response gt lt version gt 2 lt version gt lt timestamp gt 2012 12 12 12 12 12 lt timestamp gt lt success gt 1 lt success gt lt api_response gt or lt api_response gt lt version gt 2 lt version gt lt timestamp gt 2012 12 12 12 12 12 lt timestamp gt lt success gt 0 lt success gt lt errors gt lt error gt lt code gt 231 lt code gt lt msg gt ERROR exclusive connection not available lt msg gt lt error gt lt errors gt lt api_response gt 724 746 5500 blackbox com Page 11 ServSwitch iPATH Manager API Documentation connect_preset This method was last updated in API version 1 and is compatible with A
15. r 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 amp method disconnect_channel amp token xxxxx amp rx_id 1 api v 2 amp method disconnect_channel amp token xxxxx amp rx_id 1 2 3 api v 2 amp method disconnect_channel amp token xxxxx amp force 1 Output lt api_response gt lt version gt 2 lt version gt lt timestamp gt 2012 12 12 12 12 12 lt timestamp gt lt success gt 1 lt success gt lt api_response gt 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 nu
16. ts_per_page number of results per page default 1000 page page number to start showing results for default 1 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_presets the total number of presets available to the authenticaed user count_presets the number of presets on this page available to the authenticated user for each connection_preset attribute item e g 17th preset cp_id preset id cp_name preset name cp_description preset description Cp_pairs the number of channel receiver pairs in this preset problem_cp_pairs the number of channel receiver pairs that are misconfigured e g receiver offline receiver not defined 724 746 5500 blackbox com Page 9 ServSwitch iPATH Manager API Documentation count_active_cp the number of channel receiver pairs in this preset that are already connected connected_rx_count the number of receivers in this preset that are already connected 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 shared_button disabled enabled hidden as above but in shared mode exclusive_button disabled enabled hidden as above but in exclusive mode Examples Input
Download Pdf Manuals
Related Search