Get Periodic Temporary Passwords of Keepalive Locks

Last Updated on : 2023-12-07 03:34:00download

According to the valid parameter of the request, valid or invalid passwords are returned. When the valid list is called for the first time, the last failed passwords will also be returned. After the next call, the failed passwords will be classified into invalid temporary passwords and will no longer be displayed in the valid list.

API address

GET: /v1.0/smart-lock/devices/{device_id}/stand-by-lock-temp-passwords

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.
valid	Boolean	query	true	Indicates whether the password is valid.
last_row_key	String	query	false	The last row key when you query records by page. The value is from the `last_row_key` of the returned result, and it is empty when no value is returned.
page_size	Integer	query	true	The number of entries per page.

Return parameter

Parameter name	Type	Description
result	RowBasedPagination	The returned result.

Description of result

Parameter name	Type	Description
last_row_key	String	The last row key. It is required when you query the next page.
has_more	Boolean	Indicates whether additional data is available.
records	List	The list of results.

Description of records

Parameter name	Type	Description
password_id	Long	The password ID.
pwd_type_code	String	The temporary password. The value is `temp`.
name	String	The password name.
gmt_create	Long	The time when the password is created. Unit: seconds.
effective_time	Long	The time when the password takes effect. Unit: seconds.
expired_time	Long	The time when the password expires. Unit: seconds.
phone	String	The mobile phone number with country code. Example: 86-1515806****.
schedule_details	List	The periodic details. This value might be available only when the type is periodic password.
sn	Integer	The serial number of the temporary password in the lock.
operate	String	Operation. Valid values: `ADD`: Add a password. `MODIFY`: Modify a password. DELETE: Delete a password.
delivery_status	String	Delivery status. Valid value: `ONGOING`: The password is being sent. `SUCCESS`: The password is sent successfully. `FAILED`: Failed to send the password.
effective_flag	Integer	The flag of validity. Valid values: `0`: It is invalid. `1`: It is valid. `2`: It will take effect later.

Description of schedule_details

Parameter name	Type	Description
start_minute	Long	The minute when the password takes effect in one day.
end_minute	Long	The minute when the password expires in one day.
working_day	Integer	Day of the week. Each value adds up. Valid values: `1`: Sunday `2`: Monday `4`: Tuesday `8`: Wednesday `16`: Thursday `32`: Friday `64`: Saturday
time_zone_id	String	The time zone.
all_day	Boolean	Indicates whether the password is valid all the day.

Request example

GET: /v1.0/smart-lock/devices/vdevo12454656****/stand-by-lock-temp-passwords

{
  "device_id": "vdevo12454656****",
  "valid": true,
  "last_row_key": "ABCDEFG",
  "page_size": 20
}

Return example

{
    "last_row_key": "ABCDEFG",
    "records": [
        {
            "effective_time": 1628006400,
            "gmt_create": 1628088594,
            "schedule_details": [
                {
                    "working_day": 101,
                    "all_day": false,
                    "end_minute": 2359,
                    "start_minute": 0
                }
            ],
            "expired_time": 1628265540,
            "operate": "CREATE",
            "password_id": 3351004,
            "phone": "",
            "name": "369369",
            "pwd_type_code": "temp",
            "effective_flag": 1,
            "sn": 0,
            "delivery_status": "SUCCESS"
        }
    ],
    "has_more": false
}

Error code

For more information, see error code.