GET api/v1/devices/{deviceId}/automation/schedule/{thermostatId}

Get a Thermostat schedule (from database) Equivalent SOAP API : GetThermostatSchedule

Request Information

URI Parameters

Name	Description	Type	Additional information
deviceId	deviceId	integer	Required
thermostatId	thermostatId	integer	Required

Body Parameters

None.

Response Information

Resource Description

ThermostatScheduleResults

Name	Type	Additional information
ThermostatSchedule	ThermostatSchedule	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ThermostatSchedule": {
    "ThermostatID": 1,
    "SetPoints": [
      {
        "ScheduleID": 1,
        "ScheduleDay": 2,
        "TimePeriods": [
          {
            "Index": 1,
            "Enabled": true,
            "TempHeat": 3,
            "TempCool": 4,
            "Time": "sample string 5"
          },
          {
            "Index": 1,
            "Enabled": true,
            "TempHeat": 3,
            "TempCool": 4,
            "Time": "sample string 5"
          }
        ]
      },
      {
        "ScheduleID": 1,
        "ScheduleDay": 2,
        "TimePeriods": [
          {
            "Index": 1,
            "Enabled": true,
            "TempHeat": 3,
            "TempCool": 4,
            "Time": "sample string 5"
          },
          {
            "Index": 1,
            "Enabled": true,
            "TempHeat": 3,
            "TempCool": 4,
            "Time": "sample string 5"
          }
        ]
      }
    ],
    "HighThresholdValue": 2,
    "LowThresholdValue": 3,
    "HighThresholdStatus": 4,
    "LowThresholdStatus": 5
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<ThermostatScheduleResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <ThermostatSchedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Automation">
    <d2p1:HighThresholdStatus>4</d2p1:HighThresholdStatus>
    <d2p1:HighThresholdValue>2</d2p1:HighThresholdValue>
    <d2p1:LowThresholdStatus>5</d2p1:LowThresholdStatus>
    <d2p1:LowThresholdValue>3</d2p1:LowThresholdValue>
    <d2p1:SetPoints>
      <d2p1:ScheduleInfo>
        <d2p1:ScheduleDay>2</d2p1:ScheduleDay>
        <d2p1:ScheduleID>1</d2p1:ScheduleID>
        <d2p1:TimePeriods>
          <d2p1:TimePeriodInfo>
            <d2p1:Enabled>true</d2p1:Enabled>
            <d2p1:Index>1</d2p1:Index>
            <d2p1:TempCool>4</d2p1:TempCool>
            <d2p1:TempHeat>3</d2p1:TempHeat>
            <d2p1:Time>sample string 5</d2p1:Time>
          </d2p1:TimePeriodInfo>
          <d2p1:TimePeriodInfo>
            <d2p1:Enabled>true</d2p1:Enabled>
            <d2p1:Index>1</d2p1:Index>
            <d2p1:TempCool>4</d2p1:TempCool>
            <d2p1:TempHeat>3</d2p1:TempHeat>
            <d2p1:Time>sample string 5</d2p1:Time>
          </d2p1:TimePeriodInfo>
        </d2p1:TimePeriods>
      </d2p1:ScheduleInfo>
      <d2p1:ScheduleInfo>
        <d2p1:ScheduleDay>2</d2p1:ScheduleDay>
        <d2p1:ScheduleID>1</d2p1:ScheduleID>
        <d2p1:TimePeriods>
          <d2p1:TimePeriodInfo>
            <d2p1:Enabled>true</d2p1:Enabled>
            <d2p1:Index>1</d2p1:Index>
            <d2p1:TempCool>4</d2p1:TempCool>
            <d2p1:TempHeat>3</d2p1:TempHeat>
            <d2p1:Time>sample string 5</d2p1:Time>
          </d2p1:TimePeriodInfo>
          <d2p1:TimePeriodInfo>
            <d2p1:Enabled>true</d2p1:Enabled>
            <d2p1:Index>1</d2p1:Index>
            <d2p1:TempCool>4</d2p1:TempCool>
            <d2p1:TempHeat>3</d2p1:TempHeat>
            <d2p1:Time>sample string 5</d2p1:Time>
          </d2p1:TimePeriodInfo>
        </d2p1:TimePeriods>
      </d2p1:ScheduleInfo>
    </d2p1:SetPoints>
    <d2p1:ThermostatID>1</d2p1:ThermostatID>
  </ThermostatSchedule>
</ThermostatScheduleResults>