Response Codes

The following response codes may be returned by the API in the Status object as part of the response. Most errors will contain additional information along with the message below.

Code Message Meaning and Recovery
0 Success Your request was successfully received and processed.
1 Authentication failed. Invalid credentials supplied to the registration request, or invalid token. Request registration again.
2 Not authorized. Attempted to access resources which user is not authorized for. Ensure the thermostat identifiers requested are correct.
3 Processing error. General catch-all error for a number of internal errors. Additional info may be provided in the message. Check your request. Contact support if persists.
4 Serialization error. An internal error mapping data to or from the API transmission format. Contact support.
5 Invalid request format. An error mapping the request data to internal data objects. Ensure that the properties being sent match properties in the specification.
6 Too many thermostat in selection match criteria. Too many identifiers are specified in the Selecton.selectionMatch property. Current limit is 25 per request.
7 Validation error. The update request contained values out of range or too large for the field being updated. See the additional message information as to what caused the validation failure.
8 Invalid function. The "type" property of the function does not match an available function. Check your request parameters.
9 Invalid selection. The Selection.selectionType property contains an invalid value.
10 Invalid page. The page requested in the request is invalid. Occurs if the page is less than 1 or more than the number of available pages for the request.
11 Function error. An error occurred processing a function. Ensure required properties are provided.
12 Post not supported for request. The request URL does not support POST.
13 Get not supported for request. The request URL does not support GET.
14 Authentication token has expired. Refresh your tokens. See Token Refresh
15 Duplicate data violation. Fix the data which is duplicated and re-post.
16 Invalid token. Token has been deauthorized by user. You must re-request authorization. Check the token data. See Authorization Strategy

Back To Top