Get Unlocking Records

Last Updated on : 2024-08-19 06:22:55download

Get the unlocking records of a smart lock.

API address

GET: /v1.0/devices/{device_id}/door-lock/open-logs

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.
page_no	Integer	query	true	The page number.
page_size	Integer	query	true	The number of items returned on each page.
start_time	Long	query	true	The start time.
end_time	Long	query	true	The end time.

Return parameter

Parameter name	Type	Description
result	DoorLockHistoryRes

Description of result

Parameter name	Type	Description
total	Long	The number of records.
logs	List	The list of unlocking records.

Description of logs

Parameter name	Type	Description
update_time	Long	The time when the status is updated.
status	BaseItemDTO	The list of lock status.

Description of status

Parameter name	Type	Description
code	String	The status code. Valid values: `unlock_fingerprint`: Unlock with fingerprint. The number is assigned by the smart lock. `unlock_password`: Unlock with password. The number is assigned by the smart lock. `unlock_temporary`: Unlock with temporary password. The value is the password ID. `unlock_dynamic`: Unlock with dynamic password. The value is the password ID. `unlock_card`: Unlock with card. The number is assigned by the smart lock. `unlock_face`: Unlock with face recognition. The number is assigned by the smart lock. `unlock_key`: Unlock with mechanical key. The number is assigned by the smart lock. `unlock_identity_card`: Unlock with identity card. The number is assigned by the smart lock. `unlock_emergency`: Unlock with emergency password. The number is assigned by the smart lock.
value	Object	The status value.

Request example

GET: /v1.0/devices/vdevo15345926009****/door-lock/open-logs?page_no=1&page_size=20&start_time=1543213146&end_time=1543213546

Return example

{
    "result": {
        "total": 1,
        "logs": [
            {
                "unlock_name": "",
                "update_time": 1612098422000,
                "user_id": "0",
                "nick_name": "",
                "status": {
                    "code": "unlock_finger",
                    "value": "123456"
                }
            }
        ]
    },
    "t": 1542626129429,
    "success": true
}

Error code

For more information, see error code.