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.

To enable 'wiegand_control' mode multifactor/user access mode must be disabled. 'Normal' access mode must be selected using POST /access/global/settings.

When selected FR data type to send to Wiegand output, device sends identifier's link_id so it must contain not empty link_id field in UUID format.

When selected QR data type to send to Wiegand output, QR must contain value in UUID format (full or short)

internal_reader_data data type is not available on AV-08FL.

Feature is available on AV-08FBL and AV-08FL. On other devices use POST /access/external/control instead.

application/json

Request Body required

• in object required

  Wiegand input settings

  is_enabled boolean required

  Determines whether the Wiegand input is enabled

  wiegand object required

  Wiegand settings

  type string required

  Possible 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 required

  Determines whether the Wiegand output is enabled

  wiegand object required

  Wiegand settings

  type string required

  Possible 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 required

  Possible 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[] required

  Possible values: [internal_reader_data, external_reader_data, qr, face_id]

  Data types that will be sent to Wiegand output

Responses

• 200
• 400
• 401
• 403
• 422

---

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 message

{
  "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, face_id, input_code, 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"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Multifactor access is enabled. To enable 'wiegand_control' mode multifactor/user access mode must be disabled. 'Normal' access mode must be selected using POST /access/global/settings.

application/json

• Schema
• Example (from schema)
• Multifactor access enabled

---

Schema

• error string

  Error message

{
  "error": true
}

{
  "error": "Please use 'normal' access mode to enable wiegand_control mode"
}

Loading...