Temporary Password Details Interface

Last Updated on : 2023-12-07 03:34:02

Get the details of the temporary password of the door lock

API address

GET: /v1.0/devices/{device_id}/door-lock/template/temp-password/{password_id}

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	device id
password_id	Long	uri	true	password id

Return parameter

Parameter name	Type	Description
result	TemplatePwdSearchResultVO

Description of result

Parameter name	Type	Description
expired_time	Long	Password expiration time (milliseconds)
effective_time	Long	Password effective time (milliseconds)
dev_id_list	List	List of device numbers that can be unlocked
dev_name_list	List	List of device names that can be unlocked
operate	String	Action ADD MODIFY DELETE
delivery_status	String	Delivery Status ONGOING Delivering SUCCESS FAILED< /li>
sn	Integer	Serial number of the periodic password
name	String	Password Name
pwd_id	Long	Password number
dev_ack	Integer	Device return status is set according to dp definition
msg_id	Integer	Password information number
gmt_create	Long	Password creation time (milliseconds)
pwd_type_code	String	Password Type once-one-time-only offline password temp-temp-password (custom password )
password	String	Password
pwd_type	Integer	Type of current password 0-periodic password 1-one-time password
schedule_details	List	periodic information, the value may be changed only when the type is periodical password
phone	String	Mobile phone number (with country code), for example: 86-15158065546

Description of schedule_details

Parameter name	Type	Description
effective_time	Long	Start time. Stored in minutes, such as "07:30", the value is 7x60+30=450
invalid_time	Long	End time. Stored in minutes, such as "08:30", the value is 8x60+30=510
working_day	Integer	Week, each value accumulates: Sunday: 1 Monday: 2 Tuesday: 4 Wednesday : 8 Thursday: 16 Friday: 32 Saturday: 64
time_zone_id	String
all_day	Boolean

Request example

GET: /v1.0/devices/6c7129x1yanlxgwx/door-lock/template/temp-password/2876895

Return example

{
    "tid": "f19673593eda11ed84fd2237f0528b74",
    "result": {
        "effective_time": 1664269200,
        "schedule_details": [
            {
                "effective_time": 0,
                "working_day": 127,
                "all_day": false,
                "invalid_time": 1439
            }
        ],
        "pwd_id": 2876895,
        "expired_time": 1666861200,
        "password": "E86342BEF4228A1E741E38A5900FA61A",
        "operate": "CREATE",
        "name": "test9",
        "sn": -1,
        "msg_id": 81,
        "delivery_status": "ONGOING"
    },
    "t": 1664334559805,
    "success": true
}

Error code

For more information, see error code.