The following table lists the options that control the type of information returned by ValidateAddressInternational.
Parameter |
Description |
---|---|
Option.OutputCountryFormat |
Specifies the format to use for the country name returned in the Country output field. For example, if you select English, the country name "Deutschland" would be returned as "Germany".
|
Option.OutputScript |
Specifies the alphabet or script in which the output should be returned. This option is bi-directional and generally takes place from Native to Latin and Latin to Native.
Note: The default is InputScript.
|
Option.OutputCasing |
Specifies the casing of the output data. The possible values are:
Note: The default is M (Mixed).
|
Option.OutputAddressBlocks |
Specifies whether to return a formatted version of the address as it would be printed on a physical mailpiece. Each line of the address is returned in a separate address block field. There can be up to nine address block output fields: AddressBlock1 through AddressBlock9. For example, this input address:
AddressLine1: 4200 Parliament Place Results in this address block output:
AddressBlock1: 4200 PARLIAMENT PL STE 600 ValidateAddressInternational formats the address into address blocks using postal authority standards. The country name is returned using the Universal Postal Union country name. Note that the option Option.CountryFormat does not affect the country name in the address block, it only affects the name returned in the Country output field. For addresses outside the U.S. and Canada, if ValidateAddressInternational is unable to validate the address, no address blocks are returned. For addresses in the U.S. and Canada, address blocks are returned even if validation fails.
|
Option.MaximumResults |
A number between 1 and 10 that indicates the maximum number of addresses to return. The default is 1.
Note: The difference between Keepmultimatch=N
and KeepMultimatch=Y/MaximumResults=1 is that a multiple
match will return a failure if KeepMultimatch=N, whereas a
multiple match will return one record if KeepMultimatch=Y
and MaximumResults=1.
|
Option.OutputRecordType |
Type of output record. For more than one option, provide a list such as "AE" or "AEP". The default value for this option is "A", which returns the corrected/validated address. If you want to return individual address elements (House Number, Street Name, and more) as well, set this option to "AE". The supported output types are:
|
Option.OutputFieldLevelReturnCodes |
Specifies whether to include field-level result indicators. Field-level result indicators describe how the service handled each address element. Field-level result indicators are returned in the qualifier "Result". For example, the field-level result indicator for HouseNumber is contained in HouseNumber.Result. For a complete listing of result indicator output fields, see Record-Level Result Indicators.
|
Option.KeepMultimatch |
Indicates whether to return multiple address for those input addresses that have more than one possible match.
For more information, see Returning Multiple Matches. |
Option.InternationalCityStreetSearching |
No longer used. Retained for backwards compatibility purposes. |