svcTC2API
Click here for a complete list of operations.
GetThermostatSchedule
Get a Thermostat schedule (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/GetThermostatSchedule"
<?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>
<GetThermostatSchedule xmlns="https://services.alarmnet.com/TC2/">
<SessionID>string</SessionID>
<DeviceID>long</DeviceID>
<ThermostatID>long</ThermostatID>
</GetThermostatSchedule>
</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>
<GetThermostatScheduleResponse xmlns="https://services.alarmnet.com/TC2/">
<GetThermostatScheduleResult>
<ThermostatSchedule>
<ThermostatID>long</ThermostatID>
<SetPoints>
<ScheduleInfo xsi:nil="true" />
<ScheduleInfo xsi:nil="true" />
</SetPoints>
<HighThresholdValue>short</HighThresholdValue>
<LowThresholdValue>short</LowThresholdValue>
<HighThresholdStatus>int</HighThresholdStatus>
<LowThresholdStatus>int</LowThresholdStatus>
</ThermostatSchedule>
</GetThermostatScheduleResult>
</GetThermostatScheduleResponse>
</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>
<GetThermostatSchedule xmlns="https://services.alarmnet.com/TC2/">
<SessionID>string</SessionID>
<DeviceID>long</DeviceID>
<ThermostatID>long</ThermostatID>
</GetThermostatSchedule>
</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>
<GetThermostatScheduleResponse xmlns="https://services.alarmnet.com/TC2/">
<GetThermostatScheduleResult>
<ThermostatSchedule>
<ThermostatID>long</ThermostatID>
<SetPoints>
<ScheduleInfo xsi:nil="true" />
<ScheduleInfo xsi:nil="true" />
</SetPoints>
<HighThresholdValue>short</HighThresholdValue>
<LowThresholdValue>short</LowThresholdValue>
<HighThresholdStatus>int</HighThresholdStatus>
<LowThresholdStatus>int</LowThresholdStatus>
</ThermostatSchedule>
</GetThermostatScheduleResult>
</GetThermostatScheduleResponse>
</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/GetThermostatSchedule?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"?>
<ThermostatScheduleResults xmlns="https://services.alarmnet.com/TC2/">
<ThermostatSchedule>
<ThermostatID>long</ThermostatID>
<SetPoints>
<ScheduleInfo>
<ScheduleID>long</ScheduleID>
<ScheduleDay>short</ScheduleDay>
<TimePeriods d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</ScheduleInfo>
<ScheduleInfo>
<ScheduleID>long</ScheduleID>
<ScheduleDay>short</ScheduleDay>
<TimePeriods d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</ScheduleInfo>
</SetPoints>
<HighThresholdValue>short</HighThresholdValue>
<LowThresholdValue>short</LowThresholdValue>
<HighThresholdStatus>int</HighThresholdStatus>
<LowThresholdStatus>int</LowThresholdStatus>
</ThermostatSchedule>
</ThermostatScheduleResults>
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/GetThermostatSchedule 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"?>
<ThermostatScheduleResults xmlns="https://services.alarmnet.com/TC2/">
<ThermostatSchedule>
<ThermostatID>long</ThermostatID>
<SetPoints>
<ScheduleInfo>
<ScheduleID>long</ScheduleID>
<ScheduleDay>short</ScheduleDay>
<TimePeriods d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</ScheduleInfo>
<ScheduleInfo>
<ScheduleID>long</ScheduleID>
<ScheduleDay>short</ScheduleDay>
<TimePeriods d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</ScheduleInfo>
</SetPoints>
<HighThresholdValue>short</HighThresholdValue>
<LowThresholdValue>short</LowThresholdValue>
<HighThresholdStatus>int</HighThresholdStatus>
<LowThresholdStatus>int</LowThresholdStatus>
</ThermostatSchedule>
</ThermostatScheduleResults>