Special Conditions and Error Handling
If there are validation problems with the input parameters the response will have an appropriate HTTP status code (e.g., 400) and details of the problem will be provided in the result format requested (JSON or XML).
Error Responses
XML
| No Format |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<response>
<header>
<locale country="US" language="en"/>
<timestamp>
2009-07-01T10:45:34.758-04:00
</timestamp>
<criteria>
<command>
<fmt>
xml
</fmt>
<include-provisional>
true
</include-provisional>
<r>
L99381
</r>
<back>
320
</back>
<max-results>
500
</max-results>
<detail>
simple
</detail>
</command>
</criteria>
<errors>
<error>
<error-msg>
The maximum number of days back is 30
</error-msg>
<error-code>
error.data.too_many_back
</error-code>
</error>
</errors>
</header>
<result/>
</response>
|
JSON
The response will include a simple array containing details of the problems encountered:
| No Format |
|---|
[{
"errorMsg": "The maximum number of days back is 30",
"errorCode": "error.data.too_many_back"
}]
|
Current List of Error Messages
This list may change or be added to at any time. Items in brackets will be specified at the time the message is received.
...