Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Attribute

Description

Type

Unit

Reported 

Time alarm was reported

DateTime


AlarmId

Unique Id of the alarm

Long


Category

Alarm category – options are: 

– Rule        

– System        

– Health

AlarmCategoryList


Description

Description of the alarm – normally based on the alarm category or rule message

String


Severity

Severity of the alarm – options are: 

– Threat

– Warning

– Friend

– Unknown

AlarmSeverityTypeList


State

Alarm state - options are: 

– AlarmOn

– AlarmOff

– Dismissed

AlarmStateTypeList


Priority

Indicates the level of priority based on the users requirements

Integer


Acknowledged

Indicates if the alarm has been acknowledged

Boolean


RuleId*

The id of the rule to which this alarm is associated

Integer


Highways Source Payload Attributes

Attribute

Description

Type

Unit

SubType

Highways Rule SubType – options are: 

– Person

– Stopped

– Slow

– Debris

– Reversing

– Queue

– ERA

– Enforcement

RuleSubTypeList


SectionId

Section Id in which alarm happened (note : this is the user entered Id not the system Id)

Integer


LaneId

Lane Id in which alarm happened (note : this is the user entered Id not the system Id)

Integer


CarriagewayId

Carriageway Id in which alarm happened

Integer


CarriagewayName

Carriageway Name in which alarm happened

String


...

This element contains a list of related areas. These areas are connected to the alarm, typically they will be alarm zones with real time activity that has triggered an alarm.

Area

...

Element

Attribute

Description

Type

Unit

Id

User Id of the area related to the alarm

Integer

Name

The user configured name of the area

String

...