Calls the lift to the floor

Calls the lift to the floor

• Not available in access control mode

application/json

Request Body

• caller string

  Possible values: [api, remote_server, broadcast_message, concierge, broadcast_panel, broadcast_monitor]

  This model describes the entity that call the lift, affects the display in the device log

• direction string required

  Possible values: [up, down, any]

  Model describes allowed lift direction setting

• destination object required

  Sets the floor for the elevator to go

  oneOf

  • MOD1
  • MOD2

  ---

  floor integer required

  destination floor

  apartment string required

  apartment that called a lift, floor value is parsed from apartment

Responses

• 200
• 400
• 401
• 404

---

OK

Data validation error

application/json

• Schema
• Example (from schema)

---

Schema

• error object

  object containing info about error

  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

  extended info on error

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

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  object containing info about error

  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

  extended info on error

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

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

Not Found

Loading...