This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
api:v2.0:errors [2015/01/16 12:43] dan created |
api:v2.0:errors [2017/07/24 14:15] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== API Errors ====== | ====== API Errors ====== | ||
| + | |||
| + | 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 ==== | ||
| + | |||
| + | <code> | ||
| + | HTTP/1.1 403 Forbidden | ||
| + | Cache-Control: private | ||
| + | Content-Type: application/json; charset=utf-8 | ||
| + | Date: Sat, 1 Jan 2000 00:00:00 GMT | ||
| + | Content-Length: 79 | ||
| + | |||
| + | { | ||
| + | "Code":1, | ||
| + | "Message":"API Key not valid" | ||
| + | } | ||
| + | </code> | ||
| + | |||
| + | ===== Error List ===== | ||
| + | |||
| |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.| | ||
| + | |3|Account not found|403|The API Key appears valid but the Sentori Account doesn't appear to exist.| | ||
| |100|Email Address not valid|400|The Email Address in the request isn't a valid email address.| | |100|Email Address not valid|400|The Email Address in the request isn't a valid email address.| | ||
| |101|Contact not found|404|The Contact specified in the request couldn't be found in the Sentori Account| | |101|Contact not found|404|The Contact specified in the request couldn't be found in the Sentori Account| | ||
| |102|Email Address already in use|400|The Email Address in the request is already in use by another Contact.| | |102|Email Address already in use|400|The Email Address in the request is already in use by another Contact.| | ||
| |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.| | ||
| - | |200|Mailing List not found|404|The Mailing List specified in the request couldn't be found in the Sentori Account| | + | |104|Email Addresses not valid|400|The Email Address in the request URI and body must match.| |
| - | |4031|Forbidden|403|The specified API doesn't have access to any Sentori Accounts.| | + | |200|Mailing List not found|404|The Mailing List specified in the request couldn't be found in the Sentori Account.| |
| - | |4032|Could not locate Account|403|The API Key appears valid but the Sentori Account doesn't appear to exist.| | + | |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| | ||