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/HistoricalRFStats
Response Parameters
channelNumber
ChannelNumberEnum
|
Channel number that the radio is operating on
|
channelUtilization
int
|
|
clientCount
int
|
Number of associated clients
|
collectionTime
String
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
coverageProfile
RFProfileEnum
|
|
ethernetMac
String
|
MAC address of the ethernet interface on the AP
|
interferenceProfile
RFProfileEnum
|
|
loadProfile
RFProfileEnum
|
|
macAddress
String
|
|
noiseProfile
RFProfileEnum
|
|
operStatus
RadioOperStatusEnum
|
|
poorCoverageClients
int
|
|
powerLevel
int
|
|
rxUtilization
int
|
|
slotId
String
|
|
txUtilization
int
|
|
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.78.83.125/webacs/api/v1/data/HistoricalRFStats/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalRFStats" responseType="getEntity" requestUrl="https://10.78.83.125/webacs/api/v1/data/HistoricalRFStats/15" rootUrl="https://10.78.83.125/webacs/api/v1/data">
<entity dtoType="historicalRFStatsDTO" type="HistoricalRFStats" url="https://10.78.83.125/webacs/api/v1/data/HistoricalRFStats/15">
<historicalRFStatsDTO displayName="String value" id="15" uuid="String value">
<channelNumber>UNKNOWN</channelNumber>
<clientCount>1</clientCount>
<coverageProfile>FAILED</coverageProfile>
<interferenceProfile>FAILED</interferenceProfile>
<loadProfile>FAILED</loadProfile>
<noiseProfile>FAILED</noiseProfile>
<operStatus>DOWN</operStatus>
<powerLevel>1</powerLevel>
<channelUtilization>1</channelUtilization>
<collectionTime>String value</collectionTime>
<ethernetMac>String value</ethernetMac>
<macAddress>String value</macAddress>
<poorCoverageClients>1</poorCoverageClients>
<rxUtilization>1</rxUtilization>
<slotId>String value</slotId>
<txUtilization>1</txUtilization>
</historicalRFStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.78.83.125/webacs/api/v1/data/HistoricalRFStats/15.json
{
"queryResponse" : {
"@type" : "HistoricalRFStats",
"@responseType" : "getEntity",
"@requestUrl" : "https : //10.78.83.125/webacs/api/v1/data/HistoricalRFStats/15",
"@rootUrl" : "https : //10.78.83.125/webacs/api/v1/data",
"entity" : {
"@dtoType" : "historicalRFStatsDTO",
"@type" : "HistoricalRFStats",
"@url" : "https : //10.78.83.125/webacs/api/v1/data/HistoricalRFStats/15",
"historicalRFStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelNumber" : "UNKNOWN",
"clientCount" : 1,
"coverageProfile" : "FAILED",
"interferenceProfile" : "FAILED",
"loadProfile" : "FAILED",
"noiseProfile" : "FAILED",
"operStatus" : "DOWN",
"powerLevel" : 1,
"channelUtilization" : 1,
"collectionTime" : "String value",
"ethernetMac" : "String value",
"macAddress" : "String value",
"poorCoverageClients" : 1,
"rxUtilization" : 1,
"slotId" : "String value",
"txUtilization" : 1
}
}
}
}
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/HistoricalRFStats
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
channelNumber
ChannelNumberEnum
|
Channel number that the radio is operating on
|
channelUtilization
int
|
|
clientCount
int
|
Number of associated clients
|
collectionTime
String
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
coverageProfile
RFProfileEnum
|
|
ethernetMac
String
|
MAC address of the ethernet interface on the AP
|
interferenceProfile
RFProfileEnum
|
|
loadProfile
RFProfileEnum
|
|
macAddress
String
|
|
noiseProfile
RFProfileEnum
|
|
operStatus
RadioOperStatusEnum
|
|
poorCoverageClients
int
|
|
powerLevel
int
|
|
rxUtilization
int
|
|
slotId
String
|
|
txUtilization
int
|
|
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.78.83.125/webacs/api/v2/data/HistoricalRFStats/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalRFStats" responseType="getEntity" requestUrl="https://10.78.83.125/webacs/api/v2/data/HistoricalRFStats/15" rootUrl="https://10.78.83.125/webacs/api/v2/data">
<entity dtoType="historicalRFStatsDTO" type="HistoricalRFStats" url="https://10.78.83.125/webacs/api/v2/data/HistoricalRFStats/15">
<historicalRFStatsDTO displayName="String value" id="15" uuid="String value">
<channelNumber>UNKNOWN</channelNumber>
<clientCount>1</clientCount>
<coverageProfile>FAILED</coverageProfile>
<interferenceProfile>FAILED</interferenceProfile>
<loadProfile>FAILED</loadProfile>
<noiseProfile>FAILED</noiseProfile>
<operStatus>DOWN</operStatus>
<powerLevel>1</powerLevel>
<channelUtilization>1</channelUtilization>
<collectionTime>String value</collectionTime>
<ethernetMac>String value</ethernetMac>
<macAddress>String value</macAddress>
<poorCoverageClients>1</poorCoverageClients>
<rxUtilization>1</rxUtilization>
<slotId>String value</slotId>
<txUtilization>1</txUtilization>
</historicalRFStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.78.83.125/webacs/api/v2/data/HistoricalRFStats/15.json
{
"queryResponse" : {
"@type" : "HistoricalRFStats",
"@requestUrl" : "https://10.78.83.125/webacs/api/v2/data/HistoricalRFStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.78.83.125/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "historicalRFStatsDTO",
"@type" : "HistoricalRFStats",
"@url" : "https://10.78.83.125/webacs/api/v2/data/HistoricalRFStats/15",
"historicalRFStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelNumber" : "UNKNOWN",
"channelUtilization" : 1,
"clientCount" : 1,
"collectionTime" : "String value",
"coverageProfile" : "FAILED",
"ethernetMac" : "String value",
"interferenceProfile" : "FAILED",
"loadProfile" : "FAILED",
"macAddress" : "String value",
"noiseProfile" : "FAILED",
"operStatus" : "DOWN",
"poorCoverageClients" : 1,
"powerLevel" : 1,
"rxUtilization" : 1,
"slotId" : "String value",
"txUtilization" : 1
}
} ]
}
}
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/HistoricalRFStats
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
channelNumber
ChannelNumberEnum
|
Channel number that the radio is operating on
|
channelUtilization
int
|
|
clientCount
int
|
Number of associated clients
|
collectionTime
String
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
coverageProfile
RFProfileEnum
|
|
ethernetMac
String
|
MAC address of the ethernet interface on the AP
|
interferenceProfile
RFProfileEnum
|
|
loadProfile
RFProfileEnum
|
|
macAddress
String
|
|
noiseProfile
RFProfileEnum
|
|
operStatus
RadioOperStatusEnum
|
|
poorCoverageClients
int
|
|
powerLevel
int
|
|
rxUtilization
int
|
|
slotId
String
|
|
txUtilization
int
|
|
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.78.83.125/webacs/api/v3/data/HistoricalRFStats/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalRFStats" responseType="getEntity" requestUrl="https://10.78.83.125/webacs/api/v3/data/HistoricalRFStats/15" rootUrl="https://10.78.83.125/webacs/api/v3/data">
<entity dtoType="historicalRFStatsDTO" type="HistoricalRFStats" url="https://10.78.83.125/webacs/api/v3/data/HistoricalRFStats/15">
<historicalRFStatsDTO displayName="String value" id="15" uuid="String value">
<channelNumber>UNKNOWN</channelNumber>
<clientCount>1</clientCount>
<coverageProfile>FAILED</coverageProfile>
<interferenceProfile>FAILED</interferenceProfile>
<loadProfile>FAILED</loadProfile>
<noiseProfile>FAILED</noiseProfile>
<operStatus>DOWN</operStatus>
<powerLevel>1</powerLevel>
<channelUtilization>1</channelUtilization>
<collectionTime>String value</collectionTime>
<ethernetMac>String value</ethernetMac>
<macAddress>String value</macAddress>
<poorCoverageClients>1</poorCoverageClients>
<rxUtilization>1</rxUtilization>
<slotId>String value</slotId>
<txUtilization>1</txUtilization>
</historicalRFStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.78.83.125/webacs/api/v3/data/HistoricalRFStats/15.json
{
"queryResponse" : {
"@type" : "HistoricalRFStats",
"@requestUrl" : "https://10.78.83.125/webacs/api/v3/data/HistoricalRFStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.78.83.125/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "historicalRFStatsDTO",
"@type" : "HistoricalRFStats",
"@url" : "https://10.78.83.125/webacs/api/v3/data/HistoricalRFStats/15",
"historicalRFStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelNumber" : "UNKNOWN",
"channelUtilization" : 1,
"clientCount" : 1,
"collectionTime" : "String value",
"coverageProfile" : "FAILED",
"ethernetMac" : "String value",
"interferenceProfile" : "FAILED",
"loadProfile" : "FAILED",
"macAddress" : "String value",
"noiseProfile" : "FAILED",
"operStatus" : "DOWN",
"poorCoverageClients" : 1,
"powerLevel" : 1,
"rxUtilization" : 1,
"slotId" : "String value",
"txUtilization" : 1
}
} ]
}
}
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/HistoricalRFStats
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
channelNumber
ChannelNumberEnum
|
Channel number that the radio is operating on
|
channelUtilization
int
|
|
clientCount
int
|
Number of associated clients
|
collectionTime
String
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
coverageProfile
RFProfileEnum
|
|
ethernetMac
String
|
MAC address of the ethernet interface on the AP
|
interferenceProfile
RFProfileEnum
|
|
loadProfile
RFProfileEnum
|
|
macAddress
String
|
|
noiseProfile
RFProfileEnum
|
|
operStatus
RadioOperStatusEnum
|
|
poorCoverageClients
int
|
|
powerLevel
int
|
|
rxUtilization
int
|
|
slotId
String
|
|
txUtilization
int
|
|
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.78.83.125/webacs/api/v4/data/HistoricalRFStats/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalRFStats" responseType="getEntity" requestUrl="https://10.78.83.125/webacs/api/v4/data/HistoricalRFStats/15" rootUrl="https://10.78.83.125/webacs/api/v4/data">
<entity dtoType="historicalRFStatsDTO" type="HistoricalRFStats" url="https://10.78.83.125/webacs/api/v4/data/HistoricalRFStats/15">
<historicalRFStatsDTO displayName="String value" id="15" uuid="String value">
<channelNumber>UNKNOWN</channelNumber>
<clientCount>1</clientCount>
<coverageProfile>FAILED</coverageProfile>
<interferenceProfile>FAILED</interferenceProfile>
<loadProfile>FAILED</loadProfile>
<noiseProfile>FAILED</noiseProfile>
<operStatus>DOWN</operStatus>
<powerLevel>1</powerLevel>
<channelUtilization>1</channelUtilization>
<collectionTime>String value</collectionTime>
<ethernetMac>String value</ethernetMac>
<macAddress>String value</macAddress>
<poorCoverageClients>1</poorCoverageClients>
<rxUtilization>1</rxUtilization>
<slotId>String value</slotId>
<txUtilization>1</txUtilization>
</historicalRFStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.78.83.125/webacs/api/v4/data/HistoricalRFStats/15.json
{
"queryResponse" : {
"@type" : "HistoricalRFStats",
"@requestUrl" : "https://10.78.83.125/webacs/api/v4/data/HistoricalRFStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.78.83.125/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "historicalRFStatsDTO",
"@type" : "HistoricalRFStats",
"@url" : "https://10.78.83.125/webacs/api/v4/data/HistoricalRFStats/15",
"historicalRFStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelNumber" : "UNKNOWN",
"channelUtilization" : 1,
"clientCount" : 1,
"collectionTime" : "String value",
"coverageProfile" : "FAILED",
"ethernetMac" : "String value",
"interferenceProfile" : "FAILED",
"loadProfile" : "FAILED",
"macAddress" : "String value",
"noiseProfile" : "FAILED",
"operStatus" : "DOWN",
"poorCoverageClients" : 1,
"powerLevel" : 1,
"rxUtilization" : 1,
"slotId" : "String value",
"txUtilization" : 1
}
} ]
}
}