Get list of OSDP devices notification settings

Returns list of OSDP devices notification settings

Responses

application/json

Schema
Example (from schema)

Schema

items object[]
List of OSDP devices
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
connection object
Device connection extra information
is_active boolean
Determines if OSDP device online
is_enabled boolean
Determines if controller poll OSDP device
connection_status string
Possible values: [success, connection_timeout, invalid_security_key]
Describes OSDP connection status info
port_number integer
Possible values: >= 1 and <= 2
Unique RS485 interface number. Can be in range 1-2
address integer
Possible values: <= 126
Address of the device on th RS485 bus
channel_type string
Possible values: [secure, not_secure]
Channel type for device connection
name string
Possible values: <= 100 characters
Name of reader
indication object
OSDP device indication settings information
oneOf
MOD1
MOD2
is_abilities_type_valid boolean
describes whether the ability type specified by the user matches the ability type of the device
controlled_by string
Possible values: [controller, device]
Device control type.

If set to "controller", all led and buzzer manipulation managed by controller via OSDP commands. If set to "device", led and buzzer are working with OSDP device default(built-in) indication settings.
max_led_number integer
Possible values: <= 255
Number of led installed
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

{
  "items": [
    {
      "hardware_info": {
        "vendor_code": "vendor code",
        "model_number": 2,
        "version": 0,
        "firmware": "1.2.345",
        "serial_number": 0
      },
      "connection": {
        "is_active": true,
        "is_enabled": true,
        "connection_status": "success",
        "port_number": 1,
        "address": 0,
        "channel_type": "not_secure"
      },
      "name": "Main entrance reader",
      "indication": {
        "is_abilities_type_valid": false,
        "controlled_by": "device",
        "max_led_number": 2,
        "abilities_type": 1
      }
    }
  ]
}

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

Get list of OSDP devices notification settings​

Get list of OSDP devices notification settings