client-connectivity-sessions

Client Connectivity Sessions

Client connectivity sessions allows to impart information about the sessions that are connected to a client.

JSON Table

Attribute Data Type Description
sessionId int System generated integer value to identify Client Connectivity session.
testProfileId int Profile ID of Client Connectivitiy test profile.
targetAPMac String Mac Address of target AP on which test is to be executed.
targetAPProtocol enum Protocol of target AP.
targetClientMac String Mac Address of AP which will act as client in client connectivity test.
startTime long Session start time in number of milliseconds.
stopTime long Session stop time in number of milliseconds.
sessionName
sessionStatus String Possible values for session status :

  • CL_CONNEC_NOT_STARTED,
  • CL_CONNEC_FAILED,
  • CL_CONNEC_RUNNING,
  • CL_CONNEC_COMPLETED,
  • CL_CONNEC_TIMEOUT
ssid String SSID profile name.
testProfileName String
targetApName String Name of the target AP.
testResult boolean
failureReasonCode int Failure reason code set by the server
scheduleId int Schedule id for which this session was started.
clientName String Name of the client.
targetApRssi int Signal strength observed by the client
sessionType enum It Is used to determine if a Client connectivity test session is created
manually or through a schedule.
localStartTime String Local time with respect to location timezone at which this session was
started.

Copy Sample JSON
Sample JSON 
    
  { 
      "sessionId": 2,
      "testProfileId": 2,
      "targetAPMac": "00:11:74:F2:29:E0",
      "targetAPProtocol": "A",
      "targetClientMac": "00:11:74:40:2A:82",
      "startTime": 0,
      "stopTime": 0,
      "sessionName": "test name 2",
      "sessionStatus": "CL_CONNEC_NOT_STARTED",
      "ssid": "ssid",
      "testProfileName": "test profile 1",
      "targetApName": "Mojo_F2:29:E0",
      "clientName": "Mojo_40:2A:82",
      "targetApRssi": 3,
      "locationId":
          {
             "type": "locallocationid",
             "id": 0
          },
      "sessionType": "MANUAL",
      "scheduleId": 1,
      "localStartTime": "2017-06-04 12:23:24",
      "testResult": true,
      "failureReasonCode": 0
  }
API Calls
Get

/V5/troubleshoot/clientconnectivity/sessions

Get

/V5/troubleshoot/clientconnectivity/sessions/{startIndex}/{pageSize}

Delete

/V5/troubleshoot/clientconnectivity/sessions/{sessionid}

Get All Client Connectivity Sessions Details

Description This API is used to fetch all client connectivity test session details.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/troubleshoot/clientconnectivity/sessions
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/troubleshoot
/clientconnectivity/sessions
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 client connectivity test session details. The response is in
the application/json format.

Get Filtered Details Of Client Connectivity Sessions

Description This API is used to fetch a filtered details of client connectivity test session.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/troubleshoot/clientconnectivity/sessions/{startIndex}/
{pageSize}?sortcolumn=<Value>&sortascending=<Value>&filter=<Value>

Here,

  • startIndex

    An integer value indicating the starting index for the client connectivity test session.

  • pageSize

    An integer value indicating the ending index for the client connectivity test session.
    Maximum page size is 1000.

  • sortcolumn

    Is used to specify sort column. It takes an integer value. Default value is scheduleid.

  • sortascending

    Is used to specify sort direction. It takes a boolean value. Default value is true.

  • filter

    Is used to filter list of client connectivity test sessions. 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 Client connectivity session filter.
Sample code
GET
https://training.mojonetworks.com/new/webservice/V5/troubleshoot/
clientconnectivity/sessions/0/10?sortcolumn=scheduleid&filter=
%7B%0A%09%22property%22%3A%20%22scheduleid%22%2C%0A%09%22operator
%22%3A%20%22%3D%22%2C%0A%09%22value%22%3A%20%5B2%5D%0A%7D&
filter=%7B%0A%09%22property%22%3A%20%22localstarttime%22%2C%0A%09%22
operator%22%3A%20%22%3D%22%2C%0A%09%22value%22%3A%20%5B%222017-06-04%
2012%3A23%3A24%22%5D%0A%7D

 

GET
https://training.mojonetworks.com/new/webservice/V5/troubleshoot/
clientconnectivity/sessions/0/50?sortby=scheduleid&filter
%3D%0A%7B%0A%09%22property%22%3A%20%22scheduleid%22%2C%0A%09%22
value%22%3A%20%5B%222%22%5D%2C%0A%09%22operator
%22%3A%20%22%3D%22%0A%7D%26sortdescending%3Dtrue
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 client connectivity test session 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
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.

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 Client Connectivity Sessions

Description This API is used to delete client connectivity session results.
Users with the roles can call this API: superuser, administrator, operator and viewer.
Syntax
DELETE <Base_URL>/troubleshoot/clientconnectivity/sessions/{sessionid}

Here,

  • sessionId

    System generated integer value to identify Client Connectivity session.
    It takes an integer value.
Sample code
DELETE https://training.mojonetworks.com/new/webservice/V5/troubleshoot/
clientconnectivity/sessions/1
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 session ID of the deleted session. The response is in
the application/json format.
A sample response is as follows:

{
	"sessionId": 16
}

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.