INC-WLAN Manager

Query Hotspot Info

Query hotspot info.

Interface URI

/wlan/locationInfo/queryHotSpotInfo

Access Method

HTTP
GET
Parameters

Return Values

Status codes
  • 200 (OK): Success.
Message header
HTTP/1.1 200 OK
Message body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<list>
  <link op="GET" rel="next" href="http://10.153.129.43:8080/imcrs/wlan/locationInfo/queryHotSpotInfo?start=0&size=0"/>
</list>
Element description
hotSpotInfo subelements
apCount Number of APs.
Integer type.
extendInfoArray Extended attribute info.
Array type.
onlineApCount Online APs.
Integer type.
name Hotspot name.
String type.
apBasicInfoArray AP basic info entity list.
Array type.
extendInfo subelements
value Extended info value.
String type.
name Extended info name.
String type.
apBasicInfo subelements
locationList Current location view list.
Array type.
location Current location view name.
String type.
sysName System name: For a fat AP, it is the system name configured on the device. For a fit AP, it is the AP template name.
String type.
hardwareVersion Hardware version.
String type.
connectType Connection type: 1 represents Online (Primary), 2 represents Online (Backup), and 3 represents Offline.
Integer type.
isFit Whether it is a fit AP: 1 represents a fit AP, and 2 represents a fat AP.
Integer type.
serialId Serial ID.
String type.
type Device model.
String type.
macAddress MAC address.
String type.
ipAddress IP address.
String type.
ssids SSID.
Array type.
extendInfoArray Extended attribute info.
Array type.
onlineStatus Online status: Data type is int. For a fat AP, 0 means the AP cannot be pinged successfully, and 1 means the AP can be pinged successfully. For a fit AP, 0 means the AP is offline, and 1 means the AP is online.
Integer type.
acLabel AC label.
String type.
acDevId AC ID.
String type.
status Device status:–1: Unmanaged; 0: Unknown; 1: Normal; 2: Warning; 3: Minor; 4: Major; 5: Critical.
Integer type.
label Device label: For a fat AP, it is the device label configured in INC . For a fit AP, it is the AP name.
String type.
onlineClientCount Online clients.
Integer type.
acIpAddress AC IP address.
String type.
softwareVersion Software version.
String type.

Example

Query information about all hotspots.

Request
/imcrs/wlan/locationInfo/queryHotSpotInfo
accept: application/xml
...
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<list>
  <link op="GET" rel="next" href="http://10.153.129.43:8080/imcrs/wlan/locationInfo/queryHotSpotInfo?start=0&size=0"/>
</list>