Welcome‎ > ‎Version 3‎ > ‎Reference Info‎ > ‎

Base Response

Every call to the v3 api will return four base response fields in addition to any other information specific to the call.

Fields:
Field Data Type Nulls Description
errors
list

A list of errors (see below) that occurred during validation or execution.
lastPublished
datetime

The time the results for this api call were last generated.
success
bool

Whether or not the api call was successful.  True if no errors or exceptions occurred.
version
string

The version of the api.  "3" for all v3 api calls.
 
Error Object:
Field Data Type Nulls Description
key
string

The field that this error message applies to.  Empty string for non-specific errors.
code
string

A unique code string for the error message.  The code follows the format {RequestObject}_{Field}_{Reason}
defaultMessage
string

The error message.


Sample JSON Response:
"errors": [
    {
        "code": "FORGOTPASSWORDREQUEST_EMAIL_EMAIL",
        "defaultMessage": "Email must be a valid email.",
        "key": "Email"
    }
],
"lastPublished": "/Date(1323711110422)/",
"success": false,
"version": "3"


Sample XML Response:
<errors>
    <error>
        <code>FORGOTPASSWORDREQUEST_EMAIL_EMAIL</code>
        <defaultMessage>Email must be a valid email.</defaultMessage>
        <key>Email</key>
    </error>
</errors>
<lastPublished>2011-12-12T17:33:11.8126297Z</lastPublished>
<success>false</success>
<version>3</version>
Comments