AlarmStatus

Use the AlarmStatus web service to retrieve the current status of one or more alarms or to update the status of an alarm.

URI

http://<hostname>/ws/AlarmStatus

Formats

HTTP method	Format	Description
GET	/ws/AlarmStatus	Get statuses for all current alarms.
GET	/ws/AlarmStatus/{almId}	Get statuses for a specific alarm.
PUT	/ws/AlarmStatus/{almId}/{almsSourceEntityId}	Update the alarm status.

Elements

id

Unique identifier for the alarm status that consists of two elements:

ID Element	Description
almId	System-generated identifier for the alarm.
almsSourceEntityId	System-generated identifier for the entity associated with the alarm status, such as a device or task.

almsStatus

Current status of the alarm:

Status value	Description
0	Alarm is reset.
1	Alarm is triggered.
2	Alarm is acknowledged.

almsTopic

Topic for the alarm.

cstId

Remote Manager identifier for the customer.

almsUpdateTime

Time at which the alarm status was last updated (ISO 8601 standard format).

almsPayload

Payload associated with the status change for the alarm in XML format. The payload can be any event object in the system that caused the status of the alarm to change. Typically, the payload is a web services object, such as a monitor or device core object.

Get Status for All Alarms

The following sample request shows how to get a list of all alarm statuses for all alarms.

Request

GET ws/AlarmStatus

Response

<?xml version="1.0" encoding="UTF-8"?>
<result>
   <resultTotalRows>4</resultTotalRows>
   <requestedStartRow>0</requestedStartRow>
   <resultSize>4</resultSize>
   <requestedSize>1000</requestedSize>
   <remainingSize>0</remainingSize>
   <AlarmStatus>
      <id>
         <almId>142</almId>   <!-- alarm 142 almId #1 -->
         <almsSourceEntityId>46911</almsSourceEntityId>
      </id>
      <almsStatus>2</almsStatus>
      <almsTopic>Alarm.System.Monitor.inactive</almsTopic>
      <cstId>2</cstId>
      <almsUpdateTime>2012-06-27T21:02:09.567Z</almsUpdateTime>
      <almsPayload>
         <Payload>
            <Message>Monitor disconnected: node left the cluster</Message>
            <Monitor>
               <monId>46911</monId>
               <cstId>2</cstId>
               <monLastConnect>2012-06-27T17:08:27.457Z</monLastConnect>
               <monTopic>AlarmTemplate,Alarm,AlarmStatus,DeviceCore,XbeeCore</monTopic>
               <monTransportType>alarm</monTransportType>
               <monFormatType>xml</monFormatType>
               <monBatchSize>100</monBatchSize>
               <monCompression>none</monCompression>
               <monStatus>1</monStatus>
               <monBatchDuration>10</monBatchDuration>
            </Monitor>
         </Payload>
      </almsPayload>
   </AlarmStatus>
   <AlarmStatus>
      <id>
         <almId>142</almId>   <!-- alarm 142 almId #2 -->
         <almsSourceEntityId>Monitor:46911</almsSourceEntityId>
      </id>
      <almsStatus>0</almsStatus>
      <almsTopic>Alarm.System.Monitor.active</almsTopic>
      <cstId>2</cstId>
      <almsUpdateTime>2012-06-27T22:01:40.953Z</almsUpdateTime>
      <almsPayload>
         <Payload>
            <Message>Monitor connected</Message>
            <Monitor>
               <monId>46911</monId>
               <cstId>2</cstId>
               <monLastConnect>2012-06-27T21:39:50.833Z</monLastConnect>
               <monTopic>AlarmStatus,AlarmTemplate,Notification,Alarm</monTopic>
               <monTransportType>alarm</monTransportType>
               <monFormatType>xml</monFormatType>
               <monBatchSize>100</monBatchSize>
               <monCompression>none</monCompression>
               <monStatus>0</monStatus>
               <monBatchDuration>10</monBatchDuration>
            </Monitor>
         </Payload>
      </almsPayload>
   </AlarmStatus>
   <AlarmStatus>
      <id>
         <almId>151</almId>   <!-- alarm 151 almId #1 -->
         <almsSourceEntityId>00000000-00000000-00409DFF-FF441634</almsSourceEntityId>
      </id>
      <almsStatus>1</almsStatus>
      <almsTopic>Alarm.DeviceOffline</almsTopic>
      <cstId>2</cstId>
      <almsUpdateTime>2012-07-02T15:25:57.387Z</almsUpdateTime>
      <almsPayload>
         <Payload>
            <DeviceCore>
               <id>
                  <devId>11116</devId>
                  <devVersion>0</devVersion>
               </id>
               <devRecordStartDate>2012-07-02T13:27:00.000Z</devRecordStartDate>
               <devMac>00:40:9D:44:16:34</devMac>
               <devConnectwareId>00000000-00000000-00409DFF-FF441634</devConnectwareId>
               <cstId>2</cstId>
               <grpId>2</grpId>
               <devEffectiveStartDate>2012-07-02T13:27:00.000Z</devEffectiveStartDate>
               <devTerminated>false</devTerminated>
               <dvVendorId>4261412867</dvVendorId>
               <dpDeviceType>CPX2e SE</dpDeviceType>
               <dpFirmwareLevel>50331744</dpFirmwareLevel>
               <dpFirmwareLevelDesc>3.0.0.96</dpFirmwareLevelDesc>
               <dpRestrictedStatus>0</dpRestrictedStatus>
               <dpLastKnownIp>10.9.16.17</dpLastKnownIp>
               <dpGlobalIp>66.77.174.126</dpGlobalIp>
               <dpConnectionStatus>0</dpConnectionStatus>
               <dpLastConnectTime>2012-07-02T13:26:35.627Z</dpLastConnectTime>
               <dpContact />
               <dpDescription />
               <dpLocation />
               <dpPanId>0xf02d</dpPanId>
               <xpExtAddr>00:13:A2:00:40:5C:0A:6A</xpExtAddr>
               <dpServerId />
               <dpZigbeeCapabilities>875</dpZigbeeCapabilities>
               <grpPath>/CUS0000001_Digi_International/</grpPath>
            </DeviceCore>
         </Payload>
      </almsPayload>
   </AlarmStatus>
   <AlarmStatus>
      <id>
         <almId>152</almId>   <!-- alarm 152 almId #1 -->
         <almsSourceEntityId>Monitor:47827</almsSourceEntityId>
      </id>
      <almsStatus>0</almsStatus>
      <almsTopic>Alarm.System.Monitor.active</almsTopic>
      <cstId>2</cstId>
      <almsUpdateTime>2012-07-02T02:10:57.130Z</almsUpdateTime>
      <almsPayload>
         <Payload>
            <Message>Monitor connected</Message>
            <Monitor>
               <monId>47827</monId>
               <cstId>2</cstId>
               <monLastConnect>2012-06-29T19:18:10.287Z</monLastConnect>
               <monTopic>XbeeCore,DeviceCore,AlarmStatus,AlarmTemplate,Notification,Alarm</monTopic>
               <monTransportType>alarm</monTransportType>
               <monFormatType>xml</monFormatType>
               <monBatchSize>100</monBatchSize>
               <monCompression>none</monCompression>
               <monStatus>1</monStatus>
               <monBatchDuration>10</monBatchDuration>
            </Monitor>
         </Payload>
      </almsPayload>
   </AlarmStatus>
