What is Alert Setting?
Alert settings switch each alert type on or off for your organization and set the limit each alert type fires on. These endpoints are served under/api/v4.
GET /alert-setting returns the effective limits under thresholds: the defaults, unless your organization changed them. PUT /alert-setting accepts the switch flags (including lowBattery, lowBatteryNotification, driverOffline and driverOfflineNotification) and these optional limits, each a whole number:
A value that is not a whole number or is outside its range returns
400 with failedCode alert-009, and nothing is saved. A new limit applies to detections after it is saved; alerts already recorded do not change. The number of location updates in a row (consecutivePings) and the repeat time (repeatMinutes) are fixed. For low battery, thresholds.lowBattery returns percent (the limit), resetPercent (the limit plus 10) and repeatMinutes (30). For driver offline, thresholds.driverOffline returns minutes (the limit).
Key Features
Read alert setting
GET /alert-setting
Update alert setting
PUT /alert-setting