api-object-access

Location-Based Events

User can configure various alerts for each location. If an alert is configured at the parent location, the same alert configuration will be applied to the child location unless user has defined different alert configuration at the child location. The location-based events call configure specific event (Alert) on the specified location.
User can configure the following types of events :

  1. Connection failure
  2. Poor App performance
  3. Association
  4. Traffic Volume
  5. Latency
  6. System
  7. Client Connectivity Test
JSON Table

Attribute Data Type Description
policyCreatedAtLocId application/json The location ID where policy was 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.
eventTypes application/json Event configuration information defined for all minor types.
eventTypes/majorType enum The three broad categories of events. The applicable values are:

  • SECURITY
  • SYSTEM
  • PERFORMANCE
  • WIFI
eventTypes/category int The applicable values are:

  • 51 – Misconfigured AP
  • 52 – DoS
  • 53 – Reconnaissance
  • 59 – Rogue AP
  • 60 – Man-in- the-Middle
  • 61 – Adhoc Network
  • 62 – Cracking
  • 65 – MAC Spoofing
  • 66 – Misbehaving Clients
  • 69 – Prevention
  • 70 – Troubleshooting
  • 71 – Sensor
  • 72 – Server
  • 80 – Coverage
  • 81 – Configuration
  • 82 – Bandwidth
  • 83 – Interference
  • 84 – Connection failure
  • 85 – Baseline
  • 86 – Application Performance
  • 87 – Client connectivity test
eventTypes/minorType int
eventTypes/minorTypeParams application/json Event configuration parameter for each configuration.
eventTypes/minorTypeParams/configId long Unique identifier for configuration, -1 or 0 signifies new configuration.
eventTypes/minorTypeParams/mncConfigId
eventTypes/minorTypeParams/modified boolean A true or false value indicating whether the attribute used to represent
configuration needs to modified or not.
eventTypes/minorTypeParams/mncEventConfigOperation
eventTypes/minorTypeParams/minorTypeAttributeValues List of MinorTypeAttribute List of configuration parameters.
eventTypes/minorTypeParams/minorTypeAttributeValues/minorTypeAttributeId enum
eventTypes/minorTypeParams/minorTypeAttributeValues/minorTypeAttributeValue String
eventTypes/notify boolean
eventTypes/vulnerable boolean
eventTypes/displayEvent boolean
eventTypes/sendMail boolean
eventTypes/severityLevel String

