svcTC2API


Click here for a complete list of operations.

ControlALock

Execute a action on a Automation panel lock

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
DeviceID:
LockID:
LockDesiredState:
AuthorizingCode:

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/ControlALock"

<?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>
    <ControlALock xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <DeviceID>long</DeviceID>
      <LockID>long</LockID>
      <LockDesiredState>int</LockDesiredState>
      <AuthorizingCode>string</AuthorizingCode>
    </ControlALock>
  </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>
    <ControlALockResponse xmlns="https://services.alarmnet.com/TC2/">
      <ControlALockResult />
    </ControlALockResponse>
  </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>
    <ControlALock xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <DeviceID>long</DeviceID>
      <LockID>long</LockID>
      <LockDesiredState>int</LockDesiredState>
      <AuthorizingCode>string</AuthorizingCode>
    </ControlALock>
  </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>
    <ControlALockResponse xmlns="https://services.alarmnet.com/TC2/">
      <ControlALockResult />
    </ControlALockResponse>
  </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/ControlALock?SessionID=string&DeviceID=string&LockID=string&LockDesiredState=string&AuthorizingCode=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"?>
<LockControlDataResults xmlns="https://services.alarmnet.com/TC2/" />

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/ControlALock HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&DeviceID=string&LockID=string&LockDesiredState=string&AuthorizingCode=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<LockControlDataResults xmlns="https://services.alarmnet.com/TC2/" />