Skip to content

Rule

A rule element consists of following fields:

Rule object

{
    "id": 1,
    "name": "rule",
    "description": "description",
    "zone_ids": [12, 15],
    "trackers": [123456, 234567],
    "type": "alarmcontrol",
    "primary_text": "ON",
    "secondary_text": "OFF",
    "param": 1,
    "alerts": {
      "sms_phones": ["98829991"],
      "phones": ["98829991"],
      "emails": ["[email protected]"],
      "push_enabled": true
    },
    "suspended": false,
    "schedule": [{
      "type":"weekly",
      "from":{"weekday":1,"time":"00:00:00"},
      "to":{"weekday":7,"time":"23:59:59"}],
    "extended_params": {
      "alarmcontrol": {
      "enabled": true,
      "sms": false,
      "call": false,
      "email": true,
      "push": true,
      "always_notify": false
    },
    "auto_created": true
}
  • id - int. An id of a rule.
  • name - string. Name of a rule.
  • description - string. Rule's description.
  • zone_ids - array of int. List of geofence ids.
  • trackers - array of int. List of bound tracker ids.
  • type - enum. One of pre-defined types of rules. See rule types.
  • primary_text - string. Primary text of rule notification.
  • secondary_text - string. Secondary text of rule notification.
  • param - int. A common parameter. See rule types.
  • alerts - object with destinations for notifications.
    • sms_phones - array of string. Phones for SMS notifications.
    • phones - array of string. Phones for voice calls.
    • emails - array of string. Emails for notifications.
    • push_enabled - boolean. If true push notifications available.
  • suspended - boolean. true if the rule suspended.
  • shedule - optional object. The rule will work in specified period.
  • extended_params - optional. An object specified for concrete rule type. See rule types.
  • auto_created - optional, boolean. true means that the rule created automatically.

  • schedule_interval is one of:

    • weekly_schedule_interval

    {
      "type": "weekly",
      "from": <weekday_time>,
      "to": <weekday_time>,
      "interval_id": 1
    }
    
    * fixed_schedule_interval

    {
      "type": "fixed",
      "from": "2014-07-09 07:50:58",
      "to": "2014-07-10 07:50:58",
      "interval_id": 3
    }
    

    where weekday_time is:

    {
        "weekday": 1,
        "time": "01:00:00"
    }
    
  • date/time and local_time types described at the data types description section.

API actions

API base path: /tracker/rule

bind

Binds rule with rule_id to trackers list.

required sub-user rights: tracker_rule_update

parameters

name description type format
rule_id Id of a rule. int 10
trackers Ids of trackers. Trackers which do not exist, owned by other user or deleted ignored without errors. [999199, 999119]

examples

curl -X POST 'https://api.navixy.com/v2/tracker/rule/bind' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "rule_id": "123", "trackers":[265489]}'

response

{ "success": true }

errors

  • 201 (Not found in the database) – if rule with rule_id does not exist or owned by other user.

create

Creates rule and scheduled intervals.

required sub-user rights: tracker_rule_update

parameters

examples

curl -X POST 'https://api.navixy.com/v2/tracker/rule/create' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "rule": {"description":"","type":"work_status_change","primary_text":"status changed","secondary_text":"","alerts":{"push_enabled":true,"emails":["[email protected]"],"emergency":false,"sms_phones":["745494878945"],"phones":[]},"suspended":"","append_zone_title":"","name":"Status changing","trackers":[123456],"extended_params":{"emergency":false,"zone_limit_inverted":false,"status_ids":[319281,319282,319283]},"param":"","schedule":[{"from":{"weekday":1,"time":"00:00:00"},"to":{"weekday":7,"time":"23:59:59"},"type":"weekly"}],"zone_ids":[],"group_id":1}}'

response

{
    "success": true,
    "id": 123
}
  • id - int. An id of created rule.

errors

  • 204 (Entity not found) – when associated zone is not exists.

delete

Deletes rule with rule_id and all related objects from the database.

required sub-user rights: tracker_rule_update

parameters

name description type format
rule_id Id of a rule. int 10

examples

curl -X POST 'https://api.navixy.com/v2/tracker/rule/delete' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "rule_id": "123"}'
https://api.navixy.com/v2/tracker/rule/delete?hash=a6aa75587e5c59c32d347da438505fc3&rule_id=123

response

{ "success": true }

errors

  • 201 (Not found in the database) – if rule with rule_id does not exist or owned by other user.

list

List tracker rules bound to tracker with an id=tracker_id or all users' tracker rules if tracker_id not passed.

examples

curl -X POST 'https://api.navixy.com/v2/tracker/rule/list' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3"}'
https://api.navixy.com/v2/tracker/rule/list?hash=a6aa75587e5c59c32d347da438505fc3

response

{
   "success": true,
   "list": [{
        "id": 1,
        "name": "rule",
        "description": "description",
        "zone_ids": [12, 15],
        "trackers": [123456, 234567],
        "type": "alarmcontrol",
        "primary_text": "ON",
        "secondary_text": "OFF",
        "param": 1,
        "alerts": {
          "sms_phones": ["98829991"],
          "phones": ["98829991"],
          "emails": ["[email protected]"],
          "push_enabled": true
        },
        "suspended": false,
        "schedule": [{
          "type":"weekly",
          "from":{"weekday":1,"time":"00:00:00"},
          "to":{"weekday":7,"time":"23:59:59"}],
        "extended_params": {
          "alarmcontrol": {
          "enabled": true,
          "sms": false,
          "call": false,
          "email": true,
          "push": true,
          "always_notify": false
        },
        "auto_created": true
   }]
}
  • list - list of rules

unbind

Unbinds trackers from rule with rule_id.

required sub-user rights: tracker_rule_update

parameters

name description type format
rule_id Id of a rule. int 10
trackers Ids of trackers. Trackers which do not exist, owned by other user or deleted ignored without errors. [999199, 999119]

examples

curl -X POST 'https://api.navixy.com/v2/tracker/rule/unbind' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "rule_id": "123", "trackers":[265489]}'

response

{ "success": true }

errors

  • 201 (Not found in the database) – if rule with rule_id does not exist or owned by other user.

update

Updates rule and scheduled intervals.

required sub-user rights: tracker_rule_update

parameters

examples

curl -X POST 'https://api.navixy.com/v2/tracker/rule/update' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "a6aa75587e5c59c32d347da438505fc3", "rule": {"description":"","type":"work_status_change","primary_text":"status changed","secondary_text":"","alerts":{"push_enabled":true,"emails":["[email protected]"],"emergency":false,"sms_phones":["745494878945"],"phones":[]},"suspended":"","append_zone_title":"","name":"Status changing","trackers":[123456],"extended_params":{"emergency":false,"zone_limit_inverted":false,"status_ids":[319281,319282,319283]},"param":"","schedule":[{"from":{"weekday":1,"time":"00:00:00"},"to":{"weekday":7,"time":"23:59:59"},"type":"weekly"}],"zone_ids":[],"group_id":1}}'

response

{ "success": true }

errors

  • 201 (Not found in the database) – if rule is not exists or owned by other user.
  • 204 (Entity not found) – when new associated zone is not exists.

Last update: October 23, 2020