Adhoc Association
Adhoc is a communication mode that helps the computers to interact with each other without a router. In general, there is no need of setting up a base for flowing the message communication among the computers. This communication can be based on many configurations like the cell ID or MAC address.
Attribute | Data Type | Description |
---|---|---|
cellId | String | Cell ID related with the adhoc association. |
protocol | String | Associated 802.11 protocol. The applicable values are:
|
ssid | String | SSID related to the adhoc association. |
channel | int | Channel number on which the devices in the association operates. |
clients | List of strings | MAC addresses of the clients participating in the association. |
{ "cellId":"34:23:12:65:78:34", "protocol":"BG", "ssid":null, "channel":0, "clients":["11:55:22:33:34:21","00:11:22:33:44:55"] }
Get Adhoc Associations
Description | This API is used to fetch adhoc associations for a specified cell ID and MAC address from the Mojo Server or the Arista Cloud Services. Users with the roles can call this API: superuser, administrator, operator, and viewer. |
---|---|
Syntax |
GET <Base_URL>/associations/adhoc?cellid=<Value>&macaddress=<Value>
Here,
At least one of the two parameters must be specified. |
Sample code |
GET https://training.mojonetworks.com/new/webservice/V5/associations
/adhoc?cellid=34:23:12:65:78:34 |
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 the adhoc association details. 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 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. |