Get port-floor mapping

Get port mapping

Query Parameters

• mode string

  Possible values: [access-control-manual, call-any, call-up, call-down, call-up-down]

  see DeviceMode model

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema array

• floor integer

  Possible values: <= 98

  logical floor number

• name string

  Possible values: non-empty and <= 64 characters

  floor name 64 UTF-8 chars

• is_public boolean

  Default value: false

  Sets this floor available for all users of elevator (Works in access control mode)

• is_panel_floor boolean

  Default value: false

  Sets this floor as a floor of panel installation, this parameter is needed for correct lift functioning in 2-step mode (Access control mode with possibility to allow guest to go to the floor of the user)

• apartments string[]

  Possible values: Value must match regular expression ^\d{2}-\d{2}$

  List of apartments on the floor

• ports integer[]

  Possible values: >= 1, <= 16

  port (relay) numbers associated with the floor

[
  {
    "floor": 1,
    "name": "floor 1",
    "is_public": true,
    "is_panel_floor": true,
    "apartments": [
      "01-11"
    ],
    "ports": [
      1
    ]
  }
]

[
  {
    "floor": 1,
    "name": "floor 1",
    "is_public": false,
    "is_panel_floor": true,
    "apartments": [
      "01-10"
    ],
    "ports": [
      1
    ]
  }
]

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"
  }
}

Loading...