Anything that happens during a run of DOTS Address Validation International that causes it to be unable to finish its normal processing is an error. If an error occurs, something similar to the following will result instead of the normal/typical output:
Example:
| *Error!* <Type>Authorization</Type> <TypeCode>1</TypeCode> <Desc>Your license key does not work on this service.</Desc> <DescCode>8</DescCode> |
There are three error types described below.
Error Types
| Type | TypeCode | Billable | Standard Across All Gen2 Web Services |
|---|---|---|---|
| Authorization | 1 | No | Yes |
| User Input | 2 | No | No |
| Service Objects Fatal | 3 | No | Yes |
Error type 1: Authorization
- Theses are standard to all Generation 2 DOTS Web Services.
| DescCode | Desc |
|---|---|
| 0 | Unknown authorization error. |
| 1 | Please provide a valid license key for this web service. |
| 2 | The daily allowable number of transactions for this license key has been exceeded. |
| 3 | The monthly allowable number of transactions for this license key has been exceeded. |
| 4 | The total allowable number of transactions for this license key has been exceeded. |
| 5 | There are not enough transactions available. Check your daily/monthly transaction limits. |
| 6 | This license key has not yet been activated. |
| 7 | This license key has expired. |
| 8 | Your license key does not work on this service |
| 13 | This country is limited to specific usage. Please contact customer service to have your key enabled. |
| 14 | This output language is limited to specific usage. Please contact customer service to have your key enabled. |
Error type 2: User Input
- User Input errors are caused when a user inputs an invalid value or fails to provide a certain input field altogether. If a developer creates a request and mistypes a parameter name, it will probably cause a User Input Error.
| DescCode | Desc | Additional Details |
|---|---|---|
| 1 | You must input a license key in the LicenseKey field. | |
| 2 | The value of the OutputLanguage field is not supported. | Occurs when an unsupported OutputLanguage value is submitted. |
| 3 | You must input an OutputLanguage. | Occurs when the OutputLanguage field is missing or when the value is empty. |
| 4 | You must input a country name or country code in the Country field. | |
| 5 | The country entered is not supported. | Indicates that the country entered may not necessarily be invalid but that the value is not supported. Either the value is not recognized or it is for a country that the service does not currently support. |
| 6 | The country entered is invalid | |
| 7 | You must input an address. | Occurs when a value is not passed to the Address1-5 fields or when the value(s) does not appear to be an address.Examples: “Attention John Smith” or “On the corner of East and Main” or “9 ^&*$@! Rd” |
| 8 | The length of one or more address fields is too long. | Occurs when the length of one or more of the Address1-5 field values exceeds 250 characters. |
| 9 | The length of the Locality field is too long. | Occurs when the length of the Locality field value exceeds 250 characters. |
| 10 | The length of the AdministrativeArea field is too long. | Occurs when the length of the AdministrativeArea field value exceeds 250 characters. |
| 11 | Locality and AdministrativeArea are required when a PostalCode is not provided. | |
| 12 | The length of the PostalCode field is too long. | Occurs when the length of the PostalCode field value exceeds 50 characters. |
Error type 3: Service Objects Fatal
- The Desc will always be the same and the DescCode has no meaning. This is standard to all Generation 2 DOTS Web Services. This is a rare error that signals either a bug in the DOTS Address Validation International service, or a Network/Connectivity issue.
| DescCode | Desc |
|---|---|
| 1 | Unhandled error. Please contact Service Objects. |