WiFi Radios

The radio tab can be accessed under Monitors>Wifi tab. The radio frequencies which are operable are 2.4 GHz and 5 GHz. To display information about the particular radio, we just click on the radio and information can be accessed on multiple pages. Click on any page number and access more information. Few of the radios are editable others are not.

API Calls
Get

/V5/devices/wifiradios

Get

/V5/devices/wifiradios/{startIndex}/{pageSize}

Put

<Base_URL>/V2/analytics/associationdata/{startdate}/{enddate}

Get WiFi Radio

Description Returns all the wifi radios in the system.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/devices/wifiradios
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices/wifiradios
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains all the WiFi radios in the system. The response is in
the application/json format.

Get Filterd WiFi Radio

Description Returns a filtered list of WiFi radios.
Syntax
GET <Base_URL>/devices/wifiradios/{startIndex}/{pageSize}
  • startIndex

    Is used to specify the start index of the paged list. It takes an integer value. It is a mandatory parameter.

  • pageSize

    Is used to specify the size of the page i.e. the number of records to be returned.
    It takes an integer value. The maximum page size is 1000. It is a mandatory parameter.

  • filter

    Is used to filter the results. Click Filter to view details of how filters need to be specified in the URL.
    For possible names of property attribute, datatypes, applicable values, and whether the results can be
    sorted based on the parameter click WiFi Radio Filter.
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices/wifiradios/0/10?
filter=%0A%7B%0A%09%22property%22%3A%20%22channel%22%2C%0A%09%22value
%22%3A%20%5B6%5D%2C%0A%09%22operator%22%3A%20%22%3D%22%0A%7D
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains a paged list of wifi radios. The response is in the application/json
format.

Put APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Post APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Delete APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Test APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.
JSON Table

Attribute Data Type Description
radioId int System generated ID assigned to the Radio.
active boolean A true or false value indicating whether
the radio is active or not.
noiseFloor int Noise signal strength value in dBm.
worstClientRssi int The signal strength of worst client connected to a radio.
txPower int Transmission power in dBm.
rfUtilization int RF utilization in percentage.
protoCapability int Operation mode capabilities of the device like 802.11n, 802.11ac,
Super AG, Turbo etc.
retryRate int Retransimission rate in percentage.
upstreamUsage int Upstream data usage in KB
downstreamUsage int Downstream data usage in KB
apModeConfigured boolean The boolean value represents whether Radio is configured as AP or Sensor
protocol Enum Operating protocol of WiFiRadio. The applicable values are:

  • UNKNOWN
  • A
  • B
  • BG
channel int Channel number on which the Radio operates.
apName String Name of the AP
model String Indicates the model of the AP on which selected Radio is configured.
numberOfClients int Number of clients connected on radio
boxId int System generated unique identifier for the device
locationId application/json The ID of the location where the radio is configured. The value is of
the type Location ID JSON.
deviceTemplateId int Template ID of the template applied on the managed device.
captureFlag int It represents troubleshoot session status. The applicable values are:

  • 0 for Off
  • 1 for Pending
  • 2 for On
deviceTemplateName String Template name of the template applied on managed device.
ipAddress String IP address of device.
apMac String MAC address of device
previousLink String Link to access the previous page of WiFi radios. from the list of WiFi radios.
nextLink String Link to access next page of WiFi radios. from the list of WiFi radios.
totalCount int The total number of paged WiFi radios.

Sample JSON 
[
    {
        "radioId": 1,
        "active": false,
        "noiseFloor": 0,
        "worstClientRssi": 0,
        "txPower": 0,
        "rfUtilization": 0,
        "protoCapability": 12,
        "retryRate": 0,
        "upstreamUsage": 0,
        "downstreamUsage": 0,
        "updateFlags": -100,
        "apModeConfigured": true,
        "boxId": 3,
        "locationId": {
            "type": "locallocationid",
            "id": -1
        },
        "model": "C-75",
        "deviceTemplateId": -2,
        "captureFlag": 0,
        "deviceTemplateName": "System Template",
        "ipAddress": "192.168.10.29",
        "numberOfClients": 0,
        "apName": "Mojo_DC:4B:5F",
        "apMac": "00:11:74:DC:4B:5F",
        "channel": 0,
        "protocol": "BG"
    },
    {
        "radioId": 1,
        "active": true,
        "noiseFloor": -101,
        "worstClientRssi": 0,
        "txPower": 21,
        "rfUtilization": 2,
        "protoCapability": 3,
        "retryRate": 0,
        "upstreamUsage": 0,
        "downstreamUsage": 0,
        "updateFlags": -100,
        "apModeConfigured": true,
        "boxId": 2,
        "locationId": {
            "type": "locallocationid",
            "id": -1
        },
        "model": "C-55",
        "deviceTemplateId": -2,
        "captureFlag": 0,
        "deviceTemplateName": "System Template",
        "ipAddress": "192.168.62.43",
        "numberOfClients": 0,
        "apName": "Mojo_9C:BC:9F",
        "apMac": "00:11:74:9C:BC:9F",
        "channel": 6,
        "protocol": "BG"
    },
    {
        "radioId": 2,
        "active": false,
        "noiseFloor": 0,
        "worstClientRssi": 0,
        "txPower": 0,
        "rfUtilization": 0,
        "protoCapability": 12,
        "retryRate": 0,
        "upstreamUsage": 0,
        "downstreamUsage": 0,
        "updateFlags": -100,
        "apModeConfigured": true,
        "boxId": 2,
        "locationId": {
            "type": "locallocationid",
            "id": -1
        },
        "model": "C-55",
        "deviceTemplateId": -2,
        "captureFlag": 0,
        "deviceTemplateName": "System Template",
        "ipAddress": "192.168.62.43",
        "numberOfClients": 0,
        "apName": "Mojo_9C:BC:9F",
        "apMac": "00:11:74:9C:BC:9F",
        "channel": 0,
        "protocol": "BG"
    },
    {
        "radioId": 2,
        "active": false,
        "noiseFloor": 0,
        "worstClientRssi": 0,
        "txPower": 0,
        "rfUtilization": 0,
        "protoCapability": 19,
        "retryRate": 0,
        "upstreamUsage": 0,
        "downstreamUsage": 0,
        "updateFlags": -100,
        "apModeConfigured": true,
        "boxId": 3,
        "locationId": {
            "type": "locallocationid",
            "id": -1
        },
        "model": "C-75",
        "deviceTemplateId": -2,
        "captureFlag": 0,
        "deviceTemplateName": "System Template",
        "ipAddress": "192.168.10.29",
        "numberOfClients": 0,
        "apName": "Mojo_DC:4B:5F",
        "apMac": "00:11:74:DC:4B:5F",
        "channel": 0,
        "protocol": "A"
    }
]