GET api/v2/locations/{locationId}/devices/{deviceId}/automation/locks/{lockId}?AdditionalInput={AdditionalInput}

Request Information

URI Parameters

Name	Type	Additional information
deviceId	integer	Required
lockId	integer	Required
AdditionalInput	string	Default value is
locationId	string	None.

Body Parameters

None.

Response Information

Resource Description

AutomationLockDataResult

Name	Type	Additional information
lockInfo	Collection of LockInfo_Transitional	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "lockInfo": [
    {
      "deviceID": 1,
      "lockID": 2,
      "lockName": "sample string 3",
      "lockIndex": 4,
      "lockState": 5,
      "batteryState": 6,
      "deviceStatusID": 64,
      "deviceTypeID": 8,
      "dateTimeUpdated": "2025-04-01T23:53:49.1608518-04:00"
    },
    {
      "deviceID": 1,
      "lockID": 2,
      "lockName": "sample string 3",
      "lockIndex": 4,
      "lockState": 5,
      "batteryState": 6,
      "deviceStatusID": 64,
      "deviceTypeID": 8,
      "dateTimeUpdated": "2025-04-01T23:53:49.1608518-04:00"
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<AutomationLockDataResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <lockInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Automation">
    <d2p1:LockInfo_Transitional>
      <d2p1:batteryState>6</d2p1:batteryState>
      <d2p1:dateTimeUpdated>2025-04-01T23:53:49.1608518-04:00</d2p1:dateTimeUpdated>
      <d2p1:deviceID>1</d2p1:deviceID>
      <d2p1:deviceStatusID>64</d2p1:deviceStatusID>
      <d2p1:deviceTypeID>8</d2p1:deviceTypeID>
      <d2p1:lockID>2</d2p1:lockID>
      <d2p1:lockIndex>4</d2p1:lockIndex>
      <d2p1:lockName>sample string 3</d2p1:lockName>
      <d2p1:lockState>5</d2p1:lockState>
    </d2p1:LockInfo_Transitional>
    <d2p1:LockInfo_Transitional>
      <d2p1:batteryState>6</d2p1:batteryState>
      <d2p1:dateTimeUpdated>2025-04-01T23:53:49.1608518-04:00</d2p1:dateTimeUpdated>
      <d2p1:deviceID>1</d2p1:deviceID>
      <d2p1:deviceStatusID>64</d2p1:deviceStatusID>
      <d2p1:deviceTypeID>8</d2p1:deviceTypeID>
      <d2p1:lockID>2</d2p1:lockID>
      <d2p1:lockIndex>4</d2p1:lockIndex>
      <d2p1:lockName>sample string 3</d2p1:lockName>
      <d2p1:lockState>5</d2p1:lockState>
    </d2p1:LockInfo_Transitional>
  </lockInfo>
</AutomationLockDataResult>