https://api.sciener.com/v3/qrCode/list
List all QR codes added to a lock.
xxxxxxxxxx11curl --location -g --request GET 'https://api.sciener.com/v3/qrCode/list?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=163377&pageNo=1&pageSize=20&date=1625025703000'| Name | Type | Required | Description |
|---|---|---|---|
| clientId | String | Y | client_id from Create application |
| accessToken | String | Y | Access token，refer to: Get access token |
| lockId | Int | Y | Lock ID, generated by Lock init |
| pageNo | Int | Y | Page no, start from 1 |
| pageSize | Int | Y | Items per page, max 200 |
| date | Long | Y | Current time (timestamp in millisecond) |
| name | String | N | QRcode‘s name |
| Parameter | Type | Description |
|---|---|---|
| list | JSONArray | list of records |
| pageNo | Int | Page no, start from 1 |
| pageSize | Int | Items per page, max 200 |
| pages | Int | Total number of pages |
| total | Int | Total number of records |
The objects in the list
| Parameter | Type | Description |
|---|---|---|
| qrCodeId | Int | QR code id |
| lockId | Int | Lock ID |
| type | Int | QR code type, 1-period, 2-permanent, 4-cyclic |
| qrCodeNumber | String | QR code number: the unique number of QR code in a lock. It's will be contained in the unlocking records for identifing which code unlock the lock. |
| name | String | Qr code name |
| startDate | Long | The time when it becomes valid (timestamp in millisecond) |
| endDate | Long | The time when it is expired (timestamp in millisecond) |
| refreshTime | Int | QR code refresh time, time in minutes |
| cyclicConfig | JSONArray | Recurring time period, the valid time period of each week day must be the same, for example: [{"weekDay":1, "startTime":480,"endTime":1080},{"weekDay":2, "startTime":480,"endTime":1080}] for valid from 8:00 to 18:00 in Monday and Tuesday. |
| createDate | Long | Create time (timestamp in millisecond) |
| status | Int | Status: 1-normal, 2-invalid or expired, 3-pending |
| creator | String | creator |
| link | Int | The H5 page URL displaying QR code |
| qrCodeVersion | Int | QR code versions: 1- Random cloud-based QR code 3- Custom QR code |
cyclicConfig:
| Parameter | Type | Description |
|---|---|---|
| startTime | Int | Start time of cyclic, in minutes, for example 480 for 8:00 |
| endTime | Int | End time of cyclic, in minutes, for example 1080 for 18:00 |
| weekDay | Int | Week day, 1-7, 1 for monday and 7 for sunday. |
xxxxxxxxxx211{2"list": [3{4"qrCodeId": 34242,5"lockId": 163377,6"type": 1,7"qrCodeNumber": 2,8"name": "QR code for alexa",9"startDate": 1625025703000,10"endDate": 1665025703000,11"status": 1,12"createDate": 1625025703000,13"creator": "Lily",14"link":"https://ttekey.com/q?k=Gc5Wg6Hh"15}16],17"pageNo":1,18"pageSize":20,19"pages":1,20"total":121}