Anything that happens during a run of DOTS NCOA Live that causes it to be unable to finish its normal processing is an error. If an error occurs, something like the following will be the result instead of the normal output:
Error
<Type>Authorization</Type>
<TypeCode>1</TypeCode>
<Desc>Your license key does not work on this service.</Desc>
<DescCode>8</DescCode>
There are four error types described below.
Error Types
| Type | TypeCode | Billable | Standard for all Gen2 Web Services |
|---|---|---|---|
| Authorization | 1 | No | Yes |
| User Input | 2 | No | No |
| Service Objects Fatal | 3 | No | Yes |
| Domain Specific | 4 | Yes | No |
Error type 1: Authorization
- These are standard to all Generation 2 DOTS Web Services.
| DescCode | Description |
|---|---|
| 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. |
Error type 2: User Input
- These errors occur as a result of bad inputs. DOTS NCOA Live requires all three inputs to be present in order for a proper validation to take place.
| DescCode | Description |
|---|---|
| 1 | You must input a license key in the LicenseKey field. |
| 2 | You must input a job number. |
| 3 | You must input an address. |
| 4 | You must input either a Zip code or City, State. |
| 5 | Invalid format for JobId. Must be alphanumeric with no spaces and excluding special characters. |
| 6 | You must input a Name. |
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 NCOA Live service or a Network/Connectivity issue.
| DescCode | Description |
|---|---|
| 1 | Unhandled error. Please contact Service Objects. |
Error type 4: Domain Specific
- Domain specific errors represent the errors specific to the DOTS NCOA Live service.
| DescCode | Description | |
|---|---|---|
| 1 | Job not found for this License Key. | The job does not exist. Please try again with a different job id. * |
| 2 | Job has been closed. | The job can no longer be used. Please try again with a new job id. * |
| 3 | First transaction of a job must contain 100 records or more. | Please try again with at least 100 unique and valid addresses. * |
| 4 | Issue connecting to NCOA engine. | Please try again. If the issue persists then please contact technical support. * |
| 5 | Street not found | Indicates that the street name was not found for the general area (city/state or zip). |
| 6 | Address not found | Indicates that a reliable address candidate was not found. Portions of the address may be incorrect or it may be too ambiguous to return a reliable candidate. |
| 7 | Street number or box number out of range | The address is invalid. The street and area appear to be correct but the number is wrong. |
| 8 | Multiple addresses match. | Indicates that multiple candidates were found that are equally likely given the input. |
| 9 | Insufficient address data | Indicates that a reliable address candidate was not found. Portions of the address may be missing or incorrect. |
| 10 | DPV Lockout. Contact Service Objects immediately. | Returned for a specific type of address case known as a false positive. |
| 11 | Request cannot contain more than 500 addresses. | Please try again with no more than 500 addresses in a single request. * |
| 12 | License Key is not linked to a valid PAF Id. | Please contact Service Objects and complete a USPS NCOA Processing Acknowledgement Form (PAF) to register your license key with the service. * |
| 13 | Performing weekly NCOA data update. Please try again in a few minutes with a new Job Id. | USPS releases new NCOALink data every week and requires that we use the newest data, so we must close all jobs using the older dataset. * |
| 14 | Expired PAF agreement. Please contact Service Objects. | Your USPS NCOA Processing Acknowledgement Form (PAF) has expired. Please contact Service Objects to renew and continue using the service. * |
| 15 | Unable to create new NCOA Job. Please try again. If the problem persists then please contact Service Objects. | There was a problem creating the new job. Please contact Service Objects and notify technical support of the error. * |
| 16 | A report cannot be returned because the job is still closing. Please try again at a later time. If the issue persists then please contact Service Objects. | NCOA Jobs must be closed internally before a report can be generated and jobs take several seconds to close, sometimes more than 10 seconds. If the error persists after waiting for more than a minute then please contact Service Objects. * |
| 17 | There was a problem creating the report. Please contact Service Objects. | Summary reports must be generated before the end of the week that they were created in. * |