GET alarm/events

Gets a list of all the active alarm events from all available sites.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ResponseVMOfAlarmEventVM

Name	Type	Additional information
Resources	Collection of AlarmEventVM	None.
ResultCode	FwApiResultCode	None.
ResultMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Resources": [
    {
      "eventid": 1,
      "active": true,
      "alarm": {
        "id": 1,
        "type": "sample string 2",
        "name": "sample string 3",
        "rule": "sample string 4"
      },
      "site": {
        "id": 1,
        "name": "sample string 2"
      },
      "timing": {
        "datastart": "2025-05-29T21:54:10.4860165-07:00",
        "dataend": "2025-05-29T21:54:10.4860165-07:00",
        "startfound": "2025-05-29T21:54:10.4860165-07:00",
        "endfound": "2025-05-29T21:54:10.4860165-07:00"
      },
      "ackreqd": true,
      "acknowledgement": {
        "username": "sample string 1",
        "ackdate": "2025-05-29T21:54:10.4860165-07:00"
      }
    },
    {
      "eventid": 1,
      "active": true,
      "alarm": {
        "id": 1,
        "type": "sample string 2",
        "name": "sample string 3",
        "rule": "sample string 4"
      },
      "site": {
        "id": 1,
        "name": "sample string 2"
      },
      "timing": {
        "datastart": "2025-05-29T21:54:10.4860165-07:00",
        "dataend": "2025-05-29T21:54:10.4860165-07:00",
        "startfound": "2025-05-29T21:54:10.4860165-07:00",
        "endfound": "2025-05-29T21:54:10.4860165-07:00"
      },
      "ackreqd": true,
      "acknowledgement": {
        "username": "sample string 1",
        "ackdate": "2025-05-29T21:54:10.4860165-07:00"
      }
    }
  ],
  "ResultCode": 0,
  "ResultMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<ResponseVMOfAlarmEventVMFXJgzlgx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FW.WebApi2.ViewModels">
  <ResultCode>Ok</ResultCode>
  <ResultMessage>sample string 1</ResultMessage>
  <Resources>
    <AlarmEventVM>
      <acknowledgement>
        <ackdate>2025-05-29T21:54:10.4860165-07:00</ackdate>
        <username>sample string 1</username>
      </acknowledgement>
      <ackreqd>true</ackreqd>
      <active>true</active>
      <alarm>
        <id>1</id>
        <name>sample string 3</name>
        <rule>sample string 4</rule>
        <type>sample string 2</type>
      </alarm>
      <eventid>1</eventid>
      <site>
        <id>1</id>
        <name>sample string 2</name>
      </site>
      <timing>
        <dataend>2025-05-29T21:54:10.4860165-07:00</dataend>
        <datastart>2025-05-29T21:54:10.4860165-07:00</datastart>
        <endfound>2025-05-29T21:54:10.4860165-07:00</endfound>
        <startfound>2025-05-29T21:54:10.4860165-07:00</startfound>
      </timing>
    </AlarmEventVM>
    <AlarmEventVM>
      <acknowledgement>
        <ackdate>2025-05-29T21:54:10.4860165-07:00</ackdate>
        <username>sample string 1</username>
      </acknowledgement>
      <ackreqd>true</ackreqd>
      <active>true</active>
      <alarm>
        <id>1</id>
        <name>sample string 3</name>
        <rule>sample string 4</rule>
        <type>sample string 2</type>
      </alarm>
      <eventid>1</eventid>
      <site>
        <id>1</id>
        <name>sample string 2</name>
      </site>
      <timing>
        <dataend>2025-05-29T21:54:10.4860165-07:00</dataend>
        <datastart>2025-05-29T21:54:10.4860165-07:00</datastart>
        <endfound>2025-05-29T21:54:10.4860165-07:00</endfound>
        <startfound>2025-05-29T21:54:10.4860165-07:00</startfound>
      </timing>
    </AlarmEventVM>
  </Resources>
</ResponseVMOfAlarmEventVMFXJgzlgx>