Get a Climate Setting Schedule

/thermostats/climate_setting_schedules/get

POSThttps://connect.getseam.com/thermostats/climate_setting_schedules/get

Authorization

client_sessionpat_with_workspaceconsole_sessionapi_key

Body

application/json

climate_setting_schedule_idstring (uuid)

device_idstring (uuid)

Response

200400401

OK

Body

application/json

climate_setting_schedule*climate_setting_schedule (object)

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/thermostats/climate_setting_schedules/get', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Client Session Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "climate_setting_schedule": {
    "climate_setting_schedule_id": "123e4567-e89b-12d3-a456-426614174000",
    "schedule_type": "time_bound",
    "device_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "schedule_starts_at": "text",
    "schedule_ends_at": "text",
    "created_at": "2024-04-27T11:19:39.955Z",
    "automatic_heating_enabled": false,
    "automatic_cooling_enabled": false,
    "hvac_mode_setting": "off",
    "cooling_set_point_celsius": 0,
    "heating_set_point_celsius": 0,
    "cooling_set_point_fahrenheit": 0,
    "heating_set_point_fahrenheit": 0,
    "manual_override_allowed": false
  },
  "ok": false
}

Code Example

Python

seam.climate_setting_schedules.get("123e4567-e89b-12d3-a456-426614174000")

# ClimateSettingSchedule:
#    climate_setting_schedule_id: 123e4567-e89b-12d3-a456-426614174000
#    device_id: 123e4567-e89b-12d3-a456-426614174001
#    name: Guest Stay #1234  
#    schedule_starts_at: 2022-07-01T10:40:00Z    
#    schedule_ends_at: 2022-07-10T10:40:00Z     
#    created_at: 2022-07-06T23:26:42.223Z      
#    is_set_on_device: False
#    automatic_heating_enabled: True
#    automatic_cooling_enabled: True  
#    hvac_mode_setting: heat_cool
#    cooling_set_point_fahrenheit: 75 
#    heating_set_point_fahrenheit: 65
#    manual_override_allowed: True

Javascript

seam.climateSettingSchedules.get({
  climate_setting_schedule_id: "123e4567-e89b-12d3-a456-426614174000"
})

// {
//   "climate_setting_schedule_id": "123e4567-e89b-12d3-a456-426614174000",
//   "device_id": "123e4567-e89b-12d3-a456-426614174001",
//   "name": "Guest Stay #1234",
//   "schedule_starts_at": "2022-07-01T10:40:00Z",
//   "schedule_ends_at": "2022-07-10T10:40:00Z",
//   "created_at": "2022-07-06T23:26:42.223Z",
//   "is_set_on_device": false,
//   "automatic_heating_enabled": true,
//   "automatic_cooling_enabled": true,
//   "hvac_mode_setting": "heat_cool",
//   "cooling_set_point_fahrenheit": 75,
//   "heating_set_point_fahrenheit": 65,
//   "manual_override_allowed": false
// }

Parameters

climate_setting_schedule_id

type: string

ID of the Climate Setting Schedule

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

JSON

{
  "climate_setting_schedule": {
    "climate_setting_schedule_id": "123e4567-e89b-12d3-a456-426614174000",
    "device_id": "123e4567-e89b-12d3-a456-426614174001",
    "name": "Guest Stay #1234",
    "schedule_starts_at": "2022-07-01T10:40:00Z",
    "schedule_ends_at": "2022-07-10T10:40:00Z",
    "created_at": "2022-07-06T23:26:42.223Z",
    "is_set_on_device": false,
    "automatic_heating_enabled": true,
    "automatic_cooling_enabled": true,
    "hvac_mode_setting": "heat_cool",
    "cooling_set_point_fahrenheit": 75,
    "heating_set_point_fahrenheit": 65,
    "manual_override_allowed": true
  },
  "ok": true
}