Get OSDP device info

Tries to connect to OSDP device and get its information

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

Query Parameters

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

  Key used for osdp security connection

  Example: aa:aa:aa:aa:aa:aa:aa:aa:aa:aa:aa:aa:aa:aa:aa:aa

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• connection object

  General connection information

  channel_type string

  Possible values: [secure, not_secure]

  Channel type for device connection

  connection_status string

  Possible values: [success, connection_timeout, invalid_security_key]

  Describes OSDP connection status info

  is_active boolean

  Determines if OSDP device online

• hardware_info object

  General hardware information

  vendor_code string

  Unique device vendor code

  model_number integer

  Model number of the device

  version integer

  Version of the device

  firmware string

  Firmware version

  serial_number integer

  Serial number of the device

• indication object

  Indication info

  abilities_type integer

  Possible values: >= 1 and <= 4

  Information about available device control settings type. Device control settings type controlled by Function Code 4 (FC4).

  1 – the PD support on/off control only 2 – the PD supports timed commands 3 – like 02, plus bi-color LEDs 4 – like 02, plus tri-color LEDs

  led_number integer

  Possible values: <= 255

  Number of led installed

{
  "connection": {
    "channel_type": "not_secure",
    "connection_status": "success",
    "is_active": true
  },
  "hardware_info": {
    "vendor_code": "vendor code",
    "model_number": 2,
    "version": 0,
    "firmware": "1.2.345",
    "serial_number": 0
  },
  "indication": {
    "abilities_type": 1,
    "led_number": 2
  }
}

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": "connection_timeout",
    "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...