Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET groups/sites

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Returns list of Locations, including the count of alarms of each severity for each group. Also includes counts of devices, APs and Clients associated with the Location and also location information regarding the location. This service was formerly known as "Site Groups."

Since Product Version: 2.0

Resource URL

/webacs/api/v1/op/groups/sites

Request Parameters

Type Attribute Name Source Description

Boolean

noAlarms optional

query

If true, the alarms summary data won't be calculated and returned

Response Parameters

Type Attribute Name Description

Integer

apCount

The number of Access Points within the location.

Integer

clearedAlarms

Number of cleared alarms registered against devices within this location.

Integer

clientCount

Number of clients connected to the location.

Integer

criticalAlarms

Number of critical alarms registered against devices within this location.

Integer

deviceCount

Total number of devices (non-APs).

long

groupId

The internal id of the location group.

String

groupName

The name of the location group.

Integer

informationAlarms

Number of information alarms registered against devices within this location.

Float

latitude

Latitude of location.

String

locationAddress

Address of location.

Float

longitude

Longitude of location.

Integer

majorAlarms

Number of major alarms registered against devices within this location.

Integer

minorAlarms

Number of minor alarms registered against devices within this location.

String

name

The hierarchical name of the location.

String

siteType

The type of location: 1 Campus, 2 Building, 4 Floor Area, 5 Outdoor Area.

Integer

warningAlarms

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://172.25.123.114/webacs/api/v1/op/groups/sites

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <siteOpDTO>
    <apCount>15</apCount>
    <clearedAlarms>15</clearedAlarms>
    <clientCount>15</clientCount>
    <criticalAlarms>15</criticalAlarms>
    <deviceCount>15</deviceCount>
    <groupId>2</groupId>
    <groupName>String value</groupName>
    <informationAlarms>15</informationAlarms>
    <latitude>15.0</latitude>
    <locationAddress>String value</locationAddress>
    <longitude>15.0</longitude>
    <majorAlarms>15</majorAlarms>
    <minorAlarms>15</minorAlarms>
    <name>String value</name>
    <siteType>String value</siteType>
    <warningAlarms>15</warningAlarms>
  </siteOpDTO>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/groups/sites.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/groups\/sites",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "siteOpDTO" : {
      "apCount" : 15,
      "clearedAlarms" : 15,
      "clientCount" : 15,
      "criticalAlarms" : 15,
      "deviceCount" : 15,
      "groupId" : 2,
      "groupName" : "String value",
      "informationAlarms" : 15,
      "latitude" : 15,
      "locationAddress" : "String value",
      "longitude" : 15,
      "majorAlarms" : 15,
      "minorAlarms" : 15,
      "name" : "String value",
      "siteType" : "String value",
      "warningAlarms" : 15
    }
  }
}