svcTC2API
Click here for a complete list of operations.
GetThermostat
This will return the results for one thermostat.
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/GetThermostat"
<?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>
<GetThermostat xmlns="https://services.alarmnet.com/TC2/">
<sessionID>string</sessionID>
<deviceID>long</deviceID>
<thermostatID>long</thermostatID>
</GetThermostat>
</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>
<GetThermostatResponse xmlns="https://services.alarmnet.com/TC2/">
<GetThermostatResult>
<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>
<ModeInfo xsi:nil="true" />
<ModeInfo xsi:nil="true" />
</FanModeList>
<ThermostatModeList>
<ModeInfo xsi:nil="true" />
<ModeInfo xsi:nil="true" />
</ThermostatModeList>
<ThermostatSupportedOpModeList>
<ModeInfo xsi:nil="true" />
<ModeInfo xsi:nil="true" />
</ThermostatSupportedOpModeList>
<DeviceStatusID>unsignedByte</DeviceStatusID>
<LyricUserID>int</LyricUserID>
<DateTimeUpdated>dateTime</DateTimeUpdated>
<PartnerReferenceData>
<LyricLocationID>int</LyricLocationID>
<LyricDeviceID>string</LyricDeviceID>
<TemperatureScale>string</TemperatureScale>
</PartnerReferenceData>
<DeviceType>int</DeviceType>
<ZoneName>string</ZoneName>
<AutoChangeOverEnabled>boolean</AutoChangeOverEnabled>
<SmartAway>
<Active>boolean</Active>
<TimeOfDay xsi:nil="true" />
<DurationInHours>double</DurationInHours>
<DurationInDays>unsignedByte</DurationInDays>
<LastUsedFormat>TimeOfDay or DurationInHours or DurationInDays</LastUsedFormat>
<EndsIn xsi:nil="true" />
<EndCoolSetPoint>decimal</EndCoolSetPoint>
<EndHeatSetPoint>decimal</EndHeatSetPoint>
</SmartAway>
<TCCthermostatdata>
<IndoorHumidity>short</IndoorHumidity>
<OutdoorHumidity>short</OutdoorHumidity>
<OutdoorTemperature>short</OutdoorTemperature>
<TempHoldTime>string</TempHoldTime>
<IsScheduleCapable>boolean</IsScheduleCapable>
<MinHeatSetPoint>short</MinHeatSetPoint>
<MaxHeatSetPoint>short</MaxHeatSetPoint>
<MinCoolSetPoint>short</MinCoolSetPoint>
<MaxCoolSetPoint>short</MaxCoolSetPoint>
<DeadbandforF>string</DeadbandforF>
<DeadbandforC>string</DeadbandforC>
<TCCScheduleHeatSetPoint>int</TCCScheduleHeatSetPoint>
<TCCScheduleCoolSetPoint>int</TCCScheduleCoolSetPoint>
<ThermostatMAC>string</ThermostatMAC>
<PartnerLocationID>string</PartnerLocationID>
<PartnerDeviceID>string</PartnerDeviceID>
<CurrentActivity>string</CurrentActivity>
<PartnerLocationName>string</PartnerLocationName>
</TCCthermostatdata>
<Lyricthermostatdata>
<IndoorHumidity>short</IndoorHumidity>
<OutdoorHumidity>short</OutdoorHumidity>
<OutdoorTemperature>short</OutdoorTemperature>
<TempHoldTime>string</TempHoldTime>
<MinHeatSetPoint>short</MinHeatSetPoint>
<MaxHeatSetPoint>short</MaxHeatSetPoint>
<MinCoolSetPoint>short</MinCoolSetPoint>
<MaxCoolSetPoint>short</MaxCoolSetPoint>
<DeadbandforF>string</DeadbandforF>
<DeadbandforC>string</DeadbandforC>
<ThermostatScheduleType>int</ThermostatScheduleType>
<ThermostatScheduleStatus>int</ThermostatScheduleStatus>
</Lyricthermostatdata>
</ThermostatInfo>
</GetThermostatResult>
</GetThermostatResponse>
</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>
<GetThermostat xmlns="https://services.alarmnet.com/TC2/">
<sessionID>string</sessionID>
<deviceID>long</deviceID>
<thermostatID>long</thermostatID>
</GetThermostat>
</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>
<GetThermostatResponse xmlns="https://services.alarmnet.com/TC2/">
<GetThermostatResult>
<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>
<ModeInfo xsi:nil="true" />
<ModeInfo xsi:nil="true" />
</FanModeList>
<ThermostatModeList>
<ModeInfo xsi:nil="true" />
<ModeInfo xsi:nil="true" />
</ThermostatModeList>
<ThermostatSupportedOpModeList>
<ModeInfo xsi:nil="true" />
<ModeInfo xsi:nil="true" />
</ThermostatSupportedOpModeList>
<DeviceStatusID>unsignedByte</DeviceStatusID>
<LyricUserID>int</LyricUserID>
<DateTimeUpdated>dateTime</DateTimeUpdated>
<PartnerReferenceData>
<LyricLocationID>int</LyricLocationID>
<LyricDeviceID>string</LyricDeviceID>
<TemperatureScale>string</TemperatureScale>
</PartnerReferenceData>
<DeviceType>int</DeviceType>
<ZoneName>string</ZoneName>
<AutoChangeOverEnabled>boolean</AutoChangeOverEnabled>
<SmartAway>
<Active>boolean</Active>
<TimeOfDay xsi:nil="true" />
<DurationInHours>double</DurationInHours>
<DurationInDays>unsignedByte</DurationInDays>
<LastUsedFormat>TimeOfDay or DurationInHours or DurationInDays</LastUsedFormat>
<EndsIn xsi:nil="true" />
<EndCoolSetPoint>decimal</EndCoolSetPoint>
<EndHeatSetPoint>decimal</EndHeatSetPoint>
</SmartAway>
<TCCthermostatdata>
<IndoorHumidity>short</IndoorHumidity>
<OutdoorHumidity>short</OutdoorHumidity>
<OutdoorTemperature>short</OutdoorTemperature>
<TempHoldTime>string</TempHoldTime>
<IsScheduleCapable>boolean</IsScheduleCapable>
<MinHeatSetPoint>short</MinHeatSetPoint>
<MaxHeatSetPoint>short</MaxHeatSetPoint>
<MinCoolSetPoint>short</MinCoolSetPoint>
<MaxCoolSetPoint>short</MaxCoolSetPoint>
<DeadbandforF>string</DeadbandforF>
<DeadbandforC>string</DeadbandforC>
<TCCScheduleHeatSetPoint>int</TCCScheduleHeatSetPoint>
<TCCScheduleCoolSetPoint>int</TCCScheduleCoolSetPoint>
<ThermostatMAC>string</ThermostatMAC>
<PartnerLocationID>string</PartnerLocationID>
<PartnerDeviceID>string</PartnerDeviceID>
<CurrentActivity>string</CurrentActivity>
<PartnerLocationName>string</PartnerLocationName>
</TCCthermostatdata>
<Lyricthermostatdata>
<IndoorHumidity>short</IndoorHumidity>
<OutdoorHumidity>short</OutdoorHumidity>
<OutdoorTemperature>short</OutdoorTemperature>
<TempHoldTime>string</TempHoldTime>
<MinHeatSetPoint>short</MinHeatSetPoint>
<MaxHeatSetPoint>short</MaxHeatSetPoint>
<MinCoolSetPoint>short</MinCoolSetPoint>
<MaxCoolSetPoint>short</MaxCoolSetPoint>
<DeadbandforF>string</DeadbandforF>
<DeadbandforC>string</DeadbandforC>
<ThermostatScheduleType>int</ThermostatScheduleType>
<ThermostatScheduleStatus>int</ThermostatScheduleStatus>
</Lyricthermostatdata>
</ThermostatInfo>
</GetThermostatResult>
</GetThermostatResponse>
</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/GetThermostat?sessionID=string&deviceID=string&thermostatID=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"?>
<ThermostatResponse xmlns="https://services.alarmnet.com/TC2/">
<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>
<ModeInfo ModeID="short" />
<ModeInfo ModeID="short" />
</FanModeList>
<ThermostatModeList>
<ModeInfo ModeID="short" />
<ModeInfo ModeID="short" />
</ThermostatModeList>
<ThermostatSupportedOpModeList>
<ModeInfo ModeID="short" />
<ModeInfo ModeID="short" />
</ThermostatSupportedOpModeList>
<DeviceStatusID>unsignedByte</DeviceStatusID>
<LyricUserID>int</LyricUserID>
<DateTimeUpdated>dateTime</DateTimeUpdated>
<PartnerReferenceData>
<LyricLocationID>int</LyricLocationID>
<LyricDeviceID>string</LyricDeviceID>
<TemperatureScale>string</TemperatureScale>
</PartnerReferenceData>
<DeviceType>int</DeviceType>
<ZoneName>string</ZoneName>
<AutoChangeOverEnabled>boolean</AutoChangeOverEnabled>
<SmartAway>
<Active>boolean</Active>
<TimeOfDay />
<DurationInHours>double</DurationInHours>
<DurationInDays>unsignedByte</DurationInDays>
<LastUsedFormat>TimeOfDay or DurationInHours or DurationInDays</LastUsedFormat>
<EndsIn />
<EndCoolSetPoint>decimal</EndCoolSetPoint>
<EndHeatSetPoint>decimal</EndHeatSetPoint>
</SmartAway>
<TCCthermostatdata>
<IndoorHumidity>short</IndoorHumidity>
<OutdoorHumidity>short</OutdoorHumidity>
<OutdoorTemperature>short</OutdoorTemperature>
<TempHoldTime>string</TempHoldTime>
<IsScheduleCapable>boolean</IsScheduleCapable>
<MinHeatSetPoint>short</MinHeatSetPoint>
<MaxHeatSetPoint>short</MaxHeatSetPoint>
<MinCoolSetPoint>short</MinCoolSetPoint>
<MaxCoolSetPoint>short</MaxCoolSetPoint>
<DeadbandforF>string</DeadbandforF>
<DeadbandforC>string</DeadbandforC>
<TCCScheduleHeatSetPoint>int</TCCScheduleHeatSetPoint>
<TCCScheduleCoolSetPoint>int</TCCScheduleCoolSetPoint>
<ThermostatMAC>string</ThermostatMAC>
<PartnerLocationID>string</PartnerLocationID>
<PartnerDeviceID>string</PartnerDeviceID>
<CurrentActivity>string</CurrentActivity>
<PartnerLocationName>string</PartnerLocationName>
</TCCthermostatdata>
<Lyricthermostatdata>
<IndoorHumidity>short</IndoorHumidity>
<OutdoorHumidity>short</OutdoorHumidity>
<OutdoorTemperature>short</OutdoorTemperature>
<TempHoldTime>string</TempHoldTime>
<MinHeatSetPoint>short</MinHeatSetPoint>
<MaxHeatSetPoint>short</MaxHeatSetPoint>
<MinCoolSetPoint>short</MinCoolSetPoint>
<MaxCoolSetPoint>short</MaxCoolSetPoint>
<DeadbandforF>string</DeadbandforF>
<DeadbandforC>string</DeadbandforC>
<ThermostatScheduleType>int</ThermostatScheduleType>
<ThermostatScheduleStatus>int</ThermostatScheduleStatus>
</Lyricthermostatdata>
</ThermostatInfo>
</ThermostatResponse>
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/GetThermostat HTTP/1.1 Host: rs.alarmnet.com Content-Type: application/x-www-form-urlencoded Content-Length: length sessionID=string&deviceID=string&thermostatID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ThermostatResponse xmlns="https://services.alarmnet.com/TC2/">
<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>
<ModeInfo ModeID="short" />
<ModeInfo ModeID="short" />
</FanModeList>
<ThermostatModeList>
<ModeInfo ModeID="short" />
<ModeInfo ModeID="short" />
</ThermostatModeList>
<ThermostatSupportedOpModeList>
<ModeInfo ModeID="short" />
<ModeInfo ModeID="short" />
</ThermostatSupportedOpModeList>
<DeviceStatusID>unsignedByte</DeviceStatusID>
<LyricUserID>int</LyricUserID>
<DateTimeUpdated>dateTime</DateTimeUpdated>
<PartnerReferenceData>
<LyricLocationID>int</LyricLocationID>
<LyricDeviceID>string</LyricDeviceID>
<TemperatureScale>string</TemperatureScale>
</PartnerReferenceData>
<DeviceType>int</DeviceType>
<ZoneName>string</ZoneName>
<AutoChangeOverEnabled>boolean</AutoChangeOverEnabled>
<SmartAway>
<Active>boolean</Active>
<TimeOfDay />
<DurationInHours>double</DurationInHours>
<DurationInDays>unsignedByte</DurationInDays>
<LastUsedFormat>TimeOfDay or DurationInHours or DurationInDays</LastUsedFormat>
<EndsIn />
<EndCoolSetPoint>decimal</EndCoolSetPoint>
<EndHeatSetPoint>decimal</EndHeatSetPoint>
</SmartAway>
<TCCthermostatdata>
<IndoorHumidity>short</IndoorHumidity>
<OutdoorHumidity>short</OutdoorHumidity>
<OutdoorTemperature>short</OutdoorTemperature>
<TempHoldTime>string</TempHoldTime>
<IsScheduleCapable>boolean</IsScheduleCapable>
<MinHeatSetPoint>short</MinHeatSetPoint>
<MaxHeatSetPoint>short</MaxHeatSetPoint>
<MinCoolSetPoint>short</MinCoolSetPoint>
<MaxCoolSetPoint>short</MaxCoolSetPoint>
<DeadbandforF>string</DeadbandforF>
<DeadbandforC>string</DeadbandforC>
<TCCScheduleHeatSetPoint>int</TCCScheduleHeatSetPoint>
<TCCScheduleCoolSetPoint>int</TCCScheduleCoolSetPoint>
<ThermostatMAC>string</ThermostatMAC>
<PartnerLocationID>string</PartnerLocationID>
<PartnerDeviceID>string</PartnerDeviceID>
<CurrentActivity>string</CurrentActivity>
<PartnerLocationName>string</PartnerLocationName>
</TCCthermostatdata>
<Lyricthermostatdata>
<IndoorHumidity>short</IndoorHumidity>
<OutdoorHumidity>short</OutdoorHumidity>
<OutdoorTemperature>short</OutdoorTemperature>
<TempHoldTime>string</TempHoldTime>
<MinHeatSetPoint>short</MinHeatSetPoint>
<MaxHeatSetPoint>short</MaxHeatSetPoint>
<MinCoolSetPoint>short</MinCoolSetPoint>
<MaxCoolSetPoint>short</MaxCoolSetPoint>
<DeadbandforF>string</DeadbandforF>
<DeadbandforC>string</DeadbandforC>
<ThermostatScheduleType>int</ThermostatScheduleType>
<ThermostatScheduleStatus>int</ThermostatScheduleStatus>
</Lyricthermostatdata>
</ThermostatInfo>
</ThermostatResponse>