Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET Sites

Deprecated

Do not use this resource. Replaced by /op/groups/sites.

This provides information about the location groups and its hierarchy of campus and buildings. Note that internally, Locations are type of "Group", and thus all children will be of the generic type "subGroup".

Since Product Version: 1.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v1/data/Sites

Response Parameters

Attribute Description

apCount int

The number of Access Points (Unified or Autonomous) within the location.

clearedAlarms int

Number of cleared alarms registered against devices within this location.

clientCount int

Number of clients connected to the location.

criticalAlarms int

Number of critical alarms registered against devices within this location.

deviceCount int

Total number of devices (excluding Unified APs).

groupId long

The internal id of the location group.

groupName String

The name of the location group.

informationAlarms int

Number of information alarms registered against devices within this location.

latitude Float

Latitude of location.

locationAddress String

Address of location.

longitude Float

Longitude of location.

majorAlarms int

Number of major alarms registered against devices within this location.

minorAlarms int

Number of minor alarms registered against devices within this location.

name String

The hierarchical name of the location.

siteType String

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

warningAlarms int

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 Payload

https://localhost/webacs/api/v1/data/Sites/15

<?xml version="1.0" ?>
<queryResponse type="Sites" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/Sites/15" rootUrl="https://localhost/webacs/api/v1/data">
  <entity dtoType="sitesDTO" type="Sites" url="https://localhost/webacs/api/v1/data/Sites/15">
    <sitesDTO displayName="String value" id="15" uuid="String value">
      <apCount>1</apCount>
      <clearedAlarms>1</clearedAlarms>
      <clientCount>1</clientCount>
      <criticalAlarms>1</criticalAlarms>
      <deviceCount>1</deviceCount>
      <groupId>2</groupId>
      <groupName>String value</groupName>
      <informationAlarms>1</informationAlarms>
      <latitude>15.0</latitude>
      <locationAddress>String value</locationAddress>
      <longitude>15.0</longitude>
      <majorAlarms>1</majorAlarms>
      <minorAlarms>1</minorAlarms>
      <name>String value</name>
      <siteType>String value</siteType>
      <warningAlarms>1</warningAlarms>
    </sitesDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v1/data/Sites/15.json

{
  "queryResponse" : {
    "@type" : "Sites",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/Sites\/15",
    "@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "sitesDTO",
      "@type" : "Sites",
      "@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/Sites\/15",
      "sitesDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "apCount" : 1,
        "clearedAlarms" : 1,
        "clientCount" : 1,
        "criticalAlarms" : 1,
        "deviceCount" : 1,
        "groupId" : 2,
        "groupName" : "String value",
        "informationAlarms" : 1,
        "latitude" : 15,
        "locationAddress" : "String value",
        "longitude" : 15,
        "majorAlarms" : 1,
        "minorAlarms" : 1,
        "name" : "String value",
        "siteType" : "String value",
        "warningAlarms" : 1
      }
    }
  }
}