Get Unbound Unlocking Methods

Last Updated on : 2024-08-15 07:40:09download

Get the list of unlocking methods that are not bound with all members.

API address

GET: /v1.0/devices/{device_id}/door-lock/unassigned-keys

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.
unlock_type	String	uri	true	The type of the unlocking method. Valid values: `fingerprint`: Unlock with fingerprint. `password`: Unlock with password. `card`: Unlock with card. `remoteControl`: Unlock with remote control.

Return parameter

Parameter name	Type	Description
result	UnlockVO

Description of result

Parameter name	Type	Description
unlock_keys	List	The list of unlocking methods

Description of unlock_keys

Parameter name	Type	Description
unlock_no	Integer	The ID of the unlocking method. That is the flag of each unlocking method such as password, fingerprint, and card.
unlock_type	String	The type of the unlocking method. Valid values: `fingerprint`: Unlock with fingerprint. `password`: Unlock with password. `card`: Unlock with card. `remoteControl`: Unlock with remote control.
hijack	Boolean	Indicates whether duress alarms are enabled.

Request example

GET: /v1.0/devices/vdevo15345926009****/door-lock/unassigned-keys?unlock_type=card

Return example

{
    "result": {
        "unlock_keys": [
            {
                "unlock_no": 3,
                "unlock_type": "card"
            }
        ]
    },
    "t": 1593843316481,
    "success": true
}

Error code

For more information, see error code.