</result>

Acknowledge a Fired Alarm

The following sample request shows how to acknowledge a fired alarm. The sample alarm ID is 3140, the almsSourceEntity for the alarm event is 00000000-00000000-00409DFF-FF53231C.

Request

PUT ws/AlarmStatus/3140/00000000-00000000-00409DFF-FF53231C/`

Payload

<AlarmStatus>
   <almsStatus>2</almsStatus>
</AlarmStatus>

Response

GET ws/AlarmStatus/3140/00000000-00000000-00409DFF-FF53231C/

<?xml version="1.0" encoding="ISO-8859-1"?>
<result>
  <resultTotalRows>1</resultTotalRows>
  <requestedStartRow>0</requestedStartRow>
  <resultSize>1</resultSize>
  <requestedSize>1000</requestedSize>
  <remainingSize>0</remainingSize>
  <AlarmStatus>
    <id>
      <almId>3140</almId>
      <almsSourceEntityId>00000000-00000000-00409DFF-FF53231C</almsSourceEntityId>
    </id>
    <almsStatus>2</almsStatus>
    <almsTopic>Alarm.DeviceOffline</almsTopic>
    <cstId>2</cstId>
    <almsUpdateTime>2014-07-07T22:06:26.193Z</almsUpdateTime>
    <almsPayload>
      <Payload>
        <Method>Manual</Method>
      </Payload>
    </almsPayload>
  </AlarmStatus>
</result>

Reset a Fired Alarm

The following sample request uses the PUT method with the AlarmStatus web service to reset a fired alarm. The almID is 3140 and almsSourceEntity for the alarm event is 00000000-00000000-00409DFF-FF53231C.

Request

PUT ws/AlarmStatus/3140/00000000-00000000-00409DFF-FF53231C/

Payload

<AlarmStatus>
   <almsStatus>0</almsStatus>
</AlarmStatus>

Response

GET ws/AlarmStatus/3140/00000000-00000000-00409DFF-FF53231C/

<?xml version="1.0" encoding="ISO-8859-1"?>
<result>
  <resultTotalRows>1</resultTotalRows>
  <requestedStartRow>0</requestedStartRow>
  <resultSize>1</resultSize>
  <requestedSize>1000</requestedSize>
  <remainingSize>0</remainingSize>
  <AlarmStatus>
    <id>
      <almId>3140</almId>
      <almsSourceEntityId>00000000-00000000-00409DFF-FF53231C</almsSourceEntityId>
    </id>
    <almsStatus>0</almsStatus>
    <almsTopic>Alarm.DeviceOffline</almsTopic>
    <cstId>2</cstId>
    <almsUpdateTime>2014-07-07T22:06:26.193Z</almsUpdateTime>
    <almsPayload>
      <Payload>
        <Method>Manual</Method>
      </Payload>
    </almsPayload>
  </AlarmStatus>
</result>