Get Bound Unlocking Methods

Last Updated on : 2024-05-09 08:10:16download

Get the list of unlocking methods that are bound with a specified member.

API address

GET: /v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/assigned-keys

Request parameter

Parameter nameTypeINRequiredDescription
device_idStringuritrueThe device ID.
user_idStringuritrueThe ID of a specified member.
unlock_typeStringuritrueThe type of the unlocking method. Valid values:
  • fingerprint: Unlock with fingerprint.
  • password: Unlock with password.
  • card: Unlock with card.
user_typeIntegerquerytrueThe type of members. Valid values:
  • 1: home member.
  • 2: non-home member.

Return parameter

Parameter nameTypeDescription
resultUnlockVO

Description of result

Parameter nameTypeDescription
unlock_keysListThe list of unlocking methods.

Description of unlock_keys

Parameter nameTypeDescription
unlock_noIntegerThe ID of the unlocking method. That is the flag of each unlocking method such as password, fingerprint, and card.
unlock_typeStringThe type of the unlocking method. Valid values:
  • fingerprint: Unlock with fingerprint.
  • password: Unlock with password.
  • card: Unlock with card.
hijackBooleanIndicates whether duress alarms are enabled.

Request example

GET: /v1.0/devices/vdevo15345926009****/door-lock/user-types/2/users/xxx/assigned-keys?unlock_type=card

Error code

For more information, see error code.