Get device relays settings

Returns general settings for all device relays.

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• items object[]

  List of relay settings

  number integer

  Possible values: >= 1 and <= 8

  Unique relay number. Can be in range 1-8, it depends on number of peripheral devices connected on external ports(RS485...).

  normally_closed boolean

  Describes relay initial state

  open_settings object

  Relay open parameters

  duration integer

  Possible values: >= 1000 and <= 300000

  Relay open duration in milliseconds

  delay integer

  Possible values: <= 300000

  Delay before relay opened in milliseconds

  type_settings object

  Type specific relay settings

  oneOf

  • MOD1
  • MOD2

  ---

  type string

  Possible values: [electromagnetic]

  Type of the lock

  type string

  Possible values: [electromechanical]

  Type of the lock

  pulse_on integer

  Possible values: >= 1000 and <= 2000

  Power on duration in seconds for electromechanical lock in milliseconds

  pulse_off integer

  Possible values: >= 500 and <= 2000

  Time between switching on the electromechanical lock in milliseconds

{
  "items": [
    {
      "number": 2,
      "normally_closed": false,
      "open_settings": {
        "duration": 1000,
        "delay": 0
      },
      "type_settings": {
        "type": "electromagnetic"
      }
    }
  ]
}

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