Location Timezone Policy

When a server cluster is created and a child server is mounted on a mount point, the child server retains the policies that were previously applied to it. It does not inherit the parent server policies, by default. If you want to apply the parent server policies to child servers, you must navigate to the individual policy and inherit the policy from the parent server. The same applies to location time zone policy.

JSON Table

Parameter	Data Type	Description
policyCreatedAtLocId	application/json	ID of the location at which the policy has been defined. For details about the JSON, click Location ID.
policyType	String	A read-only field for internal use.
timezoneId	String	Timezone ID. For example, UTC and GMT.
locationTag	String	Location tag for the location.
recursiveApply	boolean	A true or false value indicating whether the changes in the policy must be applied to all sub-locations. This field is only applicable to Save policy, not to the Get policy. True indicates that the changes in the policy apply to all sub-locations.

Sample JSON

{
    "policyCreatedAtLocId": {
        "type": "locallocationid",
        "id": 0
    },
    "policyType": "LOCATION_TIMEZONE",
    "timezoneId": "Asia/Calcutta",
    "locationTag": "",
    "recursiveApply": false
}

API Calls

Get

/V5/policies/locationtimezone

Put

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

Post

/V5/policies/locationtimezone

Get Location Timezone Policy

Description	This API is used to fetch the Location Timezone Policy at a specified location from Wireless Manager or Arista Cloud Services. Users with the roles can call this API: superuser, administrator, operator, and viewer.
Syntax	Get <Base_URL>/policies/locationtimezone?locationid=<value>&nodeid=<value> Here, locationid It is an integer value specifying the location for which the Location Timezone Policy is fetched. To retrieve the value for location id refer Location call. nodeid It is an integer value specifying the node in a server cluster setup. fetch_factory_default Is a boolean value specifying whether factory default policies will be fetched or user-defined policies. If set to true the factory default policies are fetched, and if set to false user-defined policies are fetched.
Sample code	Get https://training.mojonetworks.com/new/webservice/V5/policies /locationtimezone?locationid=0&nodeid=0
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 details of Location Timezone Policy. 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.

Modify Location Timezone Policy

Description	This API is used to modify Location Timezone Policy at a specified location in Wireless Manager or Arista Cloud Services. Users with the roles can call this API:superuser, administrator, operator, and viewer.
Syntax	POST <Base_URL>/policies/locationtimezone?locationid=<value>&nodeid=<value> Here, locationid It is an integer value specifying the location for which the Location Timezone Policy is modified. To retrieve the value for location id refer Location call. nodeid It is an integer value specifying the node in a server cluster setup.
Sample code	POST https://training.mojonetworks.com/new/webservice/v5/policies/ locationtimezone?locationid=0&nodeid=0
Request Body	This API call requires the modified details of the Location Timezone Policy , which are passed as parameters in the request body. The parameters are passed in the application/json format. You must provide the appropriate values for the mandatory JSON attributes. timezoneId recursiveApply A sample request will have a structure as follows: { ... List of Location Timezone Policy with mandatory attributes . ... }
Response Body	If the API call is successful, the HTTP response status is 204. The response body does not contain any information.

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.

Understand Arista Cloud Architecture

Know what Arista APIs can do

Know how Arista APIs work?

API Reference

Location Timezone Policy