What is Alarms

Use the Alarms module to retrieve asset alarms. Alarms allow you to monitor the health of an asset, the driving behaviour of the driver and entering and leaving specific locations or geofences. The alarms can be filtered based on the specified warning level: Information, Warning, and Critical. Warning level indicates the importance of the anomaly. Information represents a low-level alarm, Warning represents a medium-level alarm and Critical represents a high-level alarm. Users with appropriate rights can edit or remove alarms that are no longer required.


Base URL	<https://trailer.api.eu1.scalar.zf.com>
Audience	TRAPI
Supported Versions	V1

Why use Alarms

Purpose I: Retrieve Alarms

SCALAR allows you to retrieve a list of alarms and all alarm details. The alarm details include the alarm type, the ID of the impacted asset, the driver ID, if any, and the time at which the alarm was generated. Alarms can be configured using rules. For every alarm rule, a warning level and specific thresholds are configured.

Purpose II: Manage Alarms

SCALAR allows you to manage alarms by configuring the alarm rule thresholds according to your company requirements.

Use Cases

Use case I: Retrieve alarm list

Quickly view the exceptions based on the monitored thresholds.
Retrieve a list of all alarms with their respective alarm details.
Retrieve all details of a particular alarm.

Use case II: Generate alarms

Generate an alarm in case an asset enters a location (geofence) and notify the dispatcher. For example, configure a restricted area on the map and the dispatcher can then immediately be notified in case an asset enters that restricted area.
Generate an alarm in case an asset leaves a location (geofence) and notify the dispatcher. For example, configure a customer site on the map and the dispatcher can then immediately be notified in case an asset leaves the customer location.