Get logical address info

Returns logical address info. Logical address - entity used as a call number between devices, see our wiki for details.

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• building integer

  Possible values: >= 1 and <= 999

  Building number

• unit integer

  Possible values: <= 99

  Unit number

• floor integer

  Possible values: <= 98

  Floor number

• apartment integer

  Possible values: <= 99

  Apartment number

• device integer

  Possible values: <= 8

  0 - main monitor, 1-8 - sub monitors

• sync string

  Sync password for device with the same logical address

{
  "building": 1,
  "unit": 1,
  "floor": 1,
  "apartment": 1,
  "device": 0,
  "sync": "123456"
}

{
  "building": 1,
  "unit": 1,
  "floor": 1,
  "apartment": 1,
  "device": 0,
  "sync": "123456"
}

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