How Can We Help?
Print

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:

				
					<xml version="1.0" encoding="UTF8"?>
  <result>
   <Thermostat>
    <name>TestThermostat</name>
    <heatSetting>68</heatSetting>
    <coolSetting>72</coolSetting>
    <temperature>70</temperatur>
   <Thermostat>
   <success>1</success>
  </result>
				
			

If "TestThermostat" was not found by the system, the following error "message" reply would be returned:

				
					 <?xml version="1.0" encoding="UTF8"?>
    <result>
     <success>0</success>
     <message>No thermostats found matching selection criteria.</message>
   </result>