Error Codes and Responses - v1.3



OK Response

When the API returns an OK, meaning successfully processed, the JSON format is returned as the following:
 {"status":0, "message":"Success"}

Error Response

When the API returns error messages, it does so in JSON format. For example, an error might look like this:
 {"status":110, "message":"Unexpected number of parameters"}

Statuses

In addition to descriptive error text, error messages contain machine-parseable codes/statuses. While the text for an error message may change, the codes/statuses will stay the same. The following table describes the codes which may appear when working with the API grouped by the corresponding HTTP code returned:

status

message

description

 

 

HTTP 200 OK









0

Success



 

 

600

No result available for this request

This error is returned with HTTP code 200 when the request doesn't specify what is being searched.

 

 

HTTP 400 Bad request









100

Malformed parameters



 

 

101

Bad response format requested



 

 

110

Unexpected number of parameters



 

 

111

Wrong parameters for this request



 

 

112

Missing parameters



 

 

113

Orientation parameter missing



 

 

114

Bad request body format



 

 

400

Bad request format



 

 

HTTP 401 Unauthorized









102

Unauthorized to request inactive content



 

 

701

Login Failed



 

 

706

User not found



 

 

HTTP 403 Forbidden









403

Unauthorized



 

 

HTTP 404 Not Found









404

Information not found



 

 

600

No result available for this request

This error is returned with HTTP code 404 when the request specifies what is being searched.

 

 

HTTP 500 Internal Server Error









500

Internal Server Error

Something is broken. Could be a database connection error or an uncontrolled error by the service.

 

 



Need help? Create a support ticket | support@vexcelgroup.com