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

# GET ServiceDomains

Service domain or Wireless Site Map is object which represents sites, buildings, floors and outside areas.

Since Product Version: 3.7

- Jump To

- v1
- v2
- v3
- v4

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 unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 4.

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v4/data/ServiceDomains

## Response Parameters

Attribute | Description
--- | ---
apCount Integer | Count of access points
civicLocation String | Location address
contact String | Email address
criticalRadioCount Integer | Count of critical radio interfaces
domainType ServiceDomainTypeEnum | Type of service domain. Here MULTI_FLOOR is synonym of Building. Allowed values LOGICAL CAMPUS MULTI_FLOOR FLOOR FLOOR_AREA OUTDOOR_AREA
dot11aRadioCount Integer | Count of 802.11a radio interfaces
dot11bRadioCount Integer | Count of 802.11b radio interfaces
dot11gRadioCount Integer | Count of 802.11g radio interfaces
floorIndex Integer | Index of floor. This attribute only for floor.
groupId Long | ID of the location group
height Float | Physical height of service domain in feets. This attribute only for floor and outside areas.
horizontalPosition Float | The distance in feets from the top left corner of the floor area to the left edge of the building map. This attribute only for floor.
latitude Double | Latitude of service domain. Value should be between -90 and 90
length Float | Physical length of service domain in feets
longitude Double | Longitude of service domain. Value should be between -180 and 180
name String | Name of Service Domain
numOfBasements Integer | Number of basements. This attribute for buildings.
numOfFloors Integer | Number of floors. This attribute for buildings.
parentId Long | ID of parent service domain
rfModel RFModelDTO | Calibration model. This attribute only for floor and outside areas.
Attribute | Description
--- | ---
name String | Calibration model name
status AlarmSeverityEnum | Status of Service Domain. This status is calculated as max severity of all alarms within this domain and all subdomains. Allowed values CRITICAL MAJOR MINOR WARNING CLEARED INFORMATION
verticalPosition Float | The distance in feets from the top left corner of the floor area to the top edge of the building map. This attribute only for floor.
width Float | Physical width of service domain in feets
wirelessClientsCount Integer | Count of wireless clients

## 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://10.64.88.203/webacs/api/v4/data/ServiceDomains/15

    <?xml version="1.0" ?>
    <queryResponse type="ServiceDomains" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/ServiceDomains/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="serviceDomainsDTO" type="ServiceDomains" url="https://10.64.88.203/webacs/api/v4/data/ServiceDomains/15">
        <serviceDomainsDTO displayName="String value" id="15" uuid="String value">
          <apCount>15</apCount>
          <civicLocation>String value</civicLocation>
          <contact>String value</contact>
          <criticalRadioCount>15</criticalRadioCount>
          <domainType>LOGICAL</domainType>
          <dot11aRadioCount>15</dot11aRadioCount>
          <dot11bRadioCount>15</dot11bRadioCount>
          <dot11gRadioCount>15</dot11gRadioCount>
          <floorIndex>15</floorIndex>
          <groupId>15</groupId>
          <height>15.0</height>
          <horizontalPosition>15.0</horizontalPosition>
          <latitude>15.0</latitude>
          <length>15.0</length>
          <longitude>15.0</longitude>
          <name>String value</name>
          <numOfBasements>15</numOfBasements>
          <numOfFloors>15</numOfFloors>
          <parentId>15</parentId>
          <rfModel>
            <lazyLoadedEntities>
              <entry>
                <key>Another string value</key>
                <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
              </entry>
              <entry>
                <key>String value</key>
                <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
              </entry>
            </lazyLoadedEntities>
            <name>String value</name>
          </rfModel>
          <status>CRITICAL</status>
          <verticalPosition>15.0</verticalPosition>
          <width>15.0</width>
          <wirelessClientsCount>15</wirelessClientsCount>
        </serviceDomainsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v4/data/ServiceDomains/15.json

    {
      "queryResponse" : {
        "@type" : "ServiceDomains",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/ServiceDomains/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "serviceDomainsDTO",
          "@type" : "ServiceDomains",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/ServiceDomains/15",
          "serviceDomainsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "apCount" : 15,
            "civicLocation" : "String value",
            "contact" : "String value",
            "criticalRadioCount" : 15,
            "domainType" : "LOGICAL",
            "dot11aRadioCount" : 15,
            "dot11bRadioCount" : 15,
            "dot11gRadioCount" : 15,
            "floorIndex" : 15,
            "groupId" : 15,
            "height" : 15.0,
            "horizontalPosition" : 15.0,
            "latitude" : 15.0,
            "length" : 15.0,
            "longitude" : 15.0,
            "name" : "String value",
            "numOfBasements" : 15,
            "numOfFloors" : 15,
            "parentId" : 15,
            "rfModel" : {
              "name" : "String value"
            },
            "status" : "CRITICAL",
            "verticalPosition" : 15.0,
            "width" : 15.0,
            "wirelessClientsCount" : 15
          }
        } ]
      }
    }