Automation API Responses

After sending an authorization request to the intended API, Control Manager returns a response indicating whether the request was successful.

The response should always be a JSON-formatted APIResponseObject in the following format:

{
 "result_code":(an integer indicating
      the result of this API call),
 "result_description":"(a string 
      describing the result code)",
 "result_content":"(if provided, a 
      JSON object representing the 
      return value of the API)"
}
Note:

For a complete list of result_code status values, see Automation API Result Codes.

Important:

The result_description field in the response body is subject to change. If your application depends on Control Manager Automation API responses, use the result_code value instead of the result_description provided in the response body.

The following table outlines the possible responses:

Response Status

HTTP Status Code

Response Body

Successful

200

{
 "result_code":(an integer indicating
      the result of this API call),
 "result_description":"(a string 
      describing the result code)",
 "result_content":"(if provided, a 
      JSON object representing the 
      return value of the API)"
}
Note:

For a complete list of result_code status values, see Automation API Result Codes.

Unsuccessful due to invalid parameters

400

{
 "result_code":(an integer indicating
      the result of this API call),
 "result_description":"(a string 
      describing the result code)",
 "result_content":""
}
Note:

For a complete list of result_code status values, see Automation API Result Codes.

Unsuccessful due to authorization error

401

{
 "result_code":(an integer indicating
      the result of this API call),
 "result_description":"(a string 
      describing the result code)",
 "result_content":""
}
Note:

For a complete list of result_code status values, see Automation API Result Codes.

Unknown error

500

{
 "result_code":(an integer indicating
      the result of this API call),   
 "result_description":"(a string 
      describing the result code)",
 "result_content":""
}
Note:

For a complete list of result_code status values, see Automation API Result Codes.