Follow

GET alarms

Warning, this API is subject to change without notice. That said, feel free to use it at your own risk.

Returns information for all alarms on a particular location if you are logged in.

To login via the api, you can http POST to  https://application.deckmonitoring.com/authenticate/login the parameters login[email] and login[password] to provide the information of a valid DECK user.

URL

 https://application.deckmonitoring.com/api/v2/alarms.json (responds with JSON text)

Request Options

  • location_id: the location id of a DECK location

Response

A json array containing information for all alarms on the specified location and some related information.

Each item in the array may have the following:

  • current_user_has_admin_access: True or false. Whether or not the logged in user has admin access. Typically this is only true for DECK employees.
  • current_user_subscribed: True or false. Whether or not the currently logged in user is set up to receive notifications for this alarm.
  • currently_raised: True or false. Whether or not this alarm is currently raised.
  • description: User-defined description of the alarm.
  • id: The unique identifier for this alarm.
  • device_name: If the alarm pertains to a specific device, the name of that device, otherwise, null.
  • last_became_raised_at_local: A date time string in the specified location's timezone specifying the last time this alarm was checked and raised.
  • last_became_raised_at_timezone: The abbreviated timezone relating to last_became_raised_at_local.
  • last_became_raised_at_timestamp: An integer unix timestamp in UTC of the last time this alarm was checked and raised..
  • last_checked_at_local: A date time string in the specified location's timezone specifying the last time this alarm was checked and raised.
  • last_checked_at_timestamp: An integer unix timestamp in UTC of the last time this alarm was checked
  • last_checked_at_timezone: The abbreviated timezone relating to last_checked_at_local.
  • location: An object with keys id, timezone, and display_name. Indicates information about given location.
  • name: User-defined name of the alarm
  • notifications_enabled: True or false. Whether or not emails will be sent for this alarm based on user setting.
  • options: Alarm-specific options specified by the user
  • raise_count:  The number of times this alarm has been raised since it was created
  • resolved_at_local: A date time string of the last time this alarm transitioned from a raised to non-raised state in the given location's timezone.
  • resolved_at_timestamp: An integer unix timestamp in UTC of the last time this alarm transitioned from a raised to non-raised state.
  • resolved_at_timezone: The abbreviated timezone relating to resolved_at_local.
  • seconds_since_raised: The number of seconds that have elapsed since the last time this alarm was checked and raised.
  • sends_resolved_alert: True or false. Whether or not this alarm will notify its recipients when it transitions from a raised state to a non-raised state.
  • type: The type of alarm. (e.g. DeviceReportingAlarm)
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk