Anything that happens during a run of DOTS Address Geocode International (AGI) 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>Please provide a valid license key for this web 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 | You must input a place or address to search for. | |
| 4 | Please input a valid Search Type. | |
| 5 | SingleLine input detected. Use of the parsed address input parameters, Address1-5, Locality, AdministrativeArea and PostalCode are not allowed when SingleLine is provided. | The service does not allow you to mix a single line address input with parsed address inputs. You must choose either a single line address input or a parsed address input. Not both. |
| 8 | The length of one or more Address field input values is too long. | Inputs Address1-5 are not to exceed 300 characters in length each. |
| 9 | The length of the Locality field input value is too long. | The Locality input is not to exceed 300 characters in length. |
| 10 | The length of the AdministrativeArea field input value is too long. | The AdministrativeArea input is not to exceed 300 characters in length. |
| 11 | The length of the PostalCode field input value is too long. | The PostalCode input is not to exceed 50 characters in length. |
| 12 | The length of the Country field input value is too long. | The Country input is not to exceed 300 characters in length. |
| 13 | You must input a country. |
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. |