Network Filter
The following table list the network filter parameters that can be used in the respective API calls. The Filter Parameters Name column lists the filter names to be used in the API call. These parameters map to the Client JSON attributes mentioned in the JSON attributes column. The column data type contains the appropriate data type for the filter parameters along with the applicable values if any. The Searchable and Sortable column, state whether the filter parameters are searchable and sortable. The value yes in these columns state them as searchable and sortable respectively.
| Filter Parameter Name | Data Type | Searchable | Sortable | JSON Attributes |
|---|---|---|---|---|
| networkname | String | Yes | Yes | name |
| networkaddress | int | Yes | Yeses | address |
| gatewaymac | String | Yes | Yes | gateWayMac |
| locationname | String | Yes | Yes | |
| networkid | int | Yes | Yes | networkId |
| monitored | Boolean | No | Yes | |
| monitoringsensors | String | Yes | Yes | monitoringSensorName |
| networktype | int The applicable values are:
|
No | Yes | networkType |
Get 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 Response Body Error codes |
| 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. |
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 Response Body Error codes |
| 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. |
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 Response Body Error codes |
| 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 Response Body Error codes |
| 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 Response Body Error codes |
| 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 Response Body Error codes |
| 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. |