api-object-access

Event Activation

Activate event generation for the selected location using this Activation Switch defines the high-level administrative settings for the selected location. It takes precedence over any conflicting policies. Event generation does not happen unless you activate it.

JSON Table

Attribute Data Type Description
policyCreatedAtLocId application/json ID of the location where policy is created. The value is of the type Location ID JSON.
policyType enum Policy type used to identify policy, for event configuration it is EVENT_CONFIGURATION_POLICY
recursiveApply boolean A true or false value indicating whether event generation is activated or deactivated at the current location.
eventGenerationActivated boolean A true or false value indicating whether the policy is to be recursively applied to all children.

Copy Sample JSON
Sample JSON
{
	"policyCreatedAtLocId": {
		"type": "locallocationid",
		"id": 0
	},
	"policyType": "EVENT_ACTIVATION_POLICY",
	"recursiveApply": false,
	"eventGenerationActivated": true
}
API Calls

/V5/configuration/locationproperty/eventactivation

/V5/configuration/locationproperty/eventactivation

Get Event Activation Configuration

Description The API is used to retrieve event activation configuration details.
Syntax
GET <Base_URL>/configuration/locationproperty/eventactivation?locationid=<value>&nodeid=<value>

Here,

  • locationid

    It is an integer value specifying the location for which the Location-Based Email settings are Configured. To retrieve the value for the Location ID refer Location JSON. It takes an integer value.

  • nodeid

    A system-generated unique ID for the child server in a cluster environment. The value for this parameter will be same as that of the childId attribute in the Location JSON. It takes an integer value.

Sample code
GET https://training.mojonetworks.com/new/webservice/v5/configuration/locationproperty
/eventactivation?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 the event activation configuration. The response is in the application/json format.

Save Event Activation Configuration

Description  The API is used to save event activation configuration details.
Syntax PUT <Base_URL>/configuration/locationproperty/eventactivation?locationid=<value>&nodeid=<value>

Here,

  • locationid

    It is an integer value specifying the location for which the Location-Based Email settings are Configured. To retrieve the value for the Location ID refer Location JSON. It takes an integer value.

  • nodeid

    A system-generated unique ID for the child server in a cluster environment. The value for this parameter will be same as that of the childId attribute in the Location JSON. It takes an integer value.

Sample code
PUT https://training.mojonetworks.com/new/webservice/v5/configuration/locationproperty
/eventactivation?locationid=0&nodeid=0
Request Body The API call requires the details of the event activation policy for configurations,
which are passed as parameters in the request body. The parameters are passed in the application/json format.A sample request body is as follows:

{
	"policyCreatedAtLocId": {
		"type": "locallocationid",
		"id": 0
	},
	"policyType": "EVENT_ACTIVATION_POLICY",
	"recursiveApply": true,
	"eventGenerationActivated": false
}
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the saved details of the event activation configuration.
The response is in the application/json format.