Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
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/data/RadioDetails
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
adminStatus
RadioAdminStatusEnum
|
Administrative status of the radio interface
|
alarmStatus
AlarmSeverityEnum
|
|
antennaAzimAngle
Float
|
Displays the horizontal angle of the antenna
|
antennaDiversity
String
|
Displays if antenna diversity is enabled or disabled. Antenna diversity refers to the access point sampling the radio signal from two integrated antenna ports to choose the preferred antenna.
Allowed values: 'Connector A', 'Connector B', 'Enabled', 'NA'
|
antennaElevAngle
Float
|
Displays the elevation angle of the antenna.
|
antennaGain
Integer
|
The external antenna gain, measured in 0.5 dBi units. This is the raw value from device. It is different from displayed in the UI. An integer value 7 means 7 x 0.5 = 3.5 dBm of gain.
|
antennaMode
String
|
Displays the antenna mode. Allowed values: Sector A, Sector B, Omni, NA (non-applicable).
|
antennaName
String
|
|
antennaType
String
|
Antenna type. Allowed values: Internal, External, Circular, Linear, NA
|
apIpAddress
String
|
IP address of the access point
|
apName
String
|
|
baseRadioMac
String
|
|
channelControl
String
|
Radio channel control. Allowed values: Automatic, Custom, NA
|
channelNumber
Integer
|
Current operational channel number
|
channelWidth
String
|
Channel width. Allowed values: 5 MHz, 10 MHz, 20 MHz, 40 MHz, 80 MHz, 160 MHz, Above 40 MHz, Below 40 MHz, NA
|
cleanAirCapable
String
|
Capability of clean air feature. Allowed values: Yes, No
|
cleanAirSensorStatus
String
|
Clean air sensor status. Allowed values: Up, Down, NA
|
cleanAirStatus
String
|
Clean air status. Allowed values: Yes, No
|
clientCount
String
|
Client count connected to the radio interface
|
controllerIpAddress
String
|
Registered controller IP address for CAPWAP AP only
|
dot11nCapable
boolean
|
|
ethernetMac
String
|
MAC address of the ethernet interface on the AP
|
operStatus
RadioOperStatusEnum
|
Operational status of the radio interface
|
port
int
|
|
powerLevel
Integer
|
|
radioBand
RadioBandEnum
|
Radio band of the radio interface
|
radioRole
RadioRoleEnum
|
|
radioType
String
|
Radio type of the interface. Allowed values: 802.11a, 802.11ac, 802.11a/n, 802.11a/n/ac, 802.11a/n/ac/ax, 802.11b/g, 802.11b/g/n, 802.11b/g/n/ax, 802.11a/b/g/n, 802.11a/b/g/n/ac, 802.11a/b/g/n/ac/ax, XOR (Monitor Mode), XOR (2.4GHz), XOR (5GHz), UWB, BLE, Unknown
|
slotId
Integer
|
Slot ID of the radio in the AP
|
txPowerControl
String
|
Tranmission power control. Allowed values: Automatic, Custom, NA
|
txPowerOutput
Integer
|
The txPower currently being used to transmit data, in dBm
|
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://172.20.127.108/webacs/api/v1/data/RadioDetails/15
<?xml version="1.0" ?>
<queryResponse type="RadioDetails" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v1/data/RadioDetails/15" rootUrl="https://172.20.127.108/webacs/api/v1/data">
<entity dtoType="radioDetailsDTO" type="RadioDetails" url="https://172.20.127.108/webacs/api/v1/data/RadioDetails/15">
<radioDetailsDTO displayName="String value" id="15" uuid="String value">
<adminStatus>UNKNOWN</adminStatus>
<alarmStatus>CRITICAL</alarmStatus>
<antennaAzimAngle>15.0</antennaAzimAngle>
<antennaElevAngle>15.0</antennaElevAngle>
<antennaGain>15</antennaGain>
<antennaName>String value</antennaName>
<apName>String value</apName>
<dot11nCapable>true</dot11nCapable>
<operStatus>DOWN</operStatus>
<port>1</port>
<powerLevel>15</powerLevel>
<radioBand>2.4 GHz</radioBand>
<radioRole>SHUTDOWN</radioRole>
<slotId>15</slotId>
<txPowerOutput>15</txPowerOutput>
<antennaDiversity>String value</antennaDiversity>
<antennaMode>String value</antennaMode>
<antennaType>String value</antennaType>
<apIpAddress>String value</apIpAddress>
<baseRadioMac>String value</baseRadioMac>
<channelControl>String value</channelControl>
<channelNumber>15</channelNumber>
<channelWidth>String value</channelWidth>
<cleanAirCapable>String value</cleanAirCapable>
<cleanAirSensorStatus>String value</cleanAirSensorStatus>
<cleanAirStatus>String value</cleanAirStatus>
<clientCount>String value</clientCount>
<controllerIpAddress>String value</controllerIpAddress>
<ethernetMac>String value</ethernetMac>
<radioType>String value</radioType>
<txPowerControl>String value</txPowerControl>
</radioDetailsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://172.20.127.108/webacs/api/v1/data/RadioDetails/15.json
{
"queryResponse" : {
"@type" : "RadioDetails",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data\/RadioDetails\/15",
"@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "radioDetailsDTO",
"@type" : "RadioDetails",
"@url" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data\/RadioDetails\/15",
"radioDetailsDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"adminStatus" : "UNKNOWN",
"alarmStatus" : "CRITICAL",
"antennaAzimAngle" : 15,
"antennaElevAngle" : 15,
"antennaGain" : 15,
"antennaName" : "String value",
"apName" : "String value",
"dot11nCapable" : true,
"operStatus" : "DOWN",
"port" : 1,
"powerLevel" : 15,
"radioBand" : "2.4 GHz",
"radioRole" : "SHUTDOWN",
"slotId" : 15,
"txPowerOutput" : 15,
"antennaDiversity" : "String value",
"antennaMode" : "String value",
"antennaType" : "String value",
"apIpAddress" : "String value",
"baseRadioMac" : "String value",
"channelControl" : "String value",
"channelNumber" : 15,
"channelWidth" : "String value",
"cleanAirCapable" : "String value",
"cleanAirSensorStatus" : "String value",
"cleanAirStatus" : "String value",
"clientCount" : "String value",
"controllerIpAddress" : "String value",
"ethernetMac" : "String value",
"radioType" : "String value",
"txPowerControl" : "String value"
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/RadioDetails
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
adminStatus
RadioAdminStatusEnum
|
Administrative status of the radio interface
|
alarmStatus
AlarmSeverityEnum
|
|
antennaAzimAngle
Float
|
Displays the horizontal angle of the antenna
|
antennaDiversity
String
|
Displays if antenna diversity is enabled or disabled. Antenna diversity refers to the access point sampling the radio signal from two integrated antenna ports to choose the preferred antenna.
Allowed values: 'Connector A', 'Connector B', 'Enabled', 'NA'
|
antennaElevAngle
Float
|
Displays the elevation angle of the antenna.
|
antennaGain
Integer
|
The external antenna gain, measured in 0.5 dBi units. This is the raw value from device. It is different from displayed in the UI. An integer value 7 means 7 x 0.5 = 3.5 dBm of gain.
|
antennaMode
String
|
Displays the antenna mode. Allowed values: Sector A, Sector B, Omni, NA (non-applicable).
|
antennaName
String
|
|
antennaType
String
|
Antenna type. Allowed values: Internal, External, Circular, Linear, NA
|
apIpAddress
String
|
IP address of the access point
|
apName
String
|
|
baseRadioMac
String
|
|
channelControl
String
|
Radio channel control. Allowed values: Automatic, Custom, NA
|
channelNumber
Integer
|
Current operational channel number
|
channelWidth
String
|
Channel width. Allowed values: 5 MHz, 10 MHz, 20 MHz, 40 MHz, 80 MHz, 160 MHz, Above 40 MHz, Below 40 MHz, NA
|
cleanAirCapable
String
|
Capability of clean air feature. Allowed values: Yes, No
|
cleanAirSensorStatus
String
|
Clean air sensor status. Allowed values: Up, Down, NA
|
cleanAirStatus
String
|
Clean air status. Allowed values: Yes, No
|
clientCount
String
|
Client count connected to the radio interface
|
controllerIpAddress
String
|
Registered controller IP address for CAPWAP AP only
|
dot11nCapable
boolean
|
|
ethernetMac
String
|
MAC address of the ethernet interface on the AP
|
operStatus
RadioOperStatusEnum
|
Operational status of the radio interface
|
port
int
|
|
powerLevel
Integer
|
|
radioBand
RadioBandEnum
|
Radio band of the radio interface
|
radioRole
RadioRoleEnum
|
|
radioType
String
|
Radio type of the interface. Allowed values: 802.11a, 802.11ac, 802.11a/n, 802.11a/n/ac, 802.11a/n/ac/ax, 802.11b/g, 802.11b/g/n, 802.11b/g/n/ax, 802.11a/b/g/n, 802.11a/b/g/n/ac, 802.11a/b/g/n/ac/ax, XOR (Monitor Mode), XOR (2.4GHz), XOR (5GHz), UWB, BLE, Unknown
|
slotId
Integer
|
Slot ID of the radio in the AP
|
txPowerControl
String
|
Tranmission power control. Allowed values: Automatic, Custom, NA
|
txPowerOutput
Integer
|
The txPower currently being used to transmit data, in dBm
|
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://172.20.127.108/webacs/api/v2/data/RadioDetails/15
<?xml version="1.0" ?>
<queryResponse type="RadioDetails" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v2/data/RadioDetails/15" rootUrl="https://172.20.127.108/webacs/api/v2/data">
<entity dtoType="radioDetailsDTO" type="RadioDetails" url="https://172.20.127.108/webacs/api/v2/data/RadioDetails/15">
<radioDetailsDTO displayName="String value" id="15" uuid="String value">
<adminStatus>UNKNOWN</adminStatus>
<alarmStatus>CRITICAL</alarmStatus>
<antennaAzimAngle>15.0</antennaAzimAngle>
<antennaElevAngle>15.0</antennaElevAngle>
<antennaGain>15</antennaGain>
<antennaName>String value</antennaName>
<apName>String value</apName>
<dot11nCapable>true</dot11nCapable>
<operStatus>DOWN</operStatus>
<port>1</port>
<powerLevel>15</powerLevel>
<radioBand>2.4 GHz</radioBand>
<radioRole>SHUTDOWN</radioRole>
<slotId>15</slotId>
<txPowerOutput>15</txPowerOutput>
<antennaDiversity>String value</antennaDiversity>
<antennaMode>String value</antennaMode>
<antennaType>String value</antennaType>
<apIpAddress>String value</apIpAddress>
<baseRadioMac>String value</baseRadioMac>
<channelControl>String value</channelControl>
<channelNumber>15</channelNumber>
<channelWidth>String value</channelWidth>
<cleanAirCapable>String value</cleanAirCapable>
<cleanAirSensorStatus>String value</cleanAirSensorStatus>
<cleanAirStatus>String value</cleanAirStatus>
<clientCount>String value</clientCount>
<controllerIpAddress>String value</controllerIpAddress>
<ethernetMac>String value</ethernetMac>
<radioType>String value</radioType>
<txPowerControl>String value</txPowerControl>
</radioDetailsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://172.20.127.108/webacs/api/v2/data/RadioDetails/15.json
{
"queryResponse" : {
"@type" : "RadioDetails",
"@requestUrl" : "https://172.20.127.108/webacs/api/v2/data/RadioDetails/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://172.20.127.108/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "radioDetailsDTO",
"@type" : "RadioDetails",
"@url" : "https://172.20.127.108/webacs/api/v2/data/RadioDetails/15",
"radioDetailsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"adminStatus" : "UNKNOWN",
"alarmStatus" : "CRITICAL",
"antennaAzimAngle" : 15.0,
"antennaDiversity" : "String value",
"antennaElevAngle" : 15.0,
"antennaGain" : 15,
"antennaMode" : "String value",
"antennaName" : "String value",
"antennaType" : "String value",
"apIpAddress" : "String value",
"apName" : "String value",
"baseRadioMac" : "String value",
"channelControl" : "String value",
"channelNumber" : 15,
"channelWidth" : "String value",
"cleanAirCapable" : "String value",
"cleanAirSensorStatus" : "String value",
"cleanAirStatus" : "String value",
"clientCount" : "String value",
"controllerIpAddress" : "String value",
"dot11nCapable" : true,
"ethernetMac" : "String value",
"operStatus" : "DOWN",
"port" : 1,
"powerLevel" : 15,
"radioBand" : "2.4 GHz",
"radioRole" : "SHUTDOWN",
"radioType" : "String value",
"slotId" : 15,
"txPowerControl" : "String value",
"txPowerOutput" : 15
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/RadioDetails
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
adminStatus
RadioAdminStatusEnum
|
Administrative status of the radio interface
|
alarmStatus
AlarmSeverityEnum
|
|
antennaAzimAngle
Float
|
Displays the horizontal angle of the antenna
|
antennaDiversity
String
|
Displays if antenna diversity is enabled or disabled. Antenna diversity refers to the access point sampling the radio signal from two integrated antenna ports to choose the preferred antenna.
Allowed values: 'Connector A', 'Connector B', 'Enabled', 'NA'
|
antennaElevAngle
Float
|
Displays the elevation angle of the antenna.
|
antennaGain
Integer
|
The external antenna gain, measured in 0.5 dBi units. This is the raw value from device. It is different from displayed in the UI. An integer value 7 means 7 x 0.5 = 3.5 dBm of gain.
|
antennaMode
String
|
Displays the antenna mode. Allowed values: Sector A, Sector B, Omni, NA (non-applicable).
|
antennaName
String
|
|
antennaType
String
|
Antenna type. Allowed values: Internal, External, Circular, Linear, NA
|
apIpAddress
String
|
IP address of the access point
|
apName
String
|
|
baseRadioMac
String
|
|
channelControl
String
|
Radio channel control. Allowed values: Automatic, Custom, NA
|
channelNumber
Integer
|
Current operational channel number
|
channelWidth
String
|
Channel width. Allowed values: 5 MHz, 10 MHz, 20 MHz, 40 MHz, 80 MHz, 160 MHz, Above 40 MHz, Below 40 MHz, NA
|
cleanAirCapable
String
|
Capability of clean air feature. Allowed values: Yes, No
|
cleanAirSensorStatus
String
|
Clean air sensor status. Allowed values: Up, Down, NA
|
cleanAirStatus
String
|
Clean air status. Allowed values: Yes, No
|
clientCount
String
|
Client count connected to the radio interface
|
controllerIpAddress
String
|
Registered controller IP address for CAPWAP AP only
|
dot11nCapable
boolean
|
|
ethernetMac
String
|
MAC address of the ethernet interface on the AP
|
operStatus
RadioOperStatusEnum
|
Operational status of the radio interface
|
port
int
|
|
powerLevel
Integer
|
|
radioBand
RadioBandEnum
|
Radio band of the radio interface
|
radioRole
RadioRoleEnum
|
|
radioType
String
|
Radio type of the interface. Allowed values: 802.11a, 802.11ac, 802.11a/n, 802.11a/n/ac, 802.11a/n/ac/ax, 802.11b/g, 802.11b/g/n, 802.11b/g/n/ax, 802.11a/b/g/n, 802.11a/b/g/n/ac, 802.11a/b/g/n/ac/ax, XOR (Monitor Mode), XOR (2.4GHz), XOR (5GHz), UWB, BLE, Unknown
|
slotId
Integer
|
Slot ID of the radio in the AP
|
txPowerControl
String
|
Tranmission power control. Allowed values: Automatic, Custom, NA
|
txPowerOutput
Integer
|
The txPower currently being used to transmit data, in dBm
|
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://172.20.127.108/webacs/api/v3/data/RadioDetails/15
<?xml version="1.0" ?>
<queryResponse type="RadioDetails" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v3/data/RadioDetails/15" rootUrl="https://172.20.127.108/webacs/api/v3/data">
<entity dtoType="radioDetailsDTO" type="RadioDetails" url="https://172.20.127.108/webacs/api/v3/data/RadioDetails/15">
<radioDetailsDTO displayName="String value" id="15" uuid="String value">
<adminStatus>UNKNOWN</adminStatus>
<alarmStatus>CRITICAL</alarmStatus>
<antennaAzimAngle>15.0</antennaAzimAngle>
<antennaElevAngle>15.0</antennaElevAngle>
<antennaGain>15</antennaGain>
<antennaName>String value</antennaName>
<apName>String value</apName>
<dot11nCapable>true</dot11nCapable>
<operStatus>DOWN</operStatus>
<port>1</port>
<powerLevel>15</powerLevel>
<radioBand>2.4 GHz</radioBand>
<radioRole>SHUTDOWN</radioRole>
<slotId>15</slotId>
<txPowerOutput>15</txPowerOutput>
<antennaDiversity>String value</antennaDiversity>
<antennaMode>String value</antennaMode>
<antennaType>String value</antennaType>
<apIpAddress>String value</apIpAddress>
<baseRadioMac>String value</baseRadioMac>
<channelControl>String value</channelControl>
<channelNumber>15</channelNumber>
<channelWidth>String value</channelWidth>
<cleanAirCapable>String value</cleanAirCapable>
<cleanAirSensorStatus>String value</cleanAirSensorStatus>
<cleanAirStatus>String value</cleanAirStatus>
<clientCount>String value</clientCount>
<controllerIpAddress>String value</controllerIpAddress>
<ethernetMac>String value</ethernetMac>
<radioType>String value</radioType>
<txPowerControl>String value</txPowerControl>
</radioDetailsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://172.20.127.108/webacs/api/v3/data/RadioDetails/15.json
{
"queryResponse" : {
"@type" : "RadioDetails",
"@requestUrl" : "https://172.20.127.108/webacs/api/v3/data/RadioDetails/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://172.20.127.108/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "radioDetailsDTO",
"@type" : "RadioDetails",
"@url" : "https://172.20.127.108/webacs/api/v3/data/RadioDetails/15",
"radioDetailsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"adminStatus" : "UNKNOWN",
"alarmStatus" : "CRITICAL",
"antennaAzimAngle" : 15.0,
"antennaDiversity" : "String value",
"antennaElevAngle" : 15.0,
"antennaGain" : 15,
"antennaMode" : "String value",
"antennaName" : "String value",
"antennaType" : "String value",
"apIpAddress" : "String value",
"apName" : "String value",
"baseRadioMac" : "String value",
"channelControl" : "String value",
"channelNumber" : 15,
"channelWidth" : "String value",
"cleanAirCapable" : "String value",
"cleanAirSensorStatus" : "String value",
"cleanAirStatus" : "String value",
"clientCount" : "String value",
"controllerIpAddress" : "String value",
"dot11nCapable" : true,
"ethernetMac" : "String value",
"operStatus" : "DOWN",
"port" : 1,
"powerLevel" : 15,
"radioBand" : "2.4 GHz",
"radioRole" : "SHUTDOWN",
"radioType" : "String value",
"slotId" : 15,
"txPowerControl" : "String value",
"txPowerOutput" : 15
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/RadioDetails
Updated
Since version 4 types of attributes apIpAddress, controllerIpAddress, channelNumber, clientCount have been changed.
Response Parameters
adminStatus
RadioAdminStatusEnum
|
Administrative status of the radio interface
|
alarmStatus
AlarmSeverityEnum
|
|
antennaAzimAngle
Float
|
Displays the horizontal angle of the antenna
|
antennaDiversity
AntennaDiversityEnum
|
Displays if antenna diversity is enabled or disabled. Antenna diversity refers to the access point sampling the radio signal from two integrated antenna ports to choose the preferred antenna.
|
antennaElevAngle
Float
|
Displays the elevation angle of the antenna.
|
antennaGain
Integer
|
The external antenna gain, measured in 0.5 dBi units. This is the raw value from device. It is different from displayed in the UI. An integer value 7 means 7 x 0.5 = 3.5 dBm of gain.
|
antennaMode
AntennaModeEnum
|
Displays the antenna mode such as Omni, Directional, or NA (non-applicable).
|
antennaName
String
|
|
antennaType
AntennaTypeEnum
|
|
apIpAddress
InetAddress
|
IP address of the access point
|
apName
String
|
|
baseRadioMac
MacAddress
|
|
channelControl
ChannelAssignmentEnum
|
|
channelNumber
ChannelNumberEnum
|
Current operational channel number
|
channelWidth
ChannelBandwidthEnum
|
|
cleanAirCapable
Boolean
|
Capability of clean air feature.
|
cleanAirSensorStatus
CleanAirSensorStatus
|
|
cleanAirStatus
Boolean
|
Clean air enablement status.
|
clientCount
int
|
Client count connected to the radio interface
|
controllerIpAddress
InetAddress
|
Registered controller IP address for CAPWAP AP only
|
dot11nCapable
boolean
|
|
ethernetMac
MacAddress
|
MAC address of the ethernet interface on the AP
|
operStatus
RadioOperStatusEnum
|
Operational status of the radio interface
|
port
int
|
|
powerLevel
Integer
|
|
radioBand
RadioBandEnum
|
Radio band of the radio interface
|
radioRole
RadioRoleEnum
|
|
radioType
UnifiedRadioTypeEnum
|
Radio type ot the interface
|
slotId
Integer
|
Slot ID of the radio in the AP
|
txPowerControl
TxPowerControlEnum
|
Tranmission power control
|
txPowerOutput
Integer
|
The txPower currently being used to transmit data, in dBm
|
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://172.20.127.108/webacs/api/v4/data/RadioDetails/15
<?xml version="1.0" ?>
<queryResponse type="RadioDetails" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v4/data/RadioDetails/15" rootUrl="https://172.20.127.108/webacs/api/v4/data">
<entity dtoType="radioDetailsDTO" type="RadioDetails" url="https://172.20.127.108/webacs/api/v4/data/RadioDetails/15">
<radioDetailsDTO displayName="String value" id="15" uuid="String value">
<adminStatus>UNKNOWN</adminStatus>
<alarmStatus>CRITICAL</alarmStatus>
<antennaAzimAngle>15.0</antennaAzimAngle>
<antennaElevAngle>15.0</antennaElevAngle>
<antennaGain>15</antennaGain>
<antennaName>String value</antennaName>
<apName>String value</apName>
<dot11nCapable>true</dot11nCapable>
<operStatus>DOWN</operStatus>
<port>1</port>
<powerLevel>15</powerLevel>
<radioBand>2.4 GHz</radioBand>
<radioRole>SHUTDOWN</radioRole>
<slotId>15</slotId>
<txPowerOutput>15</txPowerOutput>
<antennaDiversity>CONNECTOR_A</antennaDiversity>
<antennaMode>SECTOR_A</antennaMode>
<antennaType>INTERNAL</antennaType>
<apIpAddress>
<address>192.168.115.243</address>
</apIpAddress>
<baseRadioMac>
<octets>000a959d6816</octets>
</baseRadioMac>
<channelControl>UNKNOWN</channelControl>
<channelNumber>UNKNOWN</channelNumber>
<channelWidth>5 MHz</channelWidth>
<cleanAirCapable>true</cleanAirCapable>
<cleanAirSensorStatus>UP</cleanAirSensorStatus>
<cleanAirStatus>true</cleanAirStatus>
<clientCount>1</clientCount>
<controllerIpAddress>
<address>192.168.115.243</address>
</controllerIpAddress>
<ethernetMac>
<octets>000a959d6816</octets>
</ethernetMac>
<radioType>802.11a</radioType>
<txPowerControl>UNKNOWN</txPowerControl>
</radioDetailsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://172.20.127.108/webacs/api/v4/data/RadioDetails/15.json
{
"queryResponse" : {
"@type" : "RadioDetails",
"@requestUrl" : "https://172.20.127.108/webacs/api/v4/data/RadioDetails/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://172.20.127.108/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "radioDetailsDTO",
"@type" : "RadioDetails",
"@url" : "https://172.20.127.108/webacs/api/v4/data/RadioDetails/15",
"radioDetailsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"adminStatus" : "UNKNOWN",
"alarmStatus" : "CRITICAL",
"antennaAzimAngle" : 15.0,
"antennaDiversity" : "CONNECTOR_A",
"antennaElevAngle" : 15.0,
"antennaGain" : 15,
"antennaMode" : "SECTOR_A",
"antennaName" : "String value",
"antennaType" : "INTERNAL",
"apIpAddress" : {
"address" : "192.168.115.243"
},
"apName" : "String value",
"baseRadioMac" : {
"octets" : "000a959d6816"
},
"channelControl" : "UNKNOWN",
"channelNumber" : "UNKNOWN",
"channelWidth" : "5 MHz",
"cleanAirCapable" : true,
"cleanAirSensorStatus" : "UP",
"cleanAirStatus" : true,
"clientCount" : 1,
"controllerIpAddress" : {
"address" : "192.168.115.243"
},
"dot11nCapable" : true,
"ethernetMac" : {
"octets" : "000a959d6816"
},
"operStatus" : "DOWN",
"port" : 1,
"powerLevel" : 15,
"radioBand" : "2.4 GHz",
"radioRole" : "SHUTDOWN",
"radioType" : "802.11a",
"slotId" : 15,
"txPowerControl" : "UNKNOWN",
"txPowerOutput" : 15
}
} ]
}
}