Get security alarm input interface settings

Returns security alarm input interface settings

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• is_enabled boolean

  If input interface enabled, device reacts on interface input signal

• relays object

  Set of relays switched when interface input signal received

  block integer[]

  Numbers of relays to be blocked when security alarm is active

  activate integer[]

  Numbers of relays to be activated when security alarm is active

• duration integer

  Possible values: <= 86400000

  Time for which the relay will be block on(millisecond)

• normally_closed boolean

  Describes sensor in idle state

• reboot_state string

  Possible values: [keep, reset]

  State of relays after reboot in case alarm was fired before

• available_relays integer[]

  Set of relays available for blocking when alarm fired

• is_active boolean

  Current status of security alarm input interface

{
  "is_enabled": true,
  "relays": {
    "block": [
      3,
      4
    ],
    "activate": [
      1,
      2
    ]
  },
  "duration": 1000,
  "normally_closed": false,
  "reboot_state": "keep",
  "available_relays": [
    1,
    2,
    3,
    4
  ],
  "is_active": false
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

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

  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

  Contains validation error details

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

{
  "error": {
    "code": "invalid_authentication",
    "message": "Invalid authentication"
  }
}

Loading...