svcTC2API


Click here for a complete list of operations.

GetAutomationLocks

Get Automation Lock Details.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionId:
DeviceId:
LockID:
AdditionalInput:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /tc21api/tc2.asmx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.alarmnet.com/TC2/GetAutomationLocks"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAutomationLocks xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <DeviceId>long</DeviceId>
      <LockID>long</LockID>
      <AdditionalInput>string</AdditionalInput>
    </GetAutomationLocks>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAutomationLocksResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetAutomationLocksResult>
        <lockInfo>
          <LockInfo_Transitional>
            <DeviceID>long</DeviceID>
            <LockID>long</LockID>
            <LockName>string</LockName>
            <LockIndex>short</LockIndex>
            <LockState>short</LockState>
            <BatteryState>short</BatteryState>
            <DeviceStatusID>unsignedByte</DeviceStatusID>
            <DeviceTypeID>long</DeviceTypeID>
            <DateTimeUpdated>dateTime</DateTimeUpdated>
          </LockInfo_Transitional>
          <LockInfo_Transitional>
            <DeviceID>long</DeviceID>
            <LockID>long</LockID>
            <LockName>string</LockName>
            <LockIndex>short</LockIndex>
            <LockState>short</LockState>
            <BatteryState>short</BatteryState>
            <DeviceStatusID>unsignedByte</DeviceStatusID>
            <DeviceTypeID>long</DeviceTypeID>
            <DateTimeUpdated>dateTime</DateTimeUpdated>
          </LockInfo_Transitional>
        </lockInfo>
      </GetAutomationLocksResult>
    </GetAutomationLocksResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /tc21api/tc2.asmx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetAutomationLocks xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <DeviceId>long</DeviceId>
      <LockID>long</LockID>
      <AdditionalInput>string</AdditionalInput>
    </GetAutomationLocks>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetAutomationLocksResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetAutomationLocksResult>
        <lockInfo>
          <LockInfo_Transitional>
            <DeviceID>long</DeviceID>
            <LockID>long</LockID>
            <LockName>string</LockName>
            <LockIndex>short</LockIndex>
            <LockState>short</LockState>
            <BatteryState>short</BatteryState>
            <DeviceStatusID>unsignedByte</DeviceStatusID>
            <DeviceTypeID>long</DeviceTypeID>
            <DateTimeUpdated>dateTime</DateTimeUpdated>
          </LockInfo_Transitional>
          <LockInfo_Transitional>
            <DeviceID>long</DeviceID>
            <LockID>long</LockID>
            <LockName>string</LockName>
            <LockIndex>short</LockIndex>
            <LockState>short</LockState>
            <BatteryState>short</BatteryState>
            <DeviceStatusID>unsignedByte</DeviceStatusID>
            <DeviceTypeID>long</DeviceTypeID>
            <DateTimeUpdated>dateTime</DateTimeUpdated>
          </LockInfo_Transitional>
        </lockInfo>
      </GetAutomationLocksResult>
    </GetAutomationLocksResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /tc21api/tc2.asmx/GetAutomationLocks?SessionId=string&DeviceId=string&LockID=string&AdditionalInput=string HTTP/1.1
Host: rs.alarmnet.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<AutomationLockDataResult xmlns="https://services.alarmnet.com/TC2/">
  <lockInfo>
    <LockInfo_Transitional>
      <DeviceID>long</DeviceID>
      <LockID>long</LockID>
      <LockName>string</LockName>
      <LockIndex>short</LockIndex>
      <LockState>short</LockState>
      <BatteryState>short</BatteryState>
      <DeviceStatusID>unsignedByte</DeviceStatusID>
      <DeviceTypeID>long</DeviceTypeID>
      <DateTimeUpdated>dateTime</DateTimeUpdated>
    </LockInfo_Transitional>
    <LockInfo_Transitional>
      <DeviceID>long</DeviceID>
      <LockID>long</LockID>
      <LockName>string</LockName>
      <LockIndex>short</LockIndex>
      <LockState>short</LockState>
      <BatteryState>short</BatteryState>
      <DeviceStatusID>unsignedByte</DeviceStatusID>
      <DeviceTypeID>long</DeviceTypeID>
      <DateTimeUpdated>dateTime</DateTimeUpdated>
    </LockInfo_Transitional>
  </lockInfo>
</AutomationLockDataResult>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /tc21api/tc2.asmx/GetAutomationLocks HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionId=string&DeviceId=string&LockID=string&AdditionalInput=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<AutomationLockDataResult xmlns="https://services.alarmnet.com/TC2/">
  <lockInfo>
    <LockInfo_Transitional>
      <DeviceID>long</DeviceID>
      <LockID>long</LockID>
      <LockName>string</LockName>
      <LockIndex>short</LockIndex>
      <LockState>short</LockState>
      <BatteryState>short</BatteryState>
      <DeviceStatusID>unsignedByte</DeviceStatusID>
      <DeviceTypeID>long</DeviceTypeID>
      <DateTimeUpdated>dateTime</DateTimeUpdated>
    </LockInfo_Transitional>
    <LockInfo_Transitional>
      <DeviceID>long</DeviceID>
      <LockID>long</LockID>
      <LockName>string</LockName>
      <LockIndex>short</LockIndex>
      <LockState>short</LockState>
      <BatteryState>short</BatteryState>
      <DeviceStatusID>unsignedByte</DeviceStatusID>
      <DeviceTypeID>long</DeviceTypeID>
      <DateTimeUpdated>dateTime</DateTimeUpdated>
    </LockInfo_Transitional>
  </lockInfo>
</AutomationLockDataResult>