Copy Sample JSON
Sample JSON 
{
    "policyCreatedAtLocId": {
        "type": "locallocationid",
        "id": 0
    },
    "policyType": "EVENT_CONFIGURATION_POLICY",
    "eventTypes": [
        {
            "majorType": "SECURITY",
            "category": 51,
            "minorType": 386,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 51,
            "minorType": 613,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SYSTEM",
            "category": 71,
            "minorType": 274,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SYSTEM",
            "category": 72,
            "minorType": 276,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SYSTEM",
            "category": 70,
            "minorType": 303,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SYSTEM",
            "category": 70,
            "minorType": 327,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SYSTEM",
            "category": 71,
            "minorType": 430,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SYSTEM",
            "category": 71,
            "minorType": 491,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SYSTEM",
            "category": 71,
            "minorType": 492,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SYSTEM",
            "category": 72,
            "minorType": 341,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SYSTEM",
            "category": 71,
            "minorType": 990,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SYSTEM",
            "category": 72,
            "minorType": 275,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SYSTEM",
            "category": 72,
            "minorType": 422,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SYSTEM",
            "category": 72,
            "minorType": 423,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SYSTEM",
            "category": 72,
            "minorType": 494,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SYSTEM",
            "category": 70,
            "minorType": 450,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SYSTEM",
            "category": 70,
            "minorType": 795,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SYSTEM",
            "category": 72,
            "minorType": 506,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SYSTEM",
            "category": 72,
            "minorType": 507,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SYSTEM",
            "category": 72,
            "minorType": 533,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SYSTEM",
            "category": 71,
            "minorType": 535,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SYSTEM",
            "category": 72,
            "minorType": 994,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SYSTEM",
            "category": 70,
            "minorType": 997,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 59,
            "minorType": 281,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 59,
            "minorType": 600,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 59,
            "minorType": 340,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 59,
            "minorType": 779,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 59,
            "minorType": 516,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 51,
            "minorType": 301,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 51,
            "minorType": 306,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 499,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 265,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 266,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 299,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 51,
            "minorType": 614,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 51,
            "minorType": 615,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 361,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 498,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 323,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 798,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 799,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 508,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 780,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 991,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 800,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 992,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 61,
            "minorType": 610,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 61,
            "minorType": 791,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 61,
            "minorType": 792,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 61,
            "minorType": 517,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 51,
            "minorType": 785,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 51,
            "minorType": 606,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 51,
            "minorType": 783,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 51,
            "minorType": 515,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 607,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 608,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 609,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 611,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 612,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 603,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 330,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 66,
            "minorType": 796,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 60,
            "minorType": 602,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 60,
            "minorType": 906,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 60,
            "minorType": 264,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 60,
            "minorType": 788,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 258,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 259,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 604,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 392,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 251,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 252,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 253,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 254,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 255,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 256,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 257,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 260,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 261,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 262,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 263,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "WIFI",
            "category": 89,
            "minorType": 1018,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "WIFI",
            "category": 88,
            "minorType": 1019,
            "minorTypeParams": [
                {
                    "configId": 3,
                    "mncConfigId": 0,
                    "modified": false,
                    "mncEventConfigOperation": null,
                    "minorTypeAttributeValues": [
                        {
                            "minorTypeAttributeId": "SCHEDULED_CLIENT_CONNECTIVITY_SCHEDULE_ID",
                            "minorTypeAttributeValue": "0"
                        },
                        {
                            "minorTypeAttributeId": "SCHEDULED_CLIENT_CONNECTIVITY_SCHEDULE_NAME",
                            "minorTypeAttributeValue": ""
                        }
                    ]
                }
            ],
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "WIFI",
            "category": 89,
            "minorType": 1020,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 52,
            "minorType": 391,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 65,
            "minorType": 601,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 65,
            "minorType": 820,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 65,
            "minorType": 502,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 65,
            "minorType": 989,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 69,
            "minorType": 490,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 69,
            "minorType": 826,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 69,
            "minorType": 831,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 69,
            "minorType": 834,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 53,
            "minorType": 268,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 53,
            "minorType": 400,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 53,
            "minorType": 605,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "LOW"
        },
        {
            "majorType": "SECURITY",
            "category": 53,
            "minorType": 269,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 53,
            "minorType": 537,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 62,
            "minorType": 500,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SECURITY",
            "category": 62,
            "minorType": 318,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 62,
            "minorType": 319,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SECURITY",
            "category": 62,
            "minorType": 534,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": true,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SYSTEM",
            "category": 71,
            "minorType": 999,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SYSTEM",
            "category": 71,
            "minorType": 1001,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "SYSTEM",
            "category": 71,
            "minorType": 1007,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": false,
            "severityLevel": "MEDIUM"
        },
        {
            "majorType": "SYSTEM",
            "category": 72,
            "minorType": 1021,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "WIFI",
            "category": 84,
            "minorType": 1013,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": false,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "WIFI",
            "category": 85,
            "minorType": 1014,
            "minorTypeParams": null,
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "WIFI",
            "category": 87,
            "minorType": 1015,
            "minorTypeParams": null,
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "WIFI",
            "category": 87,
            "minorType": 1016,
            "minorTypeParams": [
                {
                    "configId": 4,
                    "mncConfigId": 0,
                    "modified": false,
                    "mncEventConfigOperation": null,
                    "minorTypeAttributeValues": [
                        {
                            "minorTypeAttributeId": "NO_OF_ASSOCIATION_AT_COUNT",
                            "minorTypeAttributeValue": "100"
                        }
                    ]
                }
            ],
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        },
        {
            "majorType": "WIFI",
            "category": 86,
            "minorType": 1017,
            "minorTypeParams": [
                {
                    "configId": 7,
                    "mncConfigId": 0,
                    "modified": false,
                    "mncEventConfigOperation": null,
                    "minorTypeAttributeValues": [
                        {
                            "minorTypeAttributeId": "AVERAGE_LATENCY_COUNT",
                            "minorTypeAttributeValue": "1"
                        },
                        {
                            "minorTypeAttributeId": "AVERAGE_LATENCY_COUNT_UNIT",
                            "minorTypeAttributeValue": "AVERAGE_LATENCY_UNIT_MILLISECONDS"
                        },
                        {
                            "minorTypeAttributeId": "AVERAGE_LATENCY_NAME",
                            "minorTypeAttributeValue": "AVERAGE_LATENCY_TYPE_DHCP_LATENCY"
                        },
                        {
                            "minorTypeAttributeId": "AVERAGE_LATENCY_SSID",
                            "minorTypeAttributeValue": ""
                        },
                        {
                            "minorTypeAttributeId": "AVERAGE_LATENCY_FREQUENCY_BAND",
                            "minorTypeAttributeValue": "LATENCY_FREQUENCY_BAND_2_4_GHZ"
                        }
                    ]
                }
            ],
            "notify": false,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        }
    ]
}
API Calls
Get

/V5/configuration/locationbased/events

Put

/V5/configuration/locationbased/events

Post

/V5/configuration/locationbased/events

Delete

/V5/configuration/locationbased/events

Get Location-Based Events

Description The API is used to retrieve event configuration details.
Syntax
GET <Base_URL>/configuration/locationbased/events?isdefault=<value>&locationid=<value>&nodeid=<value>

Here,

  • isdefault

    When we pass this parameter as true then system default configuration for that location is return else whatever user has defined is returned. It takes a boolean value. The default value is false.

  • 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/locationbased/events?isdefault=true&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 configuration details like location details, policy type, and events configuration are retrieved in the application/json format. Policy type is EVENT_CONFIGURATION_POLICY in this case.

Save Location-Based Events

Description This API is used to save or update event configuration.
Syntax
PUT <Base_URL>/configuration/locationbased/events?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/locationbased/events?locationid=0&nodeid=0
Request Body This API call requires the details of the event configurations to be updated, which is 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_CONFIGURATION_POLICY",
	"eventTypes": [{
            "majorType": "WIFI",
            "category": 84,
            "minorType": 1013,
            "minorTypeParams": [
                {
                    "configId": 76,
                    "modified":true,
                    "minorTypeAttributeValues": [
                        {
                            "minorTypeAttributeId": "CLIENT_FAILURE_REASON",
                            "minorTypeAttributeValue": "CLIENT_FAILURE_REASON_ASSOCIATION"
                        },
                        {
                            "minorTypeAttributeId": "NO_OF_CLIENT_IN_FAILURE",
                            "minorTypeAttributeValue": "50"
                        }
                    ]
                }
            ],
            "notify": true,
            "vulnerable": false,
            "displayEvent": true,
            "sendMail": true,
            "severityLevel": "HIGH"
        }

]

]
}
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the details of the updated event configuration details. The response is in the application/json format.

Customize Location-Based Events

Description The API is used to customize event configurations.
Syntax
POST  <Base_URL>/configuration/locationbased/events?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
POST https://training.mojonetworks.com/new/webservice/V5/configuration/locationbased/events?locationid=1&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 customized event configuration. The response is in the application/json format.

Delete Location-Based Configuration

Description The API is used to delete event configuration.
Syntax
DELETE <Base_URL>/configuration/locationbased/events?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
DELETE https://training.mojonetworks.com/new/webservice/V5/configuration/locationbased/events?locationid=1&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 204.
The response body does not contain any other information.

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.