Power Control Module API Overview
Power Control Module API Overview There are two primary Power Control Module API categories which allow you to retrieve or set the active statuses and schedules. At this time there is not a Power Control Module historical API. PowerOutput Attributes PowerOutput attributes allows you to change active statuses of the Power Control Module. Click here […]
ThermostatUsage Attributes
ThermostatUsage ThermostatUsage attributes allows you to retrieve thermostat run-time and consumption related historical information. A ThermostatUsage request must include at least the required selection attributes, which specify a starting date/time (startDateTime), an ending date/time (endDateTime), and how the data is to be returned (duration). If you do not specify any ThermostatUsage object attributes in the request, […]
ThermostatHistory Attributes
ThermostatHistory ThermostatHistory attributes allows you to retrieve thermostat historical readings and setpoint information. A ThermostatHistory request must include at least the required selection attributes, which specify a starting date/time (startDateTime) and an ending date/time (endDateTime). If you do not specify any ThermostatHistory object attributes in the request, so only the date range is part of the request, then all ThermostatHistory object […]
SharedSchedule Attributes
SharedSchedule – Object Attributes SharedSchedule attributes list and allow you to set shareable schedules for thermostats. Attribute names are not case sensitive. Attribute values are case sensitive. Name Values Settable Description name String Yes The configured name of the thermostat. scheduleRepeat String Yes The schedule repeat. For “Daily” only the “Sunday” dayOfWeek will be used. […]
ThermostatEvent Attributes
ThermostatEvent ThermostatEvent allow you to set scheduled one-time events that override a thermostat’s standard recurring schedule. This interface allows events to be added, modified, or deleted. In addition, existing pending events can be retrieved. If an event is added through the API it is tracked as an “External” event. There are no restrictions on the […]
ThermostatSchedule Attributes
ThermostatSchedule – Object Attributes ThermostatSchedule attributes list and allow you to set thermostat’s recurring schedules. Attribute names are not case sensitive. Attribute values are case sensitive. Name Values Settable Description name String Yes The configured name of the thermostat. serialNo String No The thermostat’s serial number. Unique factory set identifier. dayOfWeek Sunday, Monday, Tuesday, Wednesday, […]
Thermostat API Overview
Thermostat API Overview There are six primary thermostat API categories which allows you to retrieve and set configurations, active statuses, schedules, and retrieve historical information. You can use these APIs to retrieve and/or write to individual thermostats, all thermostats, or a subsets of thermostats. Thermostat Attributes Thermostat attributes allow you to set and retrieve thermostat […]
Thermostat Attributes
Thermostat Thermostat attributes allow you to set and retrieve thermostat configurations and active statuses. Thermostat – Reserved versus User Defined Attributes There are two types of attributes supported for “Thermostat” objects. The first type are listed below, which are reserved and predefined. In addition to the predefined attributes, users can define, set and retrieve their […]
Best practices
Best Practices Date formats Date formats are in ISO 8601 Timestamp format, yyyy-mm-ddTxx:xx:xxZ, format for setting and returning date values (For example: {“startDateTime”: “2022-07-03T00:00:00Z”,). Create a Developer User If you are using the Pelican API to GET or POST to one or multiple Pelican Sites, it is advisable to create a separate (non-personal) user just for integration […]
Responses
Responses Responses use the customary HTTP status codes, with the most typical ones being: Code Meaning Responses 1 success 0 failure A “0” or failure response, includes an error message shown in human readable text under the element named “message”. Sample Request: https://demo.officeclimatecontrol.net/api.cgi?username=myname@gmail.com&password=mypassword&request=get&object=Thermostat&selection=name:TestThermostat;&value=heatSetting;coolSetting;temperature; Sample Result If request returned successful: TestThermostat 68 72 70 1 If […]