This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
api:v2.0:errors [2015/01/16 14:21] dan |
api:v2.0:errors [2017/07/24 14:15] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== API Errors ====== | ====== API Errors ====== | ||
| - | All Sentori API errors result in a 4xx HTTP status code, in the body of the response will be a JSON object containing the Sentori API Code to identify the error and a human readable message. | + | Any request made to the Sentori API that cannot be completed successfully will result in a 4xx HTTP status code. The response body will contain a JSON object giving more details about the specific error; a unique error code and a human readable message. |
| ==== Example ==== | ==== Example ==== | ||
| Line 22: | Line 22: | ||
| |API Code|API Message|HTTP Status|Description| | |API Code|API Message|HTTP Status|Description| | ||
| + | |-1|Bad request|400|The API request is malformed.| | ||
| |1|API Key not valid|403|The specified API doesn't have access to any Sentori Accounts.| | |1|API Key not valid|403|The specified API doesn't have access to any Sentori Accounts.| | ||
| |2|Failed to set account|403|The API Key appears valid but the Sentori Account cannot be accessed.| | |2|Failed to set account|403|The API Key appears valid but the Sentori Account cannot be accessed.| | ||
| Line 30: | Line 31: | ||
| |103|Contact Fields not valid|400|The Contact Fields (or there values) in the request are not valid for this Sentori Account.| | |103|Contact Fields not valid|400|The Contact Fields (or there values) in the request are not valid for this Sentori Account.| | ||
| |104|Email Addresses not valid|400|The Email Address in the request URI and body must match.| | |104|Email Addresses not valid|400|The Email Address in the request URI and body must match.| | ||
| - | |200|Mailing List not found|404|The Mailing List specified in the request couldn't be found in the Sentori Account| | + | |200|Mailing List not found|404|The Mailing List specified in the request couldn't be found in the Sentori Account.| |
| + | |300|Document not found|404|The Document could not be found.| | ||
| + | |301|Document is not of expected type|400|The Document is not of the expected type. e.g. was expecting an Email but Document is an SMS| | ||