svcTC2API Web Service

svcTC2API

Click here for a complete list of operations.

GetAScene

Get a specific scene per Automation panel (database)

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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

<?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>
    <GetAScene xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <DeviceID>long</DeviceID>
      <SceneID>long</SceneID>
    </GetAScene>
  </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>
    <GetASceneResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetASceneResult>
        <SceneAutomationData>
          <SceneInfoHeader>
            <SceneName>string</SceneName>
            <IsSceneEnabled>boolean</IsSceneEnabled>
            <SceneIconID>int</SceneIconID>
            <SceneID>long</SceneID>
            <InUse>boolean</InUse>
          </SceneInfoHeader>
          <AccountID>long</AccountID>
          <DeviceID>long</DeviceID>
          <DeviceSerialNumber>long</DeviceSerialNumber>
          <DeviceSerialText>string</DeviceSerialText>
          <AutomationSwitch>
            <SceneStatusSwitch xsi:nil="true" />
            <SceneStatusSwitch xsi:nil="true" />
          </AutomationSwitch>
          <AutomationThermostat>
            <SceneStatusThermostat xsi:nil="true" />
            <SceneStatusThermostat xsi:nil="true" />
          </AutomationThermostat>
          <AutomationLock>
            <SceneStatusLock xsi:nil="true" />
            <SceneStatusLock xsi:nil="true" />
          </AutomationLock>
        </SceneAutomationData>
      </GetASceneResult>
    </GetASceneResponse>
  </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>
    <GetAScene xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <DeviceID>long</DeviceID>
      <SceneID>long</SceneID>
    </GetAScene>
  </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>
    <GetASceneResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetASceneResult>
        <SceneAutomationData>
          <SceneInfoHeader>
            <SceneName>string</SceneName>
            <IsSceneEnabled>boolean</IsSceneEnabled>
            <SceneIconID>int</SceneIconID>
            <SceneID>long</SceneID>
            <InUse>boolean</InUse>
          </SceneInfoHeader>
          <AccountID>long</AccountID>
          <DeviceID>long</DeviceID>
          <DeviceSerialNumber>long</DeviceSerialNumber>
          <DeviceSerialText>string</DeviceSerialText>
          <AutomationSwitch>
            <SceneStatusSwitch xsi:nil="true" />
            <SceneStatusSwitch xsi:nil="true" />
          </AutomationSwitch>
          <AutomationThermostat>
            <SceneStatusThermostat xsi:nil="true" />
            <SceneStatusThermostat xsi:nil="true" />
          </AutomationThermostat>
          <AutomationLock>
            <SceneStatusLock xsi:nil="true" />
            <SceneStatusLock xsi:nil="true" />
          </AutomationLock>
        </SceneAutomationData>
      </GetASceneResult>
    </GetASceneResponse>
  </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/GetAScene?SessionID=string&DeviceID=string&SceneID=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"?>
<SceneDataResults xmlns="https://services.alarmnet.com/TC2/">
  <SceneAutomationData>
    <SceneInfoHeader>
      <SceneName>string</SceneName>
      <IsSceneEnabled>boolean</IsSceneEnabled>
      <SceneIconID>int</SceneIconID>
      <SceneID>long</SceneID>
      <InUse>boolean</InUse>
    </SceneInfoHeader>
    <AccountID>long</AccountID>
    <DeviceID>long</DeviceID>
    <DeviceSerialNumber>long</DeviceSerialNumber>
    <DeviceSerialText>string</DeviceSerialText>
    <AutomationSwitch>
      <SceneStatusSwitch>
        <SceneSwitchInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SceneSwitch d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SceneStatusSwitch>
      <SceneStatusSwitch>
        <SceneSwitchInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SceneSwitch d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SceneStatusSwitch>
    </AutomationSwitch>
    <AutomationThermostat>
      <SceneStatusThermostat>
        <SceneThermostatInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SceneThermostat d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SceneStatusThermostat>
      <SceneStatusThermostat>
        <SceneThermostatInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SceneThermostat d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SceneStatusThermostat>
    </AutomationThermostat>
    <AutomationLock>
      <SceneStatusLock>
        <SceneLockInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SceneLock d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SceneStatusLock>
      <SceneStatusLock>
        <SceneLockInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SceneLock d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SceneStatusLock>
    </AutomationLock>
  </SceneAutomationData>
</SceneDataResults>

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

SessionID=string&DeviceID=string&SceneID=string

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

<?xml version="1.0" encoding="utf-8"?>
<SceneDataResults xmlns="https://services.alarmnet.com/TC2/">
  <SceneAutomationData>
    <SceneInfoHeader>
      <SceneName>string</SceneName>
      <IsSceneEnabled>boolean</IsSceneEnabled>
      <SceneIconID>int</SceneIconID>
      <SceneID>long</SceneID>
      <InUse>boolean</InUse>
    </SceneInfoHeader>
    <AccountID>long</AccountID>
    <DeviceID>long</DeviceID>
    <DeviceSerialNumber>long</DeviceSerialNumber>
    <DeviceSerialText>string</DeviceSerialText>
    <AutomationSwitch>
      <SceneStatusSwitch>
        <SceneSwitchInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SceneSwitch d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SceneStatusSwitch>
      <SceneStatusSwitch>
        <SceneSwitchInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SceneSwitch d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SceneStatusSwitch>
    </AutomationSwitch>
    <AutomationThermostat>
      <SceneStatusThermostat>
        <SceneThermostatInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SceneThermostat d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SceneStatusThermostat>
      <SceneStatusThermostat>
        <SceneThermostatInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SceneThermostat d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SceneStatusThermostat>
    </AutomationThermostat>
    <AutomationLock>
      <SceneStatusLock>
        <SceneLockInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SceneLock d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SceneStatusLock>
      <SceneStatusLock>
        <SceneLockInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SceneLock d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SceneStatusLock>
    </AutomationLock>
  </SceneAutomationData>
</SceneDataResults>

Parameter	Value
SessionID:
DeviceID:
SceneID: