Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/groups/sites
Request Parameters
noAlarms
Boolean
|
query
|
Optional
If true, the alarms summary data won't be calculated and returned
|
noMembersCount
Boolean
|
query
|
Optional
If true, the members count won't be calculated and returned. Use the parameter to improve the performance of the API resource. Must be passed along with noAlarms=true.
|
Response Parameters
apCount
Integer
|
The number of Access Points within the location.
|
clearedAlarms
Integer
|
Total number of cleared alarms registered against devices within this location.
|
clientCount
Integer
|
Number of clients connected to the location.
|
criticalAlarms
Integer
|
Total number of critical alarms registered against devices within this location.
|
description
String
|
The description of the location group.
|
deviceCount
Integer
|
Total number of devices (non-APs).
|
groupId
long
|
The internal id of the location group.
|
groupName
String
|
The name of the location group.
|
informationAlarms
Integer
|
Total number of information alarms registered against devices within this location.
|
isExplicit
boolean
|
Indicates if a group is an explicit member of your active virtual domain. If 'false', you will not be allowed to modify this group.
|
latitude
Float
|
Latitude of location, measured in degrees and ranges from -90 to 90.
|
locationAddress
String
|
|
locationGroupType
LocationGroupTypeEnum
|
|
longitude
Float
|
Longitude of GPS location, measured in degrees and ranges from -180 to 180.
|
majorAlarms
Integer
|
Total number of major alarms registered against devices within this location.
|
membersCount
Integer
|
Number of members within a location group. Includes the members statically or dynamically added to the group and to the all child groups. The members could be: non-AP devices, Autonomous, Unified and Thirdparty APs.
|
minorAlarms
Integer
|
Total number of minor alarms registered against devices within this location.
|
name
String
|
The hierarchical name of the location.
|
siteType
String
|
Deprecated: should use "locationGroupType" attribute.
The type of location: Campus, Building, Floor Area, Outdoor Area.
|
unacknowledgedClearedAlarms
Integer
|
Number of unacknowledged cleared alarms registered against devices within this location.
|
unacknowledgedCriticalAlarms
Integer
|
Number of unacknowledged critical alarms registered against devices within this location.
|
unacknowledgedInformationAlarms
Integer
|
Number of unacknowledged information alarms registered against devices within this location.
|
unacknowledgedMajorAlarms
Integer
|
Number of unacknowledged major alarms registered against devices within this location.
|
unacknowledgedMinorAlarms
Integer
|
Number of unacknowledged minor alarms registered against devices within this location.
|
unacknowledgedWarningAlarms
Integer
|
Number of unacknowledged warning alarms registered against devices within this location.
|
warningAlarms
Integer
|
Total number of warning alarms registered against devices within this location.
|
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 Response Payload
https://10.64.80.159/webacs/api/v1/op/groups/sites
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v1/op">
<siteOpDTO>
<apCount>15</apCount>
<clearedAlarms>15</clearedAlarms>
<clientCount>15</clientCount>
<criticalAlarms>15</criticalAlarms>
<description>String value</description>
<deviceCount>15</deviceCount>
<groupId>2</groupId>
<groupName>String value</groupName>
<informationAlarms>15</informationAlarms>
<isExplicit>true</isExplicit>
<latitude>15.0</latitude>
<locationAddress>String value</locationAddress>
<locationGroupType>DEFAULT</locationGroupType>
<longitude>15.0</longitude>
<majorAlarms>15</majorAlarms>
<membersCount>15</membersCount>
<minorAlarms>15</minorAlarms>
<name>String value</name>
<siteType>String value</siteType>
<unacknowledgedClearedAlarms>15</unacknowledgedClearedAlarms>
<unacknowledgedCriticalAlarms>15</unacknowledgedCriticalAlarms>
<unacknowledgedInformationAlarms>15</unacknowledgedInformationAlarms>
<unacknowledgedMajorAlarms>15</unacknowledgedMajorAlarms>
<unacknowledgedMinorAlarms>15</unacknowledgedMinorAlarms>
<unacknowledgedWarningAlarms>15</unacknowledgedWarningAlarms>
<warningAlarms>15</warningAlarms>
</siteOpDTO>
<siteOpDTO>
<apCount>25</apCount>
<clearedAlarms>25</clearedAlarms>
<clientCount>25</clientCount>
<criticalAlarms>25</criticalAlarms>
<description>Another string value</description>
<deviceCount>25</deviceCount>
<groupId>12</groupId>
<groupName>Another string value</groupName>
<informationAlarms>25</informationAlarms>
<isExplicit>false</isExplicit>
<latitude>25.0</latitude>
<locationAddress>Another string value</locationAddress>
<locationGroupType>CAMPUS</locationGroupType>
<longitude>25.0</longitude>
<majorAlarms>25</majorAlarms>
<membersCount>25</membersCount>
<minorAlarms>25</minorAlarms>
<name>Another string value</name>
<siteType>Another string value</siteType>
<unacknowledgedClearedAlarms>25</unacknowledgedClearedAlarms>
<unacknowledgedCriticalAlarms>25</unacknowledgedCriticalAlarms>
<unacknowledgedInformationAlarms>25</unacknowledgedInformationAlarms>
<unacknowledgedMajorAlarms>25</unacknowledgedMajorAlarms>
<unacknowledgedMinorAlarms>25</unacknowledgedMinorAlarms>
<unacknowledgedWarningAlarms>25</unacknowledgedWarningAlarms>
<warningAlarms>25</warningAlarms>
</siteOpDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.80.159/webacs/api/v1/op/groups/sites.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/10.64.80.159\/webacs\/api\/v1\/op\/groups\/sites",
"@rootUrl" : "https : \/\/10.64.80.159\/webacs\/api\/v1\/op",
"siteOpDTO" : [{
"apCount" : 15,
"clearedAlarms" : 15,
"clientCount" : 15,
"criticalAlarms" : 15,
"description" : "String value",
"deviceCount" : 15,
"groupId" : 2,
"groupName" : "String value",
"informationAlarms" : 15,
"isExplicit" : true,
"latitude" : 15,
"locationAddress" : "String value",
"locationGroupType" : "DEFAULT",
"longitude" : 15,
"majorAlarms" : 15,
"membersCount" : 15,
"minorAlarms" : 15,
"name" : "String value",
"siteType" : "String value",
"unacknowledgedClearedAlarms" : 15,
"unacknowledgedCriticalAlarms" : 15,
"unacknowledgedInformationAlarms" : 15,
"unacknowledgedMajorAlarms" : 15,
"unacknowledgedMinorAlarms" : 15,
"unacknowledgedWarningAlarms" : 15,
"warningAlarms" : 15
},
{
"apCount" : 25,
"clearedAlarms" : 25,
"clientCount" : 25,
"criticalAlarms" : 25,
"description" : "Another string value",
"deviceCount" : 25,
"groupId" : 12,
"groupName" : "Another string value",
"informationAlarms" : 25,
"isExplicit" : false,
"latitude" : 25,
"locationAddress" : "Another string value",
"locationGroupType" : "CAMPUS",
"longitude" : 25,
"majorAlarms" : 25,
"membersCount" : 25,
"minorAlarms" : 25,
"name" : "Another string value",
"siteType" : "Another string value",
"unacknowledgedClearedAlarms" : 25,
"unacknowledgedCriticalAlarms" : 25,
"unacknowledgedInformationAlarms" : 25,
"unacknowledgedMajorAlarms" : 25,
"unacknowledgedMinorAlarms" : 25,
"unacknowledgedWarningAlarms" : 25,
"warningAlarms" : 25
}]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/groups/sites
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
noAlarms
Boolean
|
query
|
Optional
If true, the alarms summary data won't be calculated and returned
|
noMembersCount
Boolean
|
query
|
Optional
If true, the members count won't be calculated and returned. Use the parameter to improve the performance of the API resource. Must be passed along with noAlarms=true.
|
Response Parameters
apCount
Integer
|
The number of Access Points within the location.
|
clearedAlarms
Integer
|
Total number of cleared alarms registered against devices within this location.
|
clientCount
Integer
|
Number of clients connected to the location.
|
criticalAlarms
Integer
|
Total number of critical alarms registered against devices within this location.
|
description
String
|
The description of the location group.
|
deviceCount
Integer
|
Total number of devices (non-APs).
|
groupId
long
|
The internal id of the location group.
|
groupName
String
|
The name of the location group.
|
informationAlarms
Integer
|
Total number of information alarms registered against devices within this location.
|
isExplicit
boolean
|
Indicates if a group is an explicit member of your active virtual domain. If 'false', you will not be allowed to modify this group.
|
latitude
Float
|
Latitude of location, measured in degrees and ranges from -90 to 90.
|
locationAddress
String
|
|
locationGroupType
LocationGroupTypeEnum
|
|
longitude
Float
|
Longitude of GPS location, measured in degrees and ranges from -180 to 180.
|
majorAlarms
Integer
|
Total number of major alarms registered against devices within this location.
|
membersCount
Integer
|
Number of members within a location group. Includes the members statically or dynamically added to the group and to the all child groups. The members could be: non-AP devices, Autonomous, Unified and Thirdparty APs.
|
minorAlarms
Integer
|
Total number of minor alarms registered against devices within this location.
|
name
String
|
The hierarchical name of the location.
|
siteType
String
|
Deprecated: should use "locationGroupType" attribute.
The type of location: Campus, Building, Floor Area, Outdoor Area.
|
unacknowledgedClearedAlarms
Integer
|
Number of unacknowledged cleared alarms registered against devices within this location.
|
unacknowledgedCriticalAlarms
Integer
|
Number of unacknowledged critical alarms registered against devices within this location.
|
unacknowledgedInformationAlarms
Integer
|
Number of unacknowledged information alarms registered against devices within this location.
|
unacknowledgedMajorAlarms
Integer
|
Number of unacknowledged major alarms registered against devices within this location.
|
unacknowledgedMinorAlarms
Integer
|
Number of unacknowledged minor alarms registered against devices within this location.
|
unacknowledgedWarningAlarms
Integer
|
Number of unacknowledged warning alarms registered against devices within this location.
|
warningAlarms
Integer
|
Total number of warning alarms registered against devices within this location.
|
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 Response Payload
https://10.64.80.159/webacs/api/v2/op/groups/sites
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v2/op">
<siteOpDTO>
<apCount>15</apCount>
<clearedAlarms>15</clearedAlarms>
<clientCount>15</clientCount>
<criticalAlarms>15</criticalAlarms>
<description>String value</description>
<deviceCount>15</deviceCount>
<groupId>2</groupId>
<groupName>String value</groupName>
<informationAlarms>15</informationAlarms>
<isExplicit>true</isExplicit>
<latitude>15.0</latitude>
<locationAddress>String value</locationAddress>
<locationGroupType>DEFAULT</locationGroupType>
<longitude>15.0</longitude>
<majorAlarms>15</majorAlarms>
<membersCount>15</membersCount>
<minorAlarms>15</minorAlarms>
<name>String value</name>
<siteType>String value</siteType>
<unacknowledgedClearedAlarms>15</unacknowledgedClearedAlarms>
<unacknowledgedCriticalAlarms>15</unacknowledgedCriticalAlarms>
<unacknowledgedInformationAlarms>15</unacknowledgedInformationAlarms>
<unacknowledgedMajorAlarms>15</unacknowledgedMajorAlarms>
<unacknowledgedMinorAlarms>15</unacknowledgedMinorAlarms>
<unacknowledgedWarningAlarms>15</unacknowledgedWarningAlarms>
<warningAlarms>15</warningAlarms>
</siteOpDTO>
<siteOpDTO>
<apCount>25</apCount>
<clearedAlarms>25</clearedAlarms>
<clientCount>25</clientCount>
<criticalAlarms>25</criticalAlarms>
<description>Another string value</description>
<deviceCount>25</deviceCount>
<groupId>12</groupId>
<groupName>Another string value</groupName>
<informationAlarms>25</informationAlarms>
<isExplicit>false</isExplicit>
<latitude>25.0</latitude>
<locationAddress>Another string value</locationAddress>
<locationGroupType>CAMPUS</locationGroupType>
<longitude>25.0</longitude>
<majorAlarms>25</majorAlarms>
<membersCount>25</membersCount>
<minorAlarms>25</minorAlarms>
<name>Another string value</name>
<siteType>Another string value</siteType>
<unacknowledgedClearedAlarms>25</unacknowledgedClearedAlarms>
<unacknowledgedCriticalAlarms>25</unacknowledgedCriticalAlarms>
<unacknowledgedInformationAlarms>25</unacknowledgedInformationAlarms>
<unacknowledgedMajorAlarms>25</unacknowledgedMajorAlarms>
<unacknowledgedMinorAlarms>25</unacknowledgedMinorAlarms>
<unacknowledgedWarningAlarms>25</unacknowledgedWarningAlarms>
<warningAlarms>25</warningAlarms>
</siteOpDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.80.159/webacs/api/v2/op/groups/sites.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.80.159/webacs/api/v2/op",
"siteOpDTO" : [ {
"apCount" : 15,
"clearedAlarms" : 15,
"clientCount" : 15,
"criticalAlarms" : 15,
"description" : "String value",
"deviceCount" : 15,
"groupId" : 2,
"groupName" : "String value",
"informationAlarms" : 15,
"isExplicit" : true,
"latitude" : 15.0,
"locationAddress" : "String value",
"locationGroupType" : "DEFAULT",
"longitude" : 15.0,
"majorAlarms" : 15,
"membersCount" : 15,
"minorAlarms" : 15,
"name" : "String value",
"siteType" : "String value",
"unacknowledgedClearedAlarms" : 15,
"unacknowledgedCriticalAlarms" : 15,
"unacknowledgedInformationAlarms" : 15,
"unacknowledgedMajorAlarms" : 15,
"unacknowledgedMinorAlarms" : 15,
"unacknowledgedWarningAlarms" : 15,
"warningAlarms" : 15
}, {
"apCount" : 25,
"clearedAlarms" : 25,
"clientCount" : 25,
"criticalAlarms" : 25,
"description" : "Another string value",
"deviceCount" : 25,
"groupId" : 12,
"groupName" : "Another string value",
"informationAlarms" : 25,
"isExplicit" : false,
"latitude" : 25.0,
"locationAddress" : "Another string value",
"locationGroupType" : "CAMPUS",
"longitude" : 25.0,
"majorAlarms" : 25,
"membersCount" : 25,
"minorAlarms" : 25,
"name" : "Another string value",
"siteType" : "Another string value",
"unacknowledgedClearedAlarms" : 25,
"unacknowledgedCriticalAlarms" : 25,
"unacknowledgedInformationAlarms" : 25,
"unacknowledgedMajorAlarms" : 25,
"unacknowledgedMinorAlarms" : 25,
"unacknowledgedWarningAlarms" : 25,
"warningAlarms" : 25
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/groups/sites
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
noAlarms
Boolean
|
query
|
Optional
If true, the alarms summary data won't be calculated and returned
|
noMembersCount
Boolean
|
query
|
Optional
If true, the members count won't be calculated and returned. Use the parameter to improve the performance of the API resource. Must be passed along with noAlarms=true.
|
Response Parameters
apCount
Integer
|
The number of Access Points within the location.
|
clearedAlarms
Integer
|
Total number of cleared alarms registered against devices within this location.
|
clientCount
Integer
|
Number of clients connected to the location.
|
criticalAlarms
Integer
|
Total number of critical alarms registered against devices within this location.
|
description
String
|
The description of the location group.
|
deviceCount
Integer
|
Total number of devices (non-APs).
|
groupId
long
|
The internal id of the location group.
|
groupName
String
|
The name of the location group.
|
informationAlarms
Integer
|
Total number of information alarms registered against devices within this location.
|
isExplicit
boolean
|
Indicates if a group is an explicit member of your active virtual domain. If 'false', you will not be allowed to modify this group.
|
latitude
Float
|
Latitude of location, measured in degrees and ranges from -90 to 90.
|
locationAddress
String
|
|
locationGroupType
LocationGroupTypeEnum
|
|
longitude
Float
|
Longitude of GPS location, measured in degrees and ranges from -180 to 180.
|
majorAlarms
Integer
|
Total number of major alarms registered against devices within this location.
|
membersCount
Integer
|
Number of members within a location group. Includes the members statically or dynamically added to the group and to the all child groups. The members could be: non-AP devices, Autonomous, Unified and Thirdparty APs.
|
minorAlarms
Integer
|
Total number of minor alarms registered against devices within this location.
|
name
String
|
The hierarchical name of the location.
|
siteType
String
|
Deprecated: should use "locationGroupType" attribute.
The type of location: Campus, Building, Floor Area, Outdoor Area.
|
unacknowledgedClearedAlarms
Integer
|
Number of unacknowledged cleared alarms registered against devices within this location.
|
unacknowledgedCriticalAlarms
Integer
|
Number of unacknowledged critical alarms registered against devices within this location.
|
unacknowledgedInformationAlarms
Integer
|
Number of unacknowledged information alarms registered against devices within this location.
|
unacknowledgedMajorAlarms
Integer
|
Number of unacknowledged major alarms registered against devices within this location.
|
unacknowledgedMinorAlarms
Integer
|
Number of unacknowledged minor alarms registered against devices within this location.
|
unacknowledgedWarningAlarms
Integer
|
Number of unacknowledged warning alarms registered against devices within this location.
|
warningAlarms
Integer
|
Total number of warning alarms registered against devices within this location.
|
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 Response Payload
https://10.64.80.159/webacs/api/v3/op/groups/sites
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v3/op">
<siteOpDTO>
<apCount>15</apCount>
<clearedAlarms>15</clearedAlarms>
<clientCount>15</clientCount>
<criticalAlarms>15</criticalAlarms>
<description>String value</description>
<deviceCount>15</deviceCount>
<groupId>2</groupId>
<groupName>String value</groupName>
<informationAlarms>15</informationAlarms>
<isExplicit>true</isExplicit>
<latitude>15.0</latitude>
<locationAddress>String value</locationAddress>
<locationGroupType>DEFAULT</locationGroupType>
<longitude>15.0</longitude>
<majorAlarms>15</majorAlarms>
<membersCount>15</membersCount>
<minorAlarms>15</minorAlarms>
<name>String value</name>
<siteType>String value</siteType>
<unacknowledgedClearedAlarms>15</unacknowledgedClearedAlarms>
<unacknowledgedCriticalAlarms>15</unacknowledgedCriticalAlarms>
<unacknowledgedInformationAlarms>15</unacknowledgedInformationAlarms>
<unacknowledgedMajorAlarms>15</unacknowledgedMajorAlarms>
<unacknowledgedMinorAlarms>15</unacknowledgedMinorAlarms>
<unacknowledgedWarningAlarms>15</unacknowledgedWarningAlarms>
<warningAlarms>15</warningAlarms>
</siteOpDTO>
<siteOpDTO>
<apCount>25</apCount>
<clearedAlarms>25</clearedAlarms>
<clientCount>25</clientCount>
<criticalAlarms>25</criticalAlarms>
<description>Another string value</description>
<deviceCount>25</deviceCount>
<groupId>12</groupId>
<groupName>Another string value</groupName>
<informationAlarms>25</informationAlarms>
<isExplicit>false</isExplicit>
<latitude>25.0</latitude>
<locationAddress>Another string value</locationAddress>
<locationGroupType>CAMPUS</locationGroupType>
<longitude>25.0</longitude>
<majorAlarms>25</majorAlarms>
<membersCount>25</membersCount>
<minorAlarms>25</minorAlarms>
<name>Another string value</name>
<siteType>Another string value</siteType>
<unacknowledgedClearedAlarms>25</unacknowledgedClearedAlarms>
<unacknowledgedCriticalAlarms>25</unacknowledgedCriticalAlarms>
<unacknowledgedInformationAlarms>25</unacknowledgedInformationAlarms>
<unacknowledgedMajorAlarms>25</unacknowledgedMajorAlarms>
<unacknowledgedMinorAlarms>25</unacknowledgedMinorAlarms>
<unacknowledgedWarningAlarms>25</unacknowledgedWarningAlarms>
<warningAlarms>25</warningAlarms>
</siteOpDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.80.159/webacs/api/v3/op/groups/sites.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.80.159/webacs/api/v3/op",
"siteOpDTO" : [ {
"apCount" : 15,
"clearedAlarms" : 15,
"clientCount" : 15,
"criticalAlarms" : 15,
"description" : "String value",
"deviceCount" : 15,
"groupId" : 2,
"groupName" : "String value",
"informationAlarms" : 15,
"isExplicit" : true,
"latitude" : 15.0,
"locationAddress" : "String value",
"locationGroupType" : "DEFAULT",
"longitude" : 15.0,
"majorAlarms" : 15,
"membersCount" : 15,
"minorAlarms" : 15,
"name" : "String value",
"siteType" : "String value",
"unacknowledgedClearedAlarms" : 15,
"unacknowledgedCriticalAlarms" : 15,
"unacknowledgedInformationAlarms" : 15,
"unacknowledgedMajorAlarms" : 15,
"unacknowledgedMinorAlarms" : 15,
"unacknowledgedWarningAlarms" : 15,
"warningAlarms" : 15
}, {
"apCount" : 25,
"clearedAlarms" : 25,
"clientCount" : 25,
"criticalAlarms" : 25,
"description" : "Another string value",
"deviceCount" : 25,
"groupId" : 12,
"groupName" : "Another string value",
"informationAlarms" : 25,
"isExplicit" : false,
"latitude" : 25.0,
"locationAddress" : "Another string value",
"locationGroupType" : "CAMPUS",
"longitude" : 25.0,
"majorAlarms" : 25,
"membersCount" : 25,
"minorAlarms" : 25,
"name" : "Another string value",
"siteType" : "Another string value",
"unacknowledgedClearedAlarms" : 25,
"unacknowledgedCriticalAlarms" : 25,
"unacknowledgedInformationAlarms" : 25,
"unacknowledgedMajorAlarms" : 25,
"unacknowledgedMinorAlarms" : 25,
"unacknowledgedWarningAlarms" : 25,
"warningAlarms" : 25
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/groups/sites
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
noAlarms
Boolean
|
query
|
Optional
If true, the alarms summary data won't be calculated and returned
|
noMembersCount
Boolean
|
query
|
Optional
If true, the members count won't be calculated and returned. Use the parameter to improve the performance of the API resource. Must be passed along with noAlarms=true.
|
Response Parameters
apCount
Integer
|
The number of Access Points within the location.
|
clearedAlarms
Integer
|
Total number of cleared alarms registered against devices within this location.
|
clientCount
Integer
|
Number of clients connected to the location.
|
criticalAlarms
Integer
|
Total number of critical alarms registered against devices within this location.
|
description
String
|
The description of the location group.
|
deviceCount
Integer
|
Total number of devices (non-APs).
|
groupId
long
|
The internal id of the location group.
|
groupName
String
|
The name of the location group.
|
informationAlarms
Integer
|
Total number of information alarms registered against devices within this location.
|
isExplicit
boolean
|
Indicates if a group is an explicit member of your active virtual domain. If 'false', you will not be allowed to modify this group.
|
latitude
Float
|
Latitude of location, measured in degrees and ranges from -90 to 90.
|
locationAddress
String
|
|
locationGroupType
LocationGroupTypeEnum
|
|
longitude
Float
|
Longitude of GPS location, measured in degrees and ranges from -180 to 180.
|
majorAlarms
Integer
|
Total number of major alarms registered against devices within this location.
|
membersCount
Integer
|
Number of members within a location group. Includes the members statically or dynamically added to the group and to the all child groups. The members could be: non-AP devices, Autonomous, Unified and Thirdparty APs.
|
minorAlarms
Integer
|
Total number of minor alarms registered against devices within this location.
|
name
String
|
The hierarchical name of the location.
|
siteType
String
|
Deprecated: should use "locationGroupType" attribute.
The type of location: Campus, Building, Floor Area, Outdoor Area.
|
unacknowledgedClearedAlarms
Integer
|
Number of unacknowledged cleared alarms registered against devices within this location.
|
unacknowledgedCriticalAlarms
Integer
|
Number of unacknowledged critical alarms registered against devices within this location.
|
unacknowledgedInformationAlarms
Integer
|
Number of unacknowledged information alarms registered against devices within this location.
|
unacknowledgedMajorAlarms
Integer
|
Number of unacknowledged major alarms registered against devices within this location.
|
unacknowledgedMinorAlarms
Integer
|
Number of unacknowledged minor alarms registered against devices within this location.
|
unacknowledgedWarningAlarms
Integer
|
Number of unacknowledged warning alarms registered against devices within this location.
|
warningAlarms
Integer
|
Total number of warning alarms registered against devices within this location.
|
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 Response Payload
https://10.64.80.159/webacs/api/v4/op/groups/sites
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v4/op">
<siteOpDTO>
<apCount>15</apCount>
<clearedAlarms>15</clearedAlarms>
<clientCount>15</clientCount>
<criticalAlarms>15</criticalAlarms>
<description>String value</description>
<deviceCount>15</deviceCount>
<groupId>2</groupId>
<groupName>String value</groupName>
<informationAlarms>15</informationAlarms>
<isExplicit>true</isExplicit>
<latitude>15.0</latitude>
<locationAddress>String value</locationAddress>
<locationGroupType>DEFAULT</locationGroupType>
<longitude>15.0</longitude>
<majorAlarms>15</majorAlarms>
<membersCount>15</membersCount>
<minorAlarms>15</minorAlarms>
<name>String value</name>
<siteType>String value</siteType>
<unacknowledgedClearedAlarms>15</unacknowledgedClearedAlarms>
<unacknowledgedCriticalAlarms>15</unacknowledgedCriticalAlarms>
<unacknowledgedInformationAlarms>15</unacknowledgedInformationAlarms>
<unacknowledgedMajorAlarms>15</unacknowledgedMajorAlarms>
<unacknowledgedMinorAlarms>15</unacknowledgedMinorAlarms>
<unacknowledgedWarningAlarms>15</unacknowledgedWarningAlarms>
<warningAlarms>15</warningAlarms>
</siteOpDTO>
<siteOpDTO>
<apCount>25</apCount>
<clearedAlarms>25</clearedAlarms>
<clientCount>25</clientCount>
<criticalAlarms>25</criticalAlarms>
<description>Another string value</description>
<deviceCount>25</deviceCount>
<groupId>12</groupId>
<groupName>Another string value</groupName>
<informationAlarms>25</informationAlarms>
<isExplicit>false</isExplicit>
<latitude>25.0</latitude>
<locationAddress>Another string value</locationAddress>
<locationGroupType>CAMPUS</locationGroupType>
<longitude>25.0</longitude>
<majorAlarms>25</majorAlarms>
<membersCount>25</membersCount>
<minorAlarms>25</minorAlarms>
<name>Another string value</name>
<siteType>Another string value</siteType>
<unacknowledgedClearedAlarms>25</unacknowledgedClearedAlarms>
<unacknowledgedCriticalAlarms>25</unacknowledgedCriticalAlarms>
<unacknowledgedInformationAlarms>25</unacknowledgedInformationAlarms>
<unacknowledgedMajorAlarms>25</unacknowledgedMajorAlarms>
<unacknowledgedMinorAlarms>25</unacknowledgedMinorAlarms>
<unacknowledgedWarningAlarms>25</unacknowledgedWarningAlarms>
<warningAlarms>25</warningAlarms>
</siteOpDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.80.159/webacs/api/v4/op/groups/sites.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.80.159/webacs/api/v4/op",
"siteOpDTO" : [ {
"apCount" : 15,
"clearedAlarms" : 15,
"clientCount" : 15,
"criticalAlarms" : 15,
"description" : "String value",
"deviceCount" : 15,
"groupId" : 2,
"groupName" : "String value",
"informationAlarms" : 15,
"isExplicit" : true,
"latitude" : 15.0,
"locationAddress" : "String value",
"locationGroupType" : "DEFAULT",
"longitude" : 15.0,
"majorAlarms" : 15,
"membersCount" : 15,
"minorAlarms" : 15,
"name" : "String value",
"siteType" : "String value",
"unacknowledgedClearedAlarms" : 15,
"unacknowledgedCriticalAlarms" : 15,
"unacknowledgedInformationAlarms" : 15,
"unacknowledgedMajorAlarms" : 15,
"unacknowledgedMinorAlarms" : 15,
"unacknowledgedWarningAlarms" : 15,
"warningAlarms" : 15
}, {
"apCount" : 25,
"clearedAlarms" : 25,
"clientCount" : 25,
"criticalAlarms" : 25,
"description" : "Another string value",
"deviceCount" : 25,
"groupId" : 12,
"groupName" : "Another string value",
"informationAlarms" : 25,
"isExplicit" : false,
"latitude" : 25.0,
"locationAddress" : "Another string value",
"locationGroupType" : "CAMPUS",
"longitude" : 25.0,
"majorAlarms" : 25,
"membersCount" : 25,
"minorAlarms" : 25,
"name" : "Another string value",
"siteType" : "Another string value",
"unacknowledgedClearedAlarms" : 25,
"unacknowledgedCriticalAlarms" : 25,
"unacknowledgedInformationAlarms" : 25,
"unacknowledgedMajorAlarms" : 25,
"unacknowledgedMinorAlarms" : 25,
"unacknowledgedWarningAlarms" : 25,
"warningAlarms" : 25
} ]
}
}