API Errors

SOTI Connect uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error resulting from the information provided, and codes in the 5xx range may indicate an error with SOTI Connect that you cannot resolve by changing the request.

For troubleshooting purposes, the conditions under which SOTI Connect will return an HTTP error code are as follows:

HTTP Error Code Description
HTTP 400

An HTTP 400 error code indicates contract validation errors. The data provided in the request is not compliant with the expected input of the method. Normally, this is an integration error and can only be resolved programmatically on the client side. Check to ensure the parameters, values, and syntax conform to the expected model.

In addition to the HTTP 400 response, the body will contain a single error object that reports all the violations in the following format:
  • ErrorCode (mandatory): Set to 0.
  • ErrorMessage (mandatory): The error message.
  • Data[] (optional): Additional parameters are needed to troubleshoot the problem.
  • HelpLink (optional): A link to troubleshooting steps.
HTTP 401 or HTTP 403

An HTTP 401 or HTTP 403 error code indicates security errors. These errors are generated when the login fails, is required, or if the user is not authorized to perform the action requested.

In addition to the HTTP 401 or HTTP 403 response, the body will contain a single error object to report an error message:

ErrorMessage (mandatory): The error message.
Note: The error message may be intentionally vague for security purposes. For more information, consult the environment’s management service log.
HTTP 422

An HTTP 422 error code indicates business logic errors, where the request is correct but cannot be completed because it violates a logical condition. For example, the error can occur when deleting an object with dependencies that prevent it from being deleted.

In addition to the HTTP 422 response, the body contains a single error object in the following format:
  • ErrorCode (mandatory): The error code specific to the problem encountered.
  • ErrorMessage (mandatory): The error message.
  • Data[] (optional): Additional parameters are needed to troubleshoot the problem.
  • HelpLink (optional): A link to troubleshooting steps.
HTTP 500

An HTTP 500 error code indicates errors when the SOTI Connect server cannot process a request.

In addition to the HTTP 500 response, the body contains a single error object to report an error message:
  • ErrorMessage (mandatory): Set to Internal Server Error.
For more information, consult the environment’s management service log. Report these errors by contacting the SOTI Support team, and include environmental details, the raw HTTP request, and management service logs.