rule/

rule is

{
"id": ${int},
"name": ${string},
"description": ${string},
"zone_id": ${int},
"trackers": [ ${int}, ... ], // list of tracker ids
"type": ${string},
"primary_text": ${string},
"secondary_text": ${string},
"param": ${int}, // common parameter
"alerts": {
"sms_phones": [ ${string}, ... ],
"phones": [ ${string}, ... ], // phones for voice calls
"emails": [ ${string}, ... ],
"push_enabled": ${boolean}
},
"suspended": ${boolean},
"schedule": [ ${schedule_interval}, ... ],
"extended_params": ${extended_params}, // optional. object specified for concrete rule type
"auto_created": ${boolean} // optional
}

where schedule_interval is on of:

  • weekly_schedule_interval
{
"type": "weekly",
"from": ${weekday_time},
"to": ${weekday_time},
"interval_id": ${int}
}
  • fixed_schedule_interval
{
"type": "weekly",
"from": ${date/time},
"to": ${date/time},
"interval_id": ${int}
}

Where weekday_time is:

{
"weekday": ${int}, // from 1 to 7
"time": ${local_time} // for example: "01:00:00"
}

extended_params for:

  • any rule
    can include following fields
{
"zone_limit_inverted": ${boolean} // optional
}
  • type=”autocontrol”
    Map of subrules settings.
{
"alarmcontrol": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true,
"always_notify": false
},
"battery_off": {
"enabled": true,
"sms": true,
"call": false,
"email": true,
"push": true
},
"door_alarm": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true
},
"hood_alarm": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true
},
"ignition": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true
},
"parking": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true
},
"gsm_damp": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true
},
"security_control": {
"enabled": true,
"sms": false,
"call": false,
"email": true,
"push": true
}
}
  • sensor_range
{
"sensor_id": 123,
"min": 1.0, // (double) optional. null means negative infinity
"max": 3.0, // (double) optional. null means positive infinity
"threshold": 0.03 // (double) optional
}

date/time and local_time types described in custom types description.

If you have more questions please contact our support team

Contacts

USA: +1 858 815 9045

Mexico: +52 334 1642158

UK: +44 808 1641499

Germany: +49 1573 5988250

Russia: +7 495 223 0427

Log in

Login

[clean-login]

CLOSE
Register

[clean-login-register]

CLOSE
Loading...