GetSchedule
GET
Get Schedule
Get current schedule for a given DeviceID
{
"deviceID": "string",
"scheduleType": "None",
"scheduleSubType": "NA",
"timedSchedule": {
"days": [
{
"day": "Monday",
"periods": [
{
"isCancelled": true,
"periodType": "Wake",
"periodName": "string",
"startTime": "string",
"heatSetPoint": 0,
"coolSetPoint": 0,
"fanSwitch": {
"position": "Auto",
"speed": 0
},
"priority": {
"priorityType": "WholeHouse",
"selectedRooms": [
0
]
},
"schedSysSwitch": "On"
}
]
}
]
},
"geoFenceSchedule": {
"homePeriod": {
"heatSetPoint": 0,
"coolSetPoint": 0,
"fanSwitch": {
"position": "Auto",
"speed": 0
},
"priority": {
"priorityType": "WholeHouse",
"selectedRooms": [
0
]
},
"schedSysSwitch": "On"
},
"awayPeriod": {
"heatSetPoint": 0,
"coolSetPoint": 0,
"fanSwitch": {
"position": "Auto",
"speed": 0
},
"priority": {
"priorityType": "WholeHouse",
"selectedRooms": [
0
]
},
"schedSysSwitch": "On"
},
"sleepMode": {
"triggers": [
{
"startTime": "string",
"endTime": "string",
"days": [
"Sunday"
]
}
],
"heatSetPoint": 0,
"coolSetPoint": 0,
"fanSwitch": {
"position": "Auto",
"speed": 0
},
"priority": {
"priorityType": "WholeHouse",
"selectedRooms": [
0
]
},
"schedSysSwitch": "On"
}
},
"otbUpgrading": true,
"scheduleChangeSource": {
"by": "string",
"name": "string"
}
}
| Field Name/Location | Data Type | Definition | Required |
|---|---|---|---|
| deviceID | String | DeviceID associated to the schedule | Y |
| scheduleType | Enum | Schedule type, possible values: None,Geofenced,GeofencedWithSleep,Timed,Partner | Y |
| scheduleSubType | Enum | Secondary schedule type, "NA", "EMEA", "NONE" | N |
| timedSchedule | Object | Contains schedule settings | |
| timedSchedule.days | Array | Contains schedule settings | |
| timedSchedule.days.day | Enum | Day of the week 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' | |
| timedSchedule.days.periods | Object | Schedule periods for the given day | |
| timedSchedule.days.periods.isCancelled | Boolean | True/false if the period is enabled for a given day | |
| timedSchedule.days.periods.periodType | String | Period of the day (e.g, "Wake", "Away", "Home", "Sleep") | |
| timedSchedule.days.periods.startTime | String | Time of the day the schedule period starts, in local time. Always 15 minute increments. | |
| timedSchedule.days.periods.heatSetPoint | Integer | Heating setpoint for the period | |
| timedSchedule.days.periods.coolSetPoint | Integer | Cooling setpoint for the period | |
| timedSchedule.days.periods.fanSwitch | Object | Fan switch scheduling (T9/T10 only) | |
| timedSchedule.days.periods.fanSwitch.position | Enum | Auto, On, Circulate, FollowSchedule | |
| timedSchedule.days.periods.fanSwitch.speed | Number | Always 0 | |
| timedSchedule.days.periods.priority | Object | Sensor priority setting for scheduled period (T9/T10 Only) | |
| timedSchedule.days.periods.priority.priorityType | Enum | WholeHouse, PickARoom,FollowMe | |
| timedSchedule.days.periods.priority.selectedRooms | Array | Array of Numbers of Rooms to Prioritize (via Rooms/Groups API) | |
Resource URL
https://api.honeywellhome.com/v2 /devices/schedule/{deviceId}
Query Parameters
| Name | Values | Description |
|---|---|---|
|
apikey
(required) |
Your API Key |
|
|
locationId
(required) |
LocationID for the requested device |
|
|
type
(required) |
Schedule Type |
Request Body
deviceId DeviceID for the requested device true
Make a request and see the response.
Make a request and see the response.
Make a request and see the response.
Resource Summary |
|
|
Security |
|
|
Category |
Thermostat |
Working...