Errors
From Videntity Documentaion Wiki
API errors can be returned for a host of reasons. Not including required post parameters is one of the most common. All errors are returned in formatted XML.
Error XML format
All error codes are returned inside this XML schema:
<?xml version="1.0" encoding="utf-8"?>
<response api_method="METHOD_NAME">
<status>ERROR</status>
<api_tx_number>API_TRANSACTION_NUMBER</api_tx_number>
<error_number>ERROR_NUMBER</error_number>
<error_name>ERROR_NAME</error_name>
<error_detail>ERROR_DETAIL</error_detail>
<timestamp>TIMESTAMP</timestamp>
</response>
An actual xml error would look something like this:
<?xml version="1.0" encoding="utf-8"?>
<response api_method="/user/login">
<status>ERROR</status>
<api_tx_number>12</api_tx_number>
<error_number>1</error_number>
<error_name>AUTHENTICATION_ERROR</error_name>
<error_detail>username, password or account_number is incorrect</error_detail>
<timestamp>2008-09-30 15:56:42</timestamp>
</response>
URL Errors
Each URL's XML formatted error responses can be found under our API Methods section or listed in the table below.
| ERROR NUMBER | ERROR NAME | ERROR DETAILS | ERROR EXPLANATION |
|---|---|---|---|
| 1 | AUTHENTICATION_ERROR | username, password or account_number is incorrect | This error message indicates that your username, password, or account number is incorrect. For security reasons we don't tell you which one, so check all three if you get this error. |
| 2 | SESSION_DOES_NOT_EXIST | Your session does not exist | This error message indicates that your session hasn't been created or has expired. If you receive this error message please call the API login URL to generate a new session. |
| 3 | SESSION_EXPIRED | Your session has expired | This error message indicates that your session hasn't been created or has expired. If you receive this error message please call the API login URL to generate a new session. |
| 4 | MISSING_MANDATORY_FIELD | Mandatory field <FOO_BAR> is missing | Every method has a set number of required fields that must be included in a method call. If the required method arguments are missing this error is returned. |
| 5 | VALUES_OUT_OF_RANGE | Field <FOO_BAR> must be between value <X> and <Y> | The value supplied for the <FOO_BAR> field is out of its acceptable range. Please check your <FOO_BAR> field and set the value between <X> and <Y>. |
| 6 | SYNTAX_ERROR | Field <FOO_BAR> must be in the format <X, Y, Z> | The <FOO_BAR> value supplied is not in the expected format. Please make sure your <FOO_BAR> field format is in the <X,Y,Z> format. |
| 7 | ENUMERATION_ERROR | Field <FOO_BAR> must be one of the following values: <W, X, Y, Z> | The value supplied in the field <FOO_BAR> is not in the enumerated list. Please make sure your <FOO_BAR> field is one of the following values: <W, X, Y, Z>. |
| 8 | INVALID_EMAIL_FORMAT | Value <FOO_BAR> is not a valid email address. | This error indicates that the email address supplied is not formatted correctly. |
| 9 | INVALID_TELEPHONE_FORMAT | Value <FOO_BAR> is not a valid phone number format: XXX-XXX-XXXX | The telephone number supplied is not formatted correctly. All phone numbers should be in the XXX-XXX-XXXX format (i.e. 304-291-2480). |
| 10 | ENTITY_NOT_SUPPLIED_FOR_AGENT | The entity was not supplied with the agent. | All users created as an AGENT user type (user_type) require an agent entity (agent_entity). |
| 11 | SERVER_ERROR | The server could not process your request. | The server could not process your request. Please Try again. |
| 12 | TIME_OUT | The transaction has timed out.. | The transaction has timed out and is giving up. Please Try again. |
| 13 | DUPLICATE_DATA | Duplicate date could not be entered into the database. | You have tried to enter duplicate data into the database. |
| 14 | ACCOUNT_DOES_NOT_EXIST | The account you entered does not exist. | The account number you entered does not exist in the database. |
