GET api/v1/locations/{locationId}/devices/{deviceId}/automation/locks?AdditionalInput={AdditionalInput}
Get all automation locks.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
deviceId |
Device ID |
integer |
Required |
AdditionalInput |
{"PanelInformation" :"Cache"} , {"PanelInformation" :"Live"} |
string |
Required |
locationId | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of LockInfoName | Description | Type | Additional information |
---|---|---|---|
DeviceID | integer |
None. |
|
LockID | integer |
None. |
|
LockName | string |
None. |
|
LockIndex | integer |
None. |
|
LockState | integer |
None. |
|
BatteryState | integer |
None. |
|
DeviceStatusID | byte |
None. |
|
DeviceTypeID | integer |
None. |
|
DateTimeUpdated | date |
None. |
Response Formats
application/json, text/json
Sample:
[ { "DeviceID": 1, "LockID": 2, "LockName": "sample string 3", "LockIndex": 4, "LockState": 5, "BatteryState": 6, "DeviceStatusID": 64, "DeviceTypeID": 8, "DateTimeUpdated": "2025-04-01T23:49:58.3374968-04:00" }, { "DeviceID": 1, "LockID": 2, "LockName": "sample string 3", "LockIndex": 4, "LockState": 5, "BatteryState": 6, "DeviceStatusID": 64, "DeviceTypeID": 8, "DateTimeUpdated": "2025-04-01T23:49:58.3374968-04:00" } ]
application/xml, text/xml
Sample:
<ArrayOfLockInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models"> <LockInfo> <BatteryState>6</BatteryState> <DateTimeUpdated>2025-04-01T23:49:58.3374968-04:00</DateTimeUpdated> <DeviceID>1</DeviceID> <DeviceStatusID>64</DeviceStatusID> <DeviceTypeID>8</DeviceTypeID> <LockID>2</LockID> <LockIndex>4</LockIndex> <LockName>sample string 3</LockName> <LockState>5</LockState> </LockInfo> <LockInfo> <BatteryState>6</BatteryState> <DateTimeUpdated>2025-04-01T23:49:58.3374968-04:00</DateTimeUpdated> <DeviceID>1</DeviceID> <DeviceStatusID>64</DeviceStatusID> <DeviceTypeID>8</DeviceTypeID> <LockID>2</LockID> <LockIndex>4</LockIndex> <LockName>sample string 3</LockName> <LockState>5</LockState> </LockInfo> </ArrayOfLockInfo>