Setup Wiegand input/output
Configures Wiegand input/output.
Wiegand type. All data received on Wiegand input will be converted to selected type
Wiegand output mode.
- If 'duplicate' mode selected all data will be sent to Wiegand output. Access will be controlled by device. Data will be send ou Wiegand output for selected data types.
- if 'wiegand_control' selected all data will be sent to Wiegand output. Access will be controlled by Wiegand output for selected data types (User will see 'processing' screen). Other data types will be controlled by device.
When selected QR
data type to send to Wiegand output, QR must contain value in UUID
format
(full or short)
- application/json
Request Body required
sh_12 object
SH-12 module firmware info. Present only in the GET request
is_present boolean requiredDetermines whether the SH-12 module is connected
firmware_version stringFirmware version of the SH-12 module
in object required
Wiegand input settings
is_enabled boolean requiredDetermines whether the Wiegand input is enabled
wiegand object required
Wiegand settings
type string requiredPossible values: [
wiegand_26
,wiegand_34
,wiegand_42
,wiegand_58
,wiegand_66
,wiegand_130
]Wiegand type. All data received on Wiegand input will be converted to selected type
out object required
Wiegand output settings
is_enabled boolean requiredDetermines whether the Wiegand output is enabled
wiegand object required
Wiegand settings
type string requiredPossible values: [
wiegand_26
,wiegand_34
,wiegand_42
,wiegand_58
,wiegand_66
,wiegand_130
]Wiegand type. All data received on Wiegand input will be converted to selected type
control object
Wiegand control settings
mode string requiredPossible values: [
duplicate
,wiegand_control
]Wiegand output mode.
- If 'duplicate' mode selected all data will be sent to Wiegand output. Access will be controlled by device. Data will be send ou Wiegand output for selected data types.
- if 'wiegand_control' selected all data will be sent to Wiegand output. Access will be controlled by Wiegand output for selected data types (User will see 'processing' screen). Other data types will be controlled by device.
data object
Data types that will be sent to Wiegand output
types string[] requiredPossible values: [
internal_reader_data
,external_reader_data
,input_code
,qr
]Data types that will be sent to Wiegand output
- 200
- 400
- 401
OK
- Missed json body or wrong param.
Response sample:
"error": "Wrong JSON body"
- auth_factors must contain at least one item Response sample:
"error": "Wrong JSON body: no value for `param`"
where param
- is a required field that was not provided
- Field was of the wrong type. Response sample:
"error": "Wrong JSON body: value `param` was of the wrong type"
where param
- is a field of the wrong type
- application/json
- Schema
- Example (from schema)
- Base
- No value
- Wrong param type
- Wrong Wiegand input type
- Wrong Wiegand output type
- Wrong Wiegand control mode
- Wrong data type
Schema
- error string
error type/info
{
"error": true
}
{
"error": "Wrong JSON body"
}
{
"error": "Wrong JSON body: no value for param"
}
{
"error": "Wrong JSON body: value param was of the wrong type"
}
{
"error": "Wrong wiegand input type. Available values are in range: [wiegand_26, wiegand_34, wiegand_42, wiegand_58, wiegand_66, wiegand_130]"
}
{
"error": "Wrong wiegand output type. Available values are in range: [wiegand_26, wiegand_34, wiegand_42, wiegand_58, wiegand_66, wiegand_130]"
}
{
"error": "Wrong wiegand control mode. Available values are in range: [duplicate, wiegand_control]"
}
{
"error": "Wrong wiegand data type. Available values are in range: [qr, internal_reader_data, external_reader_data]"
}
Unauthorized request. Log In
- application/json
- Schema
- Example (from schema)
- Log In
Schema
- error string
error message
{
"error": "Log In"
}
{
"error": "Log In"
}