Set control inputs settings

Set settings for controlled inputs that can be used to close one or more relays

application/json

Request Body required

• items object[] required

  Set of controlled inputs

  number integer required

  Possible values: >= 1 and <= 2

  Number of controlled input

  is_enabled boolean required

  If enabled, controlled input reacts on input signal received

  normally_closed boolean required

  Describes sensor in idle state

  relays integer[] required

  Set of relays switched when interface input signal received

  notification object required

  Notification settings

  is_enabled boolean required

  Describes, if notification enabled

  after integer required

  Possible values: >= 1000 and <= 86400000

  If door opened more than specified time period(milliseconds), system will be notified. Will not be validated, if notification is disabled.

  only_once boolean required

  Notify only once, when "after" time period reached

Responses

• 200
• 400
• 401

---

OK

Bad Request

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": "bad_request",
    "message": "Bad request sent"
  }
}

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...