Set port-floor mapping

Set port mapping

Query Parameters

• mode string

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

  see DeviceMode model

application/json

Request Body array

• floor integer required

  Possible values: <= 98

  logical floor number

• name string required

  Possible values: non-empty and <= 64 characters

  floor name 64 UTF-8 chars

• is_public boolean required

  Default value: false

• apartments string[] required

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

• ports integer[] required

  Possible values: >= 1, <= 16

  port (relay) numbers associated with the floor

Responses

• 200
• 400
• 401

---

OK

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• error object

  code string

  Possible values: [invalid_authentification, 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

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

  code string

  Possible values: [invalid_authentification, 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

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

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

Loading...