Get information about security zones

Get information about security zones

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• zones object[]

  Possible values: <= 8

  List of security zones

  zone_id integer

  Possible values: >= 1 and <= 8

  ID of zone

  type string

  Possible values: [normal, emergency, 24_hour]

  Zone type. Normal - work only if enabled in scene, 24 and emergency will work all the time

  mode string

  Possible values: [3c, no, nc, bell, call]

  Dry contacts mode. 3c - trigger, no - normal open, nc - normal closed, bell - doorbell mode

  delay integer

  Possible values: [0, 5, 15, 20, 25, 40, 60]

  Delay for sensor activation in seconds

  sensor string

  Possible values: [smoke, gas, pir, door, window, panic, flood, pull_cord, bed_mat]

  Sensor type

  status string

  Possible values: [opened, closed]

  physical state of sensor

{
  "zones": [
    {
      "zone_id": 1,
      "type": "normal",
      "mode": "no",
      "delay": 0,
      "sensor": "smoke",
      "status": "opened"
    }
  ]
}

{
  "zones": [
    {
      "zone_id": 1,
      "type": "normal",
      "mode": "no",
      "delay": 0,
      "sensor": "smoke"
    }
  ]
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Describes the base error user might get

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Describes the parameter that did not pass a validation

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be a string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Log In"
  }
}

Loading...