VEverdun
sites

Get Site Early Disarm

Each live camera's scheduled disarm and whether it can be disarmed early now (0174). Any login the site is in scope for may read it.

get/sites/{site_id}/early-disarm

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/sites/{site_id}/early-disarm
  • Auth
    HTTP bearer

Path parameters

site_idstring required

Response

Successful Response

site_idstring uuid required

The site.

timezonestring required

The site's IANA zone.

window_minutesinteger required

How far ahead of a scheduled disarm one may disarm early.

horizon_minutesinteger required

How far ahead scheduled_off_at is looked for.

as_ofstring date-time required

The server instant everything here was resolved at.

site_disarm_activeboolean required

A whole-site disarm (text, call, app or console) is live, so nothing is eligible.

site_arm_activeboolean

A test arm is live at the site, so nothing is eligible.

changed_camera_idsstring[]

On a disarm or re-arm: the cameras this request actually changed.

Example response

{
  "timezone": "America/Chicago",
  "window_minutes": 60,
  "horizon_minutes": 180,
  "cameras": [
    {
      "early_disarm": {
        "reason": "staff_on_site"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.