client_connectivity_schedule

Client Connectivity Schedule

Schedules are used to update existing devices at any location except the unknown one. There are two types of schedules that can be checked: One time and recurring. To run one time schedule you need to provide the date and time for which the schedule should run and also the duration for which it will go on. Recurring schedule needs details like the days on which the schedule should run, the start time and the duration for which it will go on.

JSON Table

Attribute Data Type Description Default/Sample Value
description String It is used to add schedule. ADD
mncTemplateId int System-generated ID of the Schedule, which is created on the parent server and delivered to the child server, in the cluster mode. 0
scheduleType enum It is used to specify schedule type. Possible value are:

  • ONE_TIME
  • RECURRING
 RECURRING
scheduleRecurringType enumSet It is used to specify schedule recurring type.
Possible value are:

  • NONE
  • DAILY
  • WEEKLY
 DAILY
startTime String It is used to specify start time of the schedule. 00:00:00
startDate String Start Date of the schedule. 2017-10-07
endDate String End Date of the schedule. 2017-10-30
frequency int Frequency is the number of occurrences of a repeating schedule per unit time. 1
occursOn enum It takes list of days on which client connectivity is to be scheduled. Possible values are:

  • SUNDAY
  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
 SUNDAY, TUESDAY
testProfileId int Test profile to be used for running scheduled client connectivity test. 1
mnctemplate boolean A read-only field for internal use. false
scheduleId int System-generated ID of the schedule. 2
scheduleName String Name of the schedule. schedule sub loc 1
locationId application/json This specifies the ID of the location at which the schedule is created. The value is of the type Location ID.

Copy Sample JSON
Sample JSON 
{
    "description": "ADD ",
    "mncTemplateId": 0,
    "scheduleType": "RECURRING",
    "scheduleRecurringType": "DAILY",
    "startTime": "00:00:00",
    "startDate": "2017-10-07",
    "endDate": "2017-10-30",
    "frequency": 1,
    "occursOn":
     [
     ],
    "testProfileId": 1,
    "mnctemplate": false,
    "scheduleId": 2,
    "scheduleName": "schedule sub loc 1",
    "locationId":
     {
        "type": "locallocationid",
         "id": 0
     }
}
API Calls
Get

/V5/clientconnectivity/schedules/{scheduleId}

Get

/V5/clientconnectivity/schedules/{startIndex}/{pageSize}

Put

/V5/clientconnectivity/schedules

Put

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

Post

/V5/clientconnectivity/schedules

Delete

/V5/clientconnectivity/schedules/{scheduleId}

Get Client Connectivity Schedule

Description This API call is used to return all schedule details for specified schedule id.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/clientconnectivity/schedules/{scheduleId}?locationid=<Value>
&nodeid=<Value>

Here,

  • scheduleId

    Id of the schedule whose details are to be fetched. It takes an integer value.
    This is mandatory field.

  • locationid

    Is used to specify Location on which schedule is to be updated (this must be the location on
    which schedule was created). It takes an integer value. To retrieve the value for location id
    refer Location call.

  • nodeid

    Is used to specify child node id if the location belong to child server. It takes an integer value.
Sample code
GET
https://training.mojonetworks.com/new/webservice/V5/clientconnectivity/schedules/2?
locationid=0&nodeid=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 the list of details about specified schedule. The response is in
the application/json format.

Get Filtered Details Of Client Connectivity Schedules

Description This API call is used to return all schedule details with page size and start index.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/clientconnectivity/schedules/{startIndex}/{pageSize}?
locationid=<Value>&nodeid=<Value>

Here,

  • startIndex

    An integer value indicating the starting index for the list of schedule details.

  • pageSize

    An integer value indicating the ending index for the list of schedule details .

  • 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 boolean value. Default value
    is false.

  • filter

    Is used to filter list of client connectivity test schedule. Click Filter to view details of how filters need to be specified in the URL. For possible names of property attribute, data types, applicable values,
    and whether the results can be sorted based on the parameter click Client Connectivity Schedule Filters
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/clientconnectivity/
schedules/0/10

 

GET https://training.mojonetworks.com/new/webservice/V5/clientconnectivity/
schedules/0/10?sortcolumn=scheduleid&sortascending=false

 

GET https://192.168.55.141/new/webservice/V5/clientconnectivity/
schedules/0/10?filter%3D%7B%0A%09%22property%22%3A%20%22scheduleType
%22%2C%0A%09%22value%22%3A%20%5B%22RECURRING%22%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 the list of schedule details. The response is in the application/json
format. the response body also contains the following fields:

  • previousLink

    Link to access previous page of results. It takes a string value. Sample value, /schedules/0/10.

  • nextLink

    Link for next page of results. It takes a string value. Sample value, /schedules/0/10.

  • totalCount

    Total number of schedules. It takes an integer value. Sample value, 1.

Update Client Connectivity Schedule

Description This API call will update the schedule.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
PUT <Base_URL>/clientconnectivity/schedules?locationid=<Value>
&nodeid=<Value>

Here,

  • locationid

    It is used to specify location on which schedule is to be updated (this must be the location on
    which schedule was created). It takes an integer value. To retrieve the value for location id
    refer Location call.

  • nodeid

    Is used to specify child node id if the location belong to child server.
    It takes an integer value.
Sample code
PUT https://training.mojonetworks.com/new/webservice/V5/clientconnectivity/
schedules?locationid=0&nodeid=1
Request Body The parameters are passed in the application/json format.
You must provide the appropriate values for the following JSON attributes
for updating schedule:

  • locationId
  • description
  • mncTemplateId
  • scheduleType
  • scheduleRecurringType
  • startTime
  • startDate
  • endDate
  • frequency
  • occursOn
  • testProfileId
  • mnctemplate
  • scheduleId
  • scheduleName

A sample request will have a structure as follows:

{
   "locationId":{
		   "type": "locallocationid",
		   "id": 0
	        },
    "description": "ADD ",
    "mncTemplateId": 0,
    "scheduleType": "RECURRING",
    "scheduleRecurringType": "DAILY",
    "startTime": "",
    "startDate": "2017-10-07",
    "endDate": "2017-10-30",
    "frequency": 1,
    "occursOn": [],
    "testProfileId": 1,
    "mnctemplate": false,
    "scheduleId": 69,
    "scheduleName": "schedule sub loc 1", 
}
Response Body If the API call is successful, the HTTP response status is 200.
The response body contain updated schedule 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.

Create Client Connectivity Schedule

Description This API call will create a new schedule.
Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax
POST <Base_URL>/clientconnectivity/schedules?locationid=<Value>
&nodeid=<Value>

Here,

  • locationid

    Is used to specify location on which schedule is to be created. It takes an integer value.
    To retrieve the value for location id refer Location call.

  • nodeid

    Is used to specify child node id if the location belong to child server. It takes an
    integer value.
Sample code
POST https://training.mojonetworks.com/new/webservice/V5/clientconnectivity/schedules?
locationId=0&nodeid=1
Request Body The parameters are passed in the application/json format.
You must provide the appropriate values for the following JSON attributes
for creating schedule:

  • locationId
  • description
  • mncTemplateId
  • scheduleType
  • scheduleRecurringType
  • startTime
  • startDate
  • endDate
  • frequency
  • occursOn
  • testProfileId
  • mnctemplate
  • scheduleId
  • scheduleName

A sample request will have a structure as follows:

{
   "locationId":{
		   "type": "locallocationid",
		   "id": 0
	        },
    "description": "ADD ",
    "mncTemplateId": 0,
    "scheduleType": "RECURRING",
    "scheduleRecurringType": "DAILY",
    "startTime": "",
    "startDate": "2017-10-07",
    "endDate": "2017-10-30",
    "frequency": 1,
    "occursOn": [],
    "testProfileId": 1,
    "mnctemplate": false,
    "scheduleId": 69,
    "scheduleName": "schedule sub loc 1", 
}
Response Body If the API call is successful, the HTTP response status is 201.
The response body contain newly created schedule object. The response is in
the application/json format.

Delete Client Connectivity Schedule

Description This API call is used to delete the specified schedule.
Users with the roles can call this API: superuser, administrator, operator and viewer.
Syntax
Delete <Base_URL>/clientconnectivity/schedules/{scheduleId}

Here,

  • scheduleId

    Id of the schedule which is to be deleted. It takes an integer value.
    This is mandatory field.

  • locationid

    Is used to specify Location on which schedule is to be deleted(this must be the location on
    which schedule was created). It takes an integer value. To retrieve the value for location id refer
    Location call.

  • nodeid

    Is used to specify child node id if the location belong to child server.
    It takes an integer value.
Sample code
Delete https://training.mojonetworks.com/new/webservice/V5/clientconnectivity/schedules/2
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 204.
Response body does not content any value.

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.