Get a passcode
https://api.sciener.com/v3/keyboardPwd/get
The valid time of the passcode should be defined in HOUR,set the minute and second to 0. If the valid period is longer than one year, the end time should be XX months later than the start time, without any difference in DAY,HOUR.
Earlier passcode version，reference：
https://open.sciener.com/doc/api/keyboardPwdType
1. Description
| Name |
Type |
Required |
Description |
| clientId |
String |
Y |
The app_id which is assigned by system when you create an application |
| accessToken |
String |
Y |
Access token |
| lockId |
Int |
Y |
Lock ID |
| keyboardPwdVersion |
Int |
Y |
Passcode version, Passcode verison of latest lock is 4 |
| keyboardPwdType |
Int |
Y |
Passcode type |
| keyboardPwdName |
String |
N |
Passcode name |
| startDate |
Long |
N |
The time when it becomes valid, timestamp in milliseconds |
| endDate |
Long |
N |
The time when it is expired, timestamp in milliseconds |
| date |
Long |
Y |
Current time (timestamp in millisecond) |
Passcode type:
| Type |
Value |
Description |
| One-time | 1 | This code only valid for once within 6 hours from the Start Time |
| Permanent | 2 | This code must be used at least once within 24 Hours after the Start Time, Or it will be invalidated |
| Period | 3 | This code must be used at least once within 24 Hours after the Start Time, Or it will be invalidated |
| Delete | 4 | This code will delete all other codes |
| Weekend Cyclic | 5 | This code is valid during the time period at the weekend |
| Daily Cyclic | 6 | This code is valid during the time period everyday |
| Workday Cyclic | 7 | This code is valid during the time period on workdays |
| Monday Cyclic | 8 | This code is valid during the time period on Mondays |
| Tuesday Cyclic | 9 | This code is valid during the time period on Tuesdays |
| Wednesday Cyclic | 10 | This code is valid during the time period on Wednesdays |
| Thursday Cyclic | 11 | This code is valid during the time period on Thursdays |
| Friday Cyclic | 12 | This code is valid during the time period on Fridays |
| Saturday Cyclic | 13 | This code is valid during the time period on Saturdays |
| Sunday Cyclic | 14 | This code is valid during the time period on Sundays |
2.Response
| Parameter |
Type |
Description |
| keyboardPwd |
String |
Passcode |
| keyboardPwdId |
Int |
Passcode ID |
3.Example of response
{
"keyboardPwd": "123456",
"keyboardPwdId": "10236"
}