Get keys of a lock

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Query Params

keyRight

enum<integer> <int32>

optional

Operation permission, 1 means read-only, 2 means modifiable

Allowed values:

lockId

integer <int64>

required

lock id

orderBy

enum<integer> <int32>

optional

Sorting field, 1 means ascending order by ID, 2 means ascending order by creation time, 3 means ascending order by update time

Allowed values:

123

pageNo

integer <int32>

required

current page number

pageSize

integer <int32>

required

number of items displayed per page

searchStr

string

optional

search for the keyword

Responses

🟢200OK

*/*

Body

list

array[object (KeyInfo) {17}]

optional

electricQuantity

integer <int32>

optional

Battery

Example:

endDate

integer <int64>

optional

End Date

Example:

1628878944000

featureValue

string

optional

Characteristic value

Example:

6C4CD1F3

groupId

integer <int64>

optional

Group ID

Example:

7619

groupName

string

optional

Group Name

Example:

Home Building 4

keyRight

integer <int32>

optional

Key permission

Example:

keyStatus

string

optional

Lock Status

Example:

110401

lockAlias

string

optional

Lock Alias

Example:

Door Lock

lockId

integer <int64>

optional

LockID

Example:

532323

lockMac

string

optional

Lock MAC Address

Example:

68:9E:19:00:67:81

lockName

string

optional

Lock Name

Example:

M102_ed8e8d

noKeyPwd

string

optional

Keyless Password

Example:

345634

passageMode

integer <int32>

optional

Passage Mode

Example:

remarks

string

optional

Remarks

Example:

Water bill is due at the end of the month

remoteEnable

integer <int32>

optional

Remote Enable

Example:

startDate

integer <int64>

optional

Start Date

Example:

1528878944000

userType

string

optional

User Type

Example:

110302

pageNo

integer <int32>

optional

pageSize

integer <int32>

optional

pages

integer <int32>

optional

total

integer <int32>

optional

Example

{
  "list": [
    {
      "electricQuantity": 85,
      "endDate": 1628878944000,
      "featureValue": "6C4CD1F3",
      "groupId": 7619,
      "groupName": "Home Building 4",
      "keyRight": 1,
      "keyStatus": "110401",
      "lockAlias": "Door Lock",
      "lockId": 532323,
      "lockMac": "68:9E:19:00:67:81",
      "lockName": "M102_ed8e8d",
      "noKeyPwd": "345634",
      "passageMode": 1,
      "remarks": "Water bill is due at the end of the month",
      "remoteEnable": 0,
      "startDate": 1528878944000,
      "userType": "110302"
    }
  ],
  "pageNo": 0,
  "pageSize": 0,
  "pages": 0,
  "total": 0
}

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Request

Request samples

Responses