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

# GET ThirdpartyAccessPoints

Represents a third party access point. It provides device attributes such as type, version, associated controller, number of associated clients, etc.

Since Product Version: 3.2

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

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

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/data/ThirdpartyAccessPoints

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
adminStatus ApAdminStatusEnum | AP Admin Status Allowed values UNKNOWN ENABLE DISABLE
bootVersion String | Deprecated. AP Boot Version. The boot version is not collected for Thirdparty APs, therefore it always contains the default value ("6.1.0.3").
clientCount int | Total Client Count
clientCount_2_4GHz int | Client Count on 2.4GHz Band
clientCount_5GHz int | Client Count on 5GHZ Band
controllerIpAddress String | Registered Third Party Controller IP address
controllerName String | Registered Third Party Controller name
ethernetMac String | AP Ethernet MAC Address
ipAddress String | AP IP Address
location String | AP SNMP Location
macAddress String | AP MAC Address
model String | AP Model
name String | AP Name
operationalStatus ThirdPartyApOperationalStatusEnum | AP Operational Status Allowed values REGISTERED NOTREGISTERED DOWNLOADING
serialNumber String | AP Serial Number
softwareVersion String | AP Software Version
status AlarmSeverityEnum | AP Alarm Status Allowed values CRITICAL MAJOR MINOR WARNING CLEARED INFORMATION

## 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/v1/data/ThirdpartyAccessPoints/15

    <?xml version="1.0" ?>
    <queryResponse type="ThirdpartyAccessPoints" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/ThirdpartyAccessPoints/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
      <entity dtoType="thirdpartyAccessPointsDTO" type="ThirdpartyAccessPoints" url="https://10.64.88.203/webacs/api/v1/data/ThirdpartyAccessPoints/15">
        <thirdpartyAccessPointsDTO displayName="String value" id="15" uuid="String value">
          <adminStatus>UNKNOWN</adminStatus>
          <clientCount>1</clientCount>
          <clientCount_2_4GHz>1</clientCount_2_4GHz>
          <clientCount_5GHz>1</clientCount_5GHz>
          <controllerIpAddress>String value</controllerIpAddress>
          <controllerName>String value</controllerName>
          <ethernetMac>String value</ethernetMac>
          <ipAddress>String value</ipAddress>
          <location>String value</location>
          <macAddress>String value</macAddress>
          <model>String value</model>
          <name>String value</name>
          <operationalStatus>REGISTERED</operationalStatus>
          <serialNumber>String value</serialNumber>
          <softwareVersion>String value</softwareVersion>
          <status>CRITICAL</status>
          <bootVersion>String value</bootVersion>
        </thirdpartyAccessPointsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v1/data/ThirdpartyAccessPoints/15.json

    {
      "queryResponse" : {
        "@type" : "ThirdpartyAccessPoints",
        "@responseType" : "getEntity",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/data/ThirdpartyAccessPoints/15",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/data",
        "entity" : {
          "@dtoType" : "thirdpartyAccessPointsDTO",
          "@type" : "ThirdpartyAccessPoints",
          "@url" : "https : //10.64.88.203/webacs/api/v1/data/ThirdpartyAccessPoints/15",
          "thirdpartyAccessPointsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adminStatus" : "UNKNOWN",
            "clientCount" : 1,
            "clientCount_2_4GHz" : 1,
            "clientCount_5GHz" : 1,
            "controllerIpAddress" : "String value",
            "controllerName" : "String value",
            "ethernetMac" : "String value",
            "ipAddress" : "String value",
            "location" : "String value",
            "macAddress" : "String value",
            "model" : "String value",
            "name" : "String value",
            "operationalStatus" : "REGISTERED",
            "serialNumber" : "String value",
            "softwareVersion" : "String value",
            "status" : "CRITICAL",
            "bootVersion" : "String value"
          }
        }
      }
    }

### Resource Information

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

## Resource URL

/webacs/api/v2/data/ThirdpartyAccessPoints

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Unmodified

This resource has not been modified since the previous API version.

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
adminStatus ApAdminStatusEnum | AP Admin Status Allowed values UNKNOWN ENABLE DISABLE
bootVersion String | Deprecated. AP Boot Version. The boot version is not collected for Thirdparty APs, therefore it always contains the default value ("6.1.0.3").
clientCount int | Total Client Count
clientCount_2_4GHz int | Client Count on 2.4GHz Band
clientCount_5GHz int | Client Count on 5GHZ Band
controllerIpAddress String | Registered Third Party Controller IP address
controllerName String | Registered Third Party Controller name
ethernetMac String | AP Ethernet MAC Address
ipAddress String | AP IP Address
location String | AP SNMP Location
macAddress String | AP MAC Address
model String | AP Model
name String | AP Name
operationalStatus ThirdPartyApOperationalStatusEnum | AP Operational Status Allowed values REGISTERED NOTREGISTERED DOWNLOADING
serialNumber String | AP Serial Number
softwareVersion String | AP Software Version
status AlarmSeverityEnum | AP Alarm Status Allowed values CRITICAL MAJOR MINOR WARNING CLEARED INFORMATION

## 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/v2/data/ThirdpartyAccessPoints/15

    <?xml version="1.0" ?>
    <queryResponse type="ThirdpartyAccessPoints" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/ThirdpartyAccessPoints/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
      <entity dtoType="thirdpartyAccessPointsDTO" type="ThirdpartyAccessPoints" url="https://10.64.88.203/webacs/api/v2/data/ThirdpartyAccessPoints/15">
        <thirdpartyAccessPointsDTO displayName="String value" id="15" uuid="String value">
          <adminStatus>UNKNOWN</adminStatus>
          <clientCount>1</clientCount>
          <clientCount_2_4GHz>1</clientCount_2_4GHz>
          <clientCount_5GHz>1</clientCount_5GHz>
          <controllerIpAddress>String value</controllerIpAddress>
          <controllerName>String value</controllerName>
          <ethernetMac>String value</ethernetMac>
          <ipAddress>String value</ipAddress>
          <location>String value</location>
          <macAddress>String value</macAddress>
          <model>String value</model>
          <name>String value</name>
          <operationalStatus>REGISTERED</operationalStatus>
          <serialNumber>String value</serialNumber>
          <softwareVersion>String value</softwareVersion>
          <status>CRITICAL</status>
          <bootVersion>String value</bootVersion>
        </thirdpartyAccessPointsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v2/data/ThirdpartyAccessPoints/15.json

    {
      "queryResponse" : {
        "@type" : "ThirdpartyAccessPoints",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/data/ThirdpartyAccessPoints/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "thirdpartyAccessPointsDTO",
          "@type" : "ThirdpartyAccessPoints",
          "@url" : "https://10.64.88.203/webacs/api/v2/data/ThirdpartyAccessPoints/15",
          "thirdpartyAccessPointsDTO" : {
            "@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",
            "ethernetMac" : "String value",
            "ipAddress" : "String value",
            "location" : "String value",
            "macAddress" : "String value",
            "model" : "String value",
            "name" : "String value",
            "operationalStatus" : "REGISTERED",
            "serialNumber" : "String value",
            "softwareVersion" : "String value",
            "status" : "CRITICAL"
          }
        } ]
      }
    }

### Resource Information

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

## Resource URL

/webacs/api/v3/data/ThirdpartyAccessPoints

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Unmodified

This resource has not been modified since the previous API version.

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
adminStatus ApAdminStatusEnum | AP Admin Status Allowed values UNKNOWN ENABLE DISABLE
bootVersion String | Deprecated. AP Boot Version. The boot version is not collected for Thirdparty APs, therefore it always contains the default value ("6.1.0.3").
clientCount int | Total Client Count
clientCount_2_4GHz int | Client Count on 2.4GHz Band
clientCount_5GHz int | Client Count on 5GHZ Band
controllerIpAddress String | Registered Third Party Controller IP address
controllerName String | Registered Third Party Controller name
ethernetMac String | AP Ethernet MAC Address
ipAddress String | AP IP Address
location String | AP SNMP Location
macAddress String | AP MAC Address
model String | AP Model
name String | AP Name
operationalStatus ThirdPartyApOperationalStatusEnum | AP Operational Status Allowed values REGISTERED NOTREGISTERED DOWNLOADING
serialNumber String | AP Serial Number
softwareVersion String | AP Software Version
status AlarmSeverityEnum | AP Alarm Status Allowed values CRITICAL MAJOR MINOR WARNING CLEARED INFORMATION

## 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/v3/data/ThirdpartyAccessPoints/15

    <?xml version="1.0" ?>
    <queryResponse type="ThirdpartyAccessPoints" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/ThirdpartyAccessPoints/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="thirdpartyAccessPointsDTO" type="ThirdpartyAccessPoints" url="https://10.64.88.203/webacs/api/v3/data/ThirdpartyAccessPoints/15">
        <thirdpartyAccessPointsDTO displayName="String value" id="15" uuid="String value">
          <adminStatus>UNKNOWN</adminStatus>
          <clientCount>1</clientCount>
          <clientCount_2_4GHz>1</clientCount_2_4GHz>
          <clientCount_5GHz>1</clientCount_5GHz>
          <controllerIpAddress>String value</controllerIpAddress>
          <controllerName>String value</controllerName>
          <ethernetMac>String value</ethernetMac>
          <ipAddress>String value</ipAddress>
          <location>String value</location>
          <macAddress>String value</macAddress>
          <model>String value</model>
          <name>String value</name>
          <operationalStatus>REGISTERED</operationalStatus>
          <serialNumber>String value</serialNumber>
          <softwareVersion>String value</softwareVersion>
          <status>CRITICAL</status>
          <bootVersion>String value</bootVersion>
        </thirdpartyAccessPointsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v3/data/ThirdpartyAccessPoints/15.json

    {
      "queryResponse" : {
        "@type" : "ThirdpartyAccessPoints",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/ThirdpartyAccessPoints/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "thirdpartyAccessPointsDTO",
          "@type" : "ThirdpartyAccessPoints",
          "@url" : "https://10.64.88.203/webacs/api/v3/data/ThirdpartyAccessPoints/15",
          "thirdpartyAccessPointsDTO" : {
            "@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",
            "ethernetMac" : "String value",
            "ipAddress" : "String value",
            "location" : "String value",
            "macAddress" : "String value",
            "model" : "String value",
            "name" : "String value",
            "operationalStatus" : "REGISTERED",
            "serialNumber" : "String value",
            "softwareVersion" : "String value",
            "status" : "CRITICAL"
          }
        } ]
      }
    }

### Resource Information

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

## Resource URL

/webacs/api/v4/data/ThirdpartyAccessPoints

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Updated

The bootVersion attribute was removed since the boot version is not collected for Thirdparty APs.

## Response Parameters

Attribute | Description
--- | ---
adminStatus ApAdminStatusEnum | AP Admin Status Allowed values UNKNOWN ENABLE DISABLE
clientCount int | Total Client Count
clientCount_2_4GHz int | Client Count on 2.4GHz Band
clientCount_5GHz int | Client Count on 5GHZ Band
controllerIpAddress String | Registered Third Party Controller IP address
controllerName String | Registered Third Party Controller name
ethernetMac String | AP Ethernet MAC Address
ipAddress String | AP IP Address
location String | AP SNMP Location
macAddress String | AP MAC Address
model String | AP Model
name String | AP Name
operationalStatus ThirdPartyApOperationalStatusEnum | AP Operational Status Allowed values REGISTERED NOTREGISTERED DOWNLOADING
serialNumber String | AP Serial Number
softwareVersion String | AP Software Version
status AlarmSeverityEnum | AP Alarm Status Allowed values CRITICAL MAJOR MINOR WARNING CLEARED INFORMATION

## 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/ThirdpartyAccessPoints/15

    <?xml version="1.0" ?>
    <queryResponse type="ThirdpartyAccessPoints" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/ThirdpartyAccessPoints/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="thirdpartyAccessPointsDTO" type="ThirdpartyAccessPoints" url="https://10.64.88.203/webacs/api/v4/data/ThirdpartyAccessPoints/15">
        <thirdpartyAccessPointsDTO displayName="String value" id="15" uuid="String value">
          <adminStatus>UNKNOWN</adminStatus>
          <clientCount>1</clientCount>
          <clientCount_2_4GHz>1</clientCount_2_4GHz>
          <clientCount_5GHz>1</clientCount_5GHz>
          <controllerIpAddress>String value</controllerIpAddress>
          <controllerName>String value</controllerName>
          <ethernetMac>String value</ethernetMac>
          <ipAddress>String value</ipAddress>
          <location>String value</location>
          <macAddress>String value</macAddress>
          <model>String value</model>
          <name>String value</name>
          <operationalStatus>REGISTERED</operationalStatus>
          <serialNumber>String value</serialNumber>
          <softwareVersion>String value</softwareVersion>
          <status>CRITICAL</status>
        </thirdpartyAccessPointsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "ThirdpartyAccessPoints",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/ThirdpartyAccessPoints/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "thirdpartyAccessPointsDTO",
          "@type" : "ThirdpartyAccessPoints",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/ThirdpartyAccessPoints/15",
          "thirdpartyAccessPointsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adminStatus" : "UNKNOWN",
            "clientCount" : 1,
            "clientCount_2_4GHz" : 1,
            "clientCount_5GHz" : 1,
            "controllerIpAddress" : "String value",
            "controllerName" : "String value",
            "ethernetMac" : "String value",
            "ipAddress" : "String value",
            "location" : "String value",
            "macAddress" : "String value",
            "model" : "String value",
            "name" : "String value",
            "operationalStatus" : "REGISTERED",
            "serialNumber" : "String value",
            "softwareVersion" : "String value",
            "status" : "CRITICAL"
          }
        } ]
      }
    }