Errors
HTTP response codes
Solvimon uses conventional HTTP response codes to indicate the success or failure of an API request.
- Codes in the 2xx range indicate success. Generally, you will get either a
201or200, the former for when a resource is created, the latter when fetching information. - Codes in the 4xx range indicate an error that failed given the information provided. Some 4xx errors that could be handled programmatically include an error code briefly explaining the reported error.
- Codes in the 5xx range indicate an error with Solvimon’s servers (these are rare).
📘 Good to know
Our API responses hold a unique request reference in the header field:
X-REQUEST-ID, that holds a value of the following format:reqr_HwDeRw0dFUrJrjCKk31w. It is advised to provide this reference for troubleshooting.
Errors
An error response consists of the following fields:
type: possible values are:API_ERRORandINVALID_REQUEST. The latter will indicate a failure on the request submitted being invalid, the former is where processing failed due to internal issues or other non-recoverable problemscode: programmatic value to indicate what failed, e.g.RESOURCE_NOT_FOUNDorUNABLE_TO_PROCESS_INSTRUCTIONS. Below is a list provided for all the existing codes.field(optional): indicates which field was deemed invalidmessage: a human-readable explanation of the response
An example of such a response would be:
List of error codes
A list of the existing error codes that can be within the field code.