Represents a wireless access point including both unified and autonomous. It provides device attributes such as type, version, association controller, number of associated client, etc.
Since Product Version: 1.2
Resource URL
/webacs/api/v1/data/AccessPointsResponse Parameters
Type | Attribute Name | Description |
---|---|---|
ApAdminStatusEnum |
adminStatus |
AP Admin Status Allowed values:
|
String |
bootVersion |
AP Boot Version |
int |
clientCount |
Total Client Count |
int |
clientCount_2_4GHz |
Client Count on 2.4GHz Band |
int |
clientCount_5GHz |
Client Count on 5GHZ Band |
String |
controllerIpAddress |
Registered Controller IP Address |
String |
controllerName |
Registered Controller Name |
String |
countryCode |
|
String |
ethernetMac |
AP Ethernet MAC Address |
boolean |
hreapEnabled |
Displays whether OfficeExtend is enabled. |
String |
instanceUuid |
This is a uuid for this instance. |
String |
ipAddress |
AP IP Address |
String |
location |
AP SNMP Location |
long |
lwappUpTime |
|
String |
macAddress |
AP MAC Address |
String |
model |
AP Model |
String |
name |
AP Name |
String |
serialNumber |
AP Serial Number |
String |
softwareVersion |
AP Software Version |
AlarmSeverityEnum |
status |
AP Alarm Status Allowed values:
|
String |
type |
AP Type |
long |
upTime |
AP Up Time in hundredths of a second |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://172.25.123.114/webacs/api/v1/data/AccessPoints/15
<?xml version="1.0" ?> <queryResponse type="AccessPoints" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/AccessPoints/15" rootUrl="https://172.25.123.114/webacs/api/v1/data"> <entity dtoType="accessPointsDTO" type="AccessPoints" url="https://172.25.123.114/webacs/api/v1/data/AccessPoints/15"> <accessPointsDTO displayName="String value" id="15" uuid="String value"> <adminStatus>UNKNOWN</adminStatus> <bootVersion>String value</bootVersion> <clientCount>1</clientCount> <clientCount_2_4GHz>1</clientCount_2_4GHz> <clientCount_5GHz>1</clientCount_5GHz> <controllerIpAddress>String value</controllerIpAddress> <controllerName>String value</controllerName> <countryCode>String value</countryCode> <ethernetMac>String value</ethernetMac> <hreapEnabled>true</hreapEnabled> <ipAddress>String value</ipAddress> <location>String value</location> <lwappUpTime>2</lwappUpTime> <macAddress>String value</macAddress> <model>String value</model> <name>String value</name> <serialNumber>String value</serialNumber> <softwareVersion>String value</softwareVersion> <status>CRITICAL</status> <type>String value</type> <upTime>2</upTime> </accessPointsDTO> </entity> </queryResponse>
Sample JSON Payload
https://172.25.123.114/webacs/api/v1/data/AccessPoints/15.json
{ "queryResponse" : { "@type" : "AccessPoints", "@responseType" : "getEntity", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/AccessPoints\/15", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data", "entity" : { "@dtoType" : "accessPointsDTO", "@type" : "AccessPoints", "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/AccessPoints\/15", "accessPointsDTO" : { "@displayName" : "String value", "@id" : "15", "@uuid" : "String value", "adminStatus" : "UNKNOWN", "bootVersion" : "String value", "clientCount" : 1, "clientCount_2_4GHz" : 1, "clientCount_5GHz" : 1, "controllerIpAddress" : "String value", "controllerName" : "String value", "countryCode" : "String value", "ethernetMac" : "String value", "hreapEnabled" : true, "ipAddress" : "String value", "location" : "String value", "lwappUpTime" : 2, "macAddress" : "String value", "model" : "String value", "name" : "String value", "serialNumber" : "String value", "softwareVersion" : "String value", "status" : "CRITICAL", "type" : "String value", "upTime" : 2 } } } }