svcTC2API
Click here for a complete list of operations.
GetAutomationDeviceStatusEx
[Transitional State for lock] Get info for all Automation devices per Automation panel (during a panel session from panel, otherwise from 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/GetAutomationDeviceStatusEx"
<?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>
<GetAutomationDeviceStatusEx xmlns="https://services.alarmnet.com/TC2/">
<SessionID>string</SessionID>
<DeviceID>long</DeviceID>
<AdditionalInput>string</AdditionalInput>
</GetAutomationDeviceStatusEx>
</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>
<GetAutomationDeviceStatusExResponse xmlns="https://services.alarmnet.com/TC2/">
<GetAutomationDeviceStatusExResult>
<AutomationData>
<AccountID>long</AccountID>
<DeviceID>long</DeviceID>
<DeviceSerialNumber>long</DeviceSerialNumber>
<DeviceSerialText>string</DeviceSerialText>
<LockCapacity>short</LockCapacity>
<SwitchCapacity>short</SwitchCapacity>
<ThermostatCapacity>short</ThermostatCapacity>
<SceneCapacity>short</SceneCapacity>
<DeviceCapacityPerScene>short</DeviceCapacityPerScene>
<SyncDeviceFlag>boolean</SyncDeviceFlag>
<CommunicationState>boolean</CommunicationState>
<AutomationStatusLimit>int</AutomationStatusLimit>
<AutomationSwitch>
<SwitchInfo xsi:nil="true" />
<SwitchInfo xsi:nil="true" />
</AutomationSwitch>
<AutomationThermostat>
<ThermostatInfo xsi:nil="true" />
<ThermostatInfo xsi:nil="true" />
</AutomationThermostat>
<AutomationLock>
<LockInfo_Transitional xsi:nil="true" />
<LockInfo_Transitional xsi:nil="true" />
</AutomationLock>
<paneltype>int</paneltype>
</AutomationData>
</GetAutomationDeviceStatusExResult>
</GetAutomationDeviceStatusExResponse>
</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>
<GetAutomationDeviceStatusEx xmlns="https://services.alarmnet.com/TC2/">
<SessionID>string</SessionID>
<DeviceID>long</DeviceID>
<AdditionalInput>string</AdditionalInput>
</GetAutomationDeviceStatusEx>
</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>
<GetAutomationDeviceStatusExResponse xmlns="https://services.alarmnet.com/TC2/">
<GetAutomationDeviceStatusExResult>
<AutomationData>
<AccountID>long</AccountID>
<DeviceID>long</DeviceID>
<DeviceSerialNumber>long</DeviceSerialNumber>
<DeviceSerialText>string</DeviceSerialText>
<LockCapacity>short</LockCapacity>
<SwitchCapacity>short</SwitchCapacity>
<ThermostatCapacity>short</ThermostatCapacity>
<SceneCapacity>short</SceneCapacity>
<DeviceCapacityPerScene>short</DeviceCapacityPerScene>
<SyncDeviceFlag>boolean</SyncDeviceFlag>
<CommunicationState>boolean</CommunicationState>
<AutomationStatusLimit>int</AutomationStatusLimit>
<AutomationSwitch>
<SwitchInfo xsi:nil="true" />
<SwitchInfo xsi:nil="true" />
</AutomationSwitch>
<AutomationThermostat>
<ThermostatInfo xsi:nil="true" />
<ThermostatInfo xsi:nil="true" />
</AutomationThermostat>
<AutomationLock>
<LockInfo_Transitional xsi:nil="true" />
<LockInfo_Transitional xsi:nil="true" />
</AutomationLock>
<paneltype>int</paneltype>
</AutomationData>
</GetAutomationDeviceStatusExResult>
</GetAutomationDeviceStatusExResponse>
</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/GetAutomationDeviceStatusEx?SessionID=string&DeviceID=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"?>
<AutomationDataResults_Transitional xmlns="https://services.alarmnet.com/TC2/">
<AutomationData>
<AccountID>long</AccountID>
<DeviceID>long</DeviceID>
<DeviceSerialNumber>long</DeviceSerialNumber>
<DeviceSerialText>string</DeviceSerialText>
<LockCapacity>short</LockCapacity>
<SwitchCapacity>short</SwitchCapacity>
<ThermostatCapacity>short</ThermostatCapacity>
<SceneCapacity>short</SceneCapacity>
<DeviceCapacityPerScene>short</DeviceCapacityPerScene>
<SyncDeviceFlag>boolean</SyncDeviceFlag>
<CommunicationState>boolean</CommunicationState>
<AutomationStatusLimit>int</AutomationStatusLimit>
<AutomationSwitch>
<SwitchInfo>
<DeviceID>long</DeviceID>
<SwitchID>long</SwitchID>
<SwitchName>string</SwitchName>
<SwitchIndex>short</SwitchIndex>
<SwitchType>int</SwitchType>
<SwitchState>short</SwitchState>
<SwitchLevel>short</SwitchLevel>
<SwitchIconID>short</SwitchIconID>
<DeviceStatusID>unsignedByte</DeviceStatusID>
<CanRemoteClose>short</CanRemoteClose>
<DateTimeUpdated>dateTime</DateTimeUpdated>
<FaultStatusId>short</FaultStatusId>
<EndUserControl>unsignedByte</EndUserControl>
<EndUserVisibility>unsignedByte</EndUserVisibility>
</SwitchInfo>
<SwitchInfo>
<DeviceID>long</DeviceID>
<SwitchID>long</SwitchID>
<SwitchName>string</SwitchName>
<SwitchIndex>short</SwitchIndex>
<SwitchType>int</SwitchType>
<SwitchState>short</SwitchState>
<SwitchLevel>short</SwitchLevel>
<SwitchIconID>short</SwitchIconID>
<DeviceStatusID>unsignedByte</DeviceStatusID>
<CanRemoteClose>short</CanRemoteClose>
<DateTimeUpdated>dateTime</DateTimeUpdated>
<FaultStatusId>short</FaultStatusId>
<EndUserControl>unsignedByte</EndUserControl>
<EndUserVisibility>unsignedByte</EndUserVisibility>
</SwitchInfo>
</AutomationSwitch>
<AutomationThermostat>
<ThermostatInfo>
<DeviceID>long</DeviceID>
<ThermostatID>long</ThermostatID>
<ThermostatName>string</ThermostatName>
<ThermostatIndex>short</ThermostatIndex>
<CurrentOpMode>short</CurrentOpMode>
<ThermostatMode>short</ThermostatMode>
<ThermostatFanMode>short</ThermostatFanMode>
<ThermostatVersion>string</ThermostatVersion>
<HeatSetPoint>short</HeatSetPoint>
<CoolSetPoint>short</CoolSetPoint>
<EnergySaveHeatSetPoint>short</EnergySaveHeatSetPoint>
<EnergySaveCoolSetPoint>short</EnergySaveCoolSetPoint>
<TemperatureScale>string</TemperatureScale>
<CurrentTemperture>short</CurrentTemperture>
<BatteryState>short</BatteryState>
<FanModeList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<ThermostatModeList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<ThermostatSupportedOpModeList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<DeviceStatusID>unsignedByte</DeviceStatusID>
<LyricUserID>int</LyricUserID>
<DateTimeUpdated>dateTime</DateTimeUpdated>
<PartnerReferenceData d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<DeviceType>int</DeviceType>
<ZoneName>string</ZoneName>
<AutoChangeOverEnabled>boolean</AutoChangeOverEnabled>
<SmartAway d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<TCCthermostatdata d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Lyricthermostatdata d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</ThermostatInfo>
<ThermostatInfo>
<DeviceID>long</DeviceID>
<ThermostatID>long</ThermostatID>
<ThermostatName>string</ThermostatName>
<ThermostatIndex>short</ThermostatIndex>
<CurrentOpMode>short</CurrentOpMode>
<ThermostatMode>short</ThermostatMode>
<ThermostatFanMode>short</ThermostatFanMode>
<ThermostatVersion>string</ThermostatVersion>
<HeatSetPoint>short</HeatSetPoint>
<CoolSetPoint>short</CoolSetPoint>
<EnergySaveHeatSetPoint>short</EnergySaveHeatSetPoint>
<EnergySaveCoolSetPoint>short</EnergySaveCoolSetPoint>
<TemperatureScale>string</TemperatureScale>
<CurrentTemperture>short</CurrentTemperture>
<BatteryState>short</BatteryState>
<FanModeList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<ThermostatModeList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<ThermostatSupportedOpModeList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<DeviceStatusID>unsignedByte</DeviceStatusID>
<LyricUserID>int</LyricUserID>
<DateTimeUpdated>dateTime</DateTimeUpdated>
<PartnerReferenceData d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<DeviceType>int</DeviceType>
<ZoneName>string</ZoneName>
<AutoChangeOverEnabled>boolean</AutoChangeOverEnabled>
<SmartAway d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<TCCthermostatdata d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Lyricthermostatdata d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</ThermostatInfo>
</AutomationThermostat>
<AutomationLock>
<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>
</AutomationLock>
<paneltype>int</paneltype>
</AutomationData>
</AutomationDataResults_Transitional>
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/GetAutomationDeviceStatusEx HTTP/1.1 Host: rs.alarmnet.com Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&DeviceID=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"?>
<AutomationDataResults_Transitional xmlns="https://services.alarmnet.com/TC2/">
<AutomationData>
<AccountID>long</AccountID>
<DeviceID>long</DeviceID>
<DeviceSerialNumber>long</DeviceSerialNumber>
<DeviceSerialText>string</DeviceSerialText>
<LockCapacity>short</LockCapacity>
<SwitchCapacity>short</SwitchCapacity>
<ThermostatCapacity>short</ThermostatCapacity>
<SceneCapacity>short</SceneCapacity>
<DeviceCapacityPerScene>short</DeviceCapacityPerScene>
<SyncDeviceFlag>boolean</SyncDeviceFlag>
<CommunicationState>boolean</CommunicationState>
<AutomationStatusLimit>int</AutomationStatusLimit>
<AutomationSwitch>
<SwitchInfo>
<DeviceID>long</DeviceID>
<SwitchID>long</SwitchID>
<SwitchName>string</SwitchName>
<SwitchIndex>short</SwitchIndex>
<SwitchType>int</SwitchType>
<SwitchState>short</SwitchState>
<SwitchLevel>short</SwitchLevel>
<SwitchIconID>short</SwitchIconID>
<DeviceStatusID>unsignedByte</DeviceStatusID>
<CanRemoteClose>short</CanRemoteClose>
<DateTimeUpdated>dateTime</DateTimeUpdated>
<FaultStatusId>short</FaultStatusId>
<EndUserControl>unsignedByte</EndUserControl>
<EndUserVisibility>unsignedByte</EndUserVisibility>
</SwitchInfo>
<SwitchInfo>
<DeviceID>long</DeviceID>
<SwitchID>long</SwitchID>
<SwitchName>string</SwitchName>
<SwitchIndex>short</SwitchIndex>
<SwitchType>int</SwitchType>
<SwitchState>short</SwitchState>
<SwitchLevel>short</SwitchLevel>
<SwitchIconID>short</SwitchIconID>
<DeviceStatusID>unsignedByte</DeviceStatusID>
<CanRemoteClose>short</CanRemoteClose>
<DateTimeUpdated>dateTime</DateTimeUpdated>
<FaultStatusId>short</FaultStatusId>
<EndUserControl>unsignedByte</EndUserControl>
<EndUserVisibility>unsignedByte</EndUserVisibility>
</SwitchInfo>
</AutomationSwitch>
<AutomationThermostat>
<ThermostatInfo>
<DeviceID>long</DeviceID>
<ThermostatID>long</ThermostatID>
<ThermostatName>string</ThermostatName>
<ThermostatIndex>short</ThermostatIndex>
<CurrentOpMode>short</CurrentOpMode>
<ThermostatMode>short</ThermostatMode>
<ThermostatFanMode>short</ThermostatFanMode>
<ThermostatVersion>string</ThermostatVersion>
<HeatSetPoint>short</HeatSetPoint>
<CoolSetPoint>short</CoolSetPoint>
<EnergySaveHeatSetPoint>short</EnergySaveHeatSetPoint>
<EnergySaveCoolSetPoint>short</EnergySaveCoolSetPoint>
<TemperatureScale>string</TemperatureScale>
<CurrentTemperture>short</CurrentTemperture>
<BatteryState>short</BatteryState>
<FanModeList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<ThermostatModeList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<ThermostatSupportedOpModeList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<DeviceStatusID>unsignedByte</DeviceStatusID>
<LyricUserID>int</LyricUserID>
<DateTimeUpdated>dateTime</DateTimeUpdated>
<PartnerReferenceData d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<DeviceType>int</DeviceType>
<ZoneName>string</ZoneName>
<AutoChangeOverEnabled>boolean</AutoChangeOverEnabled>
<SmartAway d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<TCCthermostatdata d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Lyricthermostatdata d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</ThermostatInfo>
<ThermostatInfo>
<DeviceID>long</DeviceID>
<ThermostatID>long</ThermostatID>
<ThermostatName>string</ThermostatName>
<ThermostatIndex>short</ThermostatIndex>
<CurrentOpMode>short</CurrentOpMode>
<ThermostatMode>short</ThermostatMode>
<ThermostatFanMode>short</ThermostatFanMode>
<ThermostatVersion>string</ThermostatVersion>
<HeatSetPoint>short</HeatSetPoint>
<CoolSetPoint>short</CoolSetPoint>
<EnergySaveHeatSetPoint>short</EnergySaveHeatSetPoint>
<EnergySaveCoolSetPoint>short</EnergySaveCoolSetPoint>
<TemperatureScale>string</TemperatureScale>
<CurrentTemperture>short</CurrentTemperture>
<BatteryState>short</BatteryState>
<FanModeList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<ThermostatModeList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<ThermostatSupportedOpModeList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<DeviceStatusID>unsignedByte</DeviceStatusID>
<LyricUserID>int</LyricUserID>
<DateTimeUpdated>dateTime</DateTimeUpdated>
<PartnerReferenceData d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<DeviceType>int</DeviceType>
<ZoneName>string</ZoneName>
<AutoChangeOverEnabled>boolean</AutoChangeOverEnabled>
<SmartAway d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<TCCthermostatdata d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Lyricthermostatdata d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</ThermostatInfo>
</AutomationThermostat>
<AutomationLock>
<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>
</AutomationLock>
<paneltype>int</paneltype>
</AutomationData>
</AutomationDataResults_Transitional>