Set OSDP device setting

Configure OSDP device parameters

Path Parameters

• rs485-number integer required

  Possible values: >= 1 and <= 2

  Number of RS485 port

  Example: 1
• osdp-device-address integer required

  Possible values: <= 126

  Address of device

application/json

Request Body required

• address integer

  Possible values: <= 126

  Address of the device on th RS485 bus

• key ([0-9A-Fa-f]{2}[:-]){15}([0-9A-Fa-f]{2})

  Security key for device connection. Required only if device connection channel type is secure.

• baud_rate integer

  Possible values: [9600, 19200, 38400, 57600, 115200, 230400]

  Baud rate

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• settings string[]

  Possible values: [security_key, baud_rate, address]

  List of settings

{
  "settings": [
    "security_key"
  ]
}

Bad Request

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]

  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

  Contains validation error details

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

{
  "error": {
    "code": "bad_request",
    "message": "Bad request sent"
  }
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]

  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

  Contains validation error details

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

{
  "error": {
    "code": "invalid_authentication",
    "message": "Invalid authentication"
  }
}

Loading...