Set DTMF code setting

Set DTMF code setting for first and second locks

application/json

Request Body

• codes object required

  Dtmf codes

  first object required

  DTMF for first lock

  use_default_value boolean required

  Default value: false

  If true '#' will be used

  custom_value string required

  Possible values: Value must match regular expression ^([0-9*#]{1,4})$

  Default value: #

  Custom value that will be used

  second object required

  DTMF for second lock

  is_enabled boolean required

  Default value: false

  Is feature enabled?

  value string required

  Possible values: Value must match regular expression ^([0-9*#]{1,4})$

  Default value: 0

  Custom value that will be used

  elevator object

  DTMF for elevator lock

  use_default_value boolean required

  Default value: false

  If true '#' will be used

  custom_value string required

  Possible values: Value must match regular expression ^[\\d*#ABCD]{1,4}$

  Default value: DC

  Custom value that will be used

Responses

• 200
• 400
• 401

---

OK

Bad Request

application/json

• Schema
• Example (from schema)

---

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

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