API Function Reference

The Pro Primary API functions are split in to the following groups.

General Functions

Common Search Functions

Result Functions

Layout Functions

Dataset Functions

System Functions

USA-Specific Delivery Point Validation (DPV) Functions

The Pro API includes various functions that are specific to the DPV system. You only need to integrate these function if you do not intend to use the DPV Unlock Utility supplied with Pro API.

 

General Error Scenarios (All Functions)

Bad Parameter

One of the API parameters has been passed an invalid value. Use the LogErrors configuration setting to determine where the problem lies

Bad Handle

The parameter viHandle has been passed an invalid handle. This should only be passed values returned from QA_Open that have not since been closed.

Server Error

An error has occurred on the server. This may be due to the server running out of resource, or to connection issues. This error may be returned in a non client-server integration if the 'server' side of the application runs out of resource, such as memory.

Licensing Error

The active dataset you are attempting to use may not be licensed properly and will return an error. Check that the data is correctly installed and licensed, and use the LogErrors configuration setting to determine where the problem lies.