Get wiegand inputs settings

Returns settings for wiegand inputs that can be used to read identifiers

Responses

application/json

Schema
Example (from schema)

Schema

items object[]
Set of wiegand inputs
number integer
Possible values: >= 1 and <= 2
Number of wiegand input
name string
Possible values: <= 100 characters
Name of reader
is_enabled boolean
If enabled, wiegand input reacts on input signal received
type string
Possible values: [wiegand_26, wiegand_32, wiegand_34, wiegand_37, wiegand_40, wiegand_42, wiegand_56, wiegand_58, wiegand_64, wiegand_66, wiegand_128, wiegand_raw]
Type of wiegand used
type_settings object
Settings of the wiegand type
oneOf
MOD1
min_bits integer
Possible values: >= 16 and <= 256
The minimum number of bits that are considered as a value. Required for wiegand raw type.
indication object
WiegandIndicationSettings
idle object
Wiegand indication state settings
buzzer object
Buzzer settings
is_enabled boolean
Is buzzer enabled
on_time integer
Possible values: >= 1 and <= 255
The ON duration of the sound, in units of 100 ms. Must be nonzero. 1 means 100ms, 255 means 25500ms
off_time integer
Possible values: <= 255
The OFF duration of the sound, in units of 100 ms. 1 means 100ms, 255 means 25500ms.
beep_count integer
Possible values: <= 255
Number of beeps repeated.

0 = tone continues until another tone command is received
led object
LED settings
is_enabled boolean
Determines if LED enabled
on_time integer
Possible values: <= 255
The ON duration of the light, in units of 100 ms.
off_time integer
Possible values: <= 255
The OFF duration of the light, in units of 100 ms.
on_color string
Possible values: [black, red, green]
The ON duration light color.

Depends on indication abilities.
off_color string
Possible values: [black, red, green]
The ON duration light color.

Depends on indication abilities.
blink_timer integer
Possible values: <= 255
Number of blinks repeated, in units of 100 ms.

0 = light continues until another tone command is received
valid_identifier object
Wiegand indication state settings
buzzer object
Buzzer settings
is_enabled boolean
Is buzzer enabled
on_time integer
Possible values: >= 1 and <= 255
The ON duration of the sound, in units of 100 ms. Must be nonzero. 1 means 100ms, 255 means 25500ms
off_time integer
Possible values: <= 255
The OFF duration of the sound, in units of 100 ms. 1 means 100ms, 255 means 25500ms.
beep_count integer
Possible values: <= 255
Number of beeps repeated.

0 = tone continues until another tone command is received
led object
LED settings
is_enabled boolean
Determines if LED enabled
on_time integer
Possible values: <= 255
The ON duration of the light, in units of 100 ms.
off_time integer
Possible values: <= 255
The OFF duration of the light, in units of 100 ms.
on_color string
Possible values: [black, red, green]
The ON duration light color.

Depends on indication abilities.
off_color string
Possible values: [black, red, green]
The ON duration light color.

Depends on indication abilities.
blink_timer integer
Possible values: <= 255
Number of blinks repeated, in units of 100 ms.

0 = light continues until another tone command is received
invalid_identifier object
Wiegand indication state settings
buzzer object
Buzzer settings
is_enabled boolean
Is buzzer enabled
on_time integer
Possible values: >= 1 and <= 255
The ON duration of the sound, in units of 100 ms. Must be nonzero. 1 means 100ms, 255 means 25500ms
off_time integer
Possible values: <= 255
The OFF duration of the sound, in units of 100 ms. 1 means 100ms, 255 means 25500ms.
beep_count integer
Possible values: <= 255
Number of beeps repeated.

0 = tone continues until another tone command is received
led object
LED settings
is_enabled boolean
Determines if LED enabled
on_time integer
Possible values: <= 255
The ON duration of the light, in units of 100 ms.
off_time integer
Possible values: <= 255
The OFF duration of the light, in units of 100 ms.
on_color string
Possible values: [black, red, green]
The ON duration light color.

Depends on indication abilities.
off_color string
Possible values: [black, red, green]
The ON duration light color.

Depends on indication abilities.
blink_timer integer
Possible values: <= 255
Number of blinks repeated, in units of 100 ms.

0 = light continues until another tone command is received

{
  "items": [
    {
      "number": 1,
      "name": "Main entrance reader",
      "is_enabled": false,
      "type": "wiegand_raw",
      "type_settings": {
        "min_bits": 16
      },
      "indication": {
        "idle": {
          "buzzer": {
            "is_enabled": true,
            "on_time": 1,
            "off_time": 1,
            "beep_count": 1
          },
          "led": {
            "is_enabled": true,
            "on_time": 1,
            "off_time": 1,
            "on_color": "green",
            "off_color": "green",
            "blink_timer": 1
          }
        },
        "valid_identifier": {
          "buzzer": {
            "is_enabled": true,
            "on_time": 1,
            "off_time": 1,
            "beep_count": 1
          },
          "led": {
            "is_enabled": true,
            "on_time": 1,
            "off_time": 1,
            "on_color": "green",
            "off_color": "green",
            "blink_timer": 1
          }
        },
        "invalid_identifier": {
          "buzzer": {
            "is_enabled": true,
            "on_time": 1,
            "off_time": 1,
            "beep_count": 1
          },
          "led": {
            "is_enabled": true,
            "on_time": 1,
            "off_time": 1,
            "on_color": "green",
            "off_color": "green",
            "blink_timer": 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 wiegand inputs settings​

Get wiegand inputs settings