svcTC2API Web Service

svcTC2API

Click here for a complete list of operations.

SynchronizePanelUser

[TC2.1+] Synchronize Total Connect Users with Security System user codes

Test

The test form is only available for requests from the local machine.

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

<?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>
    <SynchronizePanelUser xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <DeviceList>
        <DeviceAuthorizingCode>
          <LocationID>long</LocationID>
          <DeviceID>long</DeviceID>
          <AuthorizingCode>string</AuthorizingCode>
        </DeviceAuthorizingCode>
        <DeviceAuthorizingCode>
          <LocationID>long</LocationID>
          <DeviceID>long</DeviceID>
          <AuthorizingCode>string</AuthorizingCode>
        </DeviceAuthorizingCode>
      </DeviceList>
      <StatusOnly>boolean</StatusOnly>
      <AdditionalInput>string</AdditionalInput>
      <userCodeDirectPush>boolean</userCodeDirectPush>
    </SynchronizePanelUser>
  </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>
    <SynchronizePanelUserResponse xmlns="https://services.alarmnet.com/TC2/">
      <SynchronizePanelUserResult>
        <SynchronizationStatus>
          <SyncStatus>
            <DeviceID>long</DeviceID>
            <DeviceName>string</DeviceName>
            <TotalSteps>int</TotalSteps>
            <CurrentStep>int</CurrentStep>
            <Description>string</Description>
            <StatusText>string</StatusText>
            <ResultCode>int</ResultCode>
            <ResultData>string</ResultData>
          </SyncStatus>
          <SyncStatus>
            <DeviceID>long</DeviceID>
            <DeviceName>string</DeviceName>
            <TotalSteps>int</TotalSteps>
            <CurrentStep>int</CurrentStep>
            <Description>string</Description>
            <StatusText>string</StatusText>
            <ResultCode>int</ResultCode>
            <ResultData>string</ResultData>
          </SyncStatus>
        </SynchronizationStatus>
      </SynchronizePanelUserResult>
    </SynchronizePanelUserResponse>
  </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>
    <SynchronizePanelUser xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <DeviceList>
        <DeviceAuthorizingCode>
          <LocationID>long</LocationID>
          <DeviceID>long</DeviceID>
          <AuthorizingCode>string</AuthorizingCode>
        </DeviceAuthorizingCode>
        <DeviceAuthorizingCode>
          <LocationID>long</LocationID>
          <DeviceID>long</DeviceID>
          <AuthorizingCode>string</AuthorizingCode>
        </DeviceAuthorizingCode>
      </DeviceList>
      <StatusOnly>boolean</StatusOnly>
      <AdditionalInput>string</AdditionalInput>
      <userCodeDirectPush>boolean</userCodeDirectPush>
    </SynchronizePanelUser>
  </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>
    <SynchronizePanelUserResponse xmlns="https://services.alarmnet.com/TC2/">
      <SynchronizePanelUserResult>
        <SynchronizationStatus>
          <SyncStatus>
            <DeviceID>long</DeviceID>
            <DeviceName>string</DeviceName>
            <TotalSteps>int</TotalSteps>
            <CurrentStep>int</CurrentStep>
            <Description>string</Description>
            <StatusText>string</StatusText>
            <ResultCode>int</ResultCode>
            <ResultData>string</ResultData>
          </SyncStatus>
          <SyncStatus>
            <DeviceID>long</DeviceID>
            <DeviceName>string</DeviceName>
            <TotalSteps>int</TotalSteps>
            <CurrentStep>int</CurrentStep>
            <Description>string</Description>
            <StatusText>string</StatusText>
            <ResultCode>int</ResultCode>
            <ResultData>string</ResultData>
          </SyncStatus>
        </SynchronizationStatus>
      </SynchronizePanelUserResult>
    </SynchronizePanelUserResponse>
  </soap12:Body>
</soap12:Envelope>