Parameters for Input Data

ValidateAddressGlobal takes a standard address as input. All addresses use this format no matter what country the address is from.

Table 1. ValidateAddressGlobal Input

Parameter

Format

Description

Data.AddressLine1 through Data.AddressLine6

String [79]

These fields contain address line data. AddressLine1 contains the first address line, AddressLine2 contains the second address line, and so forth. Note that the city, state/province, and postal code information should be placed in their respective fields, not address line fields. For example:

AddressLine1: 17413 Blodgett Road
AddressLine2: PO Box 123
City: Mount Vernon
StateProvice: WA
PostalCode: 97273
Country: USA

If the input address is not already parsed into the appropriate address line and City, StateProvice, and PostalCode fields, use the UnformattedLine fields instead of the address line fields.

Data.City

String [79]

City name

Data.StateProvince

String [79]

State or province.

Data.PostalCode

String [79]:

99999 99999-9999 A9A9A9 A9A 9A9 9999 999

The postal code for the address. In the U.S. this is the ZIP CodeĀ®.

Data.Contact

String [79] The name of the addressee. For example, "Mr. Jones".

Data.Country

String [79]

The name of the country. If no value is specified in the or option, you must specify a country.

Data.FirmName

String [79]

The company or firm name.

Data.Street

String [79]

Street

Data.Number

Building [79]

Number

Data.Building

String [79]

Building

Data.SubBuilding

String [79]

SubBuilding

Data.DeliveryService

String [79]

DeliveryService

Data.UnformattedLine1 through Data.UnformattedLine10

String [79]

Use these fields if the input address is completely unparsed and you want ValidateAddressGlobal to attempt to parse the address into the appropriate fields. For example:

UnformattedLine1: 17413 Blodgett Road
UnformattedLine2: PO Box 123
UnformattedLine3: Mount Vernon WA 97273
UnformattedLine4: USA

This address would be parsed into these output fields:

AddressLine1: 17413 Blodgett Road
AddressLine2: PO Box 123
City: Mount Vernon
StateProvice: WA
PostalCode: 97273
Country: USA

Note: If you specify input in the unformatted line fields you must specify the entire address using only unformatted line fields. Do not use other fields such as City or StateProvince in combination with unformatted line fields.