What is Alarm Center
Use the Alarms module to retrieve asset alarms. Alarms allow you to monitor an asset's health, the driver's driving behavior, and entering/leaving specific areas. Alarms are used to flag to alert that the subject is not under control.
| Base URL | https://alarms.api.eu1.scalar.zf.com/ |
|---|---|
| Audience | ACRAPI |
| Supported Versions | V1 |
Why use the Alarm Center
Purpose I: Retrieve Alarms
SCALAR enables you to retrieve a list of alarms and all alarm details. The alarm details include alarm type, asset ID, driver ID (if any), and the time at which the alarm was generated. Alarms can be configured using rules: the warning level and which assets to monitor can be configured for every alarm rule. Some rules also allow configuring a specific threshold.
Use Cases
Use case I: Retrieve alarm list
- Quickly view the exceptions based on the monitored thresholds.
- Retrieve a list of all alarms with alarm details.
- Retrieve all details of an alarm.
Use case II: Generate alarms to notify stakeholders
- Generate an alarm if an asset enters an area and notify the dispatcher. For example, configure a restricted area on the map so the dispatcher can immediately be notified if an asset enters that restricted area.
- Generate an alarm if an asset leaves an area and notify the dispatcher. For example, configure a customer site on the map so the dispatcher can be notified immediately if an asset leaves the customer’s location.