Get all IC cards of a lock
https://cnapi.ttlock.com/v3/identityCard/list
List all cards added to the lock.
1 Request example
javascript
curl --location -g --request GET 'https://cnapi.ttlock.com/v3/identityCard/list?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=1719&pageNo=1&pageSize=20&date=1625025703000'2 Request parameters
| 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 |
| searchStr | String | N | Search keywords, fuzzy search by IC card name |
| pageNo | Int | Y | Page no, start from 1 |
| pageSize | Int | Y | Items per page,max 200 |
| orderBy | Int | Y | Sort by: 0-by name, 1-reverse order by time, 2-reverse order by name |
| date | Long | Y | Current time (timestamp in millisecond) |
3 Response and example
| 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 |
|---|---|---|
| cardId | Int | Card ID |
| lockId | Int | Lock ID |
| cardNumber | String | Card number |
| cardName | String | Card name |
| startDate | Long | The time when it becomes valid (timestamp in millisecond) |
| endDate | Long | The time when it is expired (timestamp in millisecond) |
| createDate | Long | Create time (timestamp in millisecond) |
| senderUsername | String | The sender's username |
| cardType | Int | Card type:1-noraml card、4-cyclic |
| 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. |
{
"list": [
{
"cardId": 124242,
"lockId": 163377,
"cardNumber": "1723612378",
"cardName":"Card for mom",
"cardType": 4,
"startDate": 1625025703000,
"endDate": 1645025703000,
"createDate": 1625025703000,
"senderUsername": "alexa@google.com"
}
],
"pageNo":1,
"pageSize":20,
"pages":1,
"total":1
}