The following table lists the options that control the type of information returned by ValidateAddress. Some of these options can be overridden for Canadian addresses. For more information, see Canadian Address Options.
Parameter |
Description |
---|---|
Option.OutputRecordType |
Type of output record. For more than one, provide a list.
|
Option.OutputFieldLevelReturnCodes |
Specifies whether to include field-level result indicators. Field-level result indicators describe how each address element was handled. 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 Field-Level Result Indicators.
|
Option.OutputFormattedOnFail |
Specifies whether to return a formatted address when an address cannot be validated. The address is formatted using the preferred address format for the address's country. If this option is not selected, the output address fields are blank when the address cannot be validated. Note: This option applies only to U.S. and Canadian addresses.
Formatted data will not be returned for any other
address.
Formatted addresses are returned using the format specified by the OutputRecordType option. Note that if you specify OutputRecordType=E, the parsed address elements will contain the parsed, validated address for addresses that could be validated. If the address could not be validated the parsed address elements will contain the input address in parsed form. If you always want the output to contain the input address in parsed form, regardless of whether or not ValidateAddress could validate the address, specify OutputRecordType=I. Formatted addresses are returned using the format specified by the Option.OutputRecordType option. Note that if you specify Option.OutputRecordType=E, the parsed address elements will contain the parsed, validated address for addresses that could be validated. If the address could not be validated the parsed address elements will contain the input address in parsed form. If you always want the output to contain the input address in parsed form, regardless of whether or not ValidateAddress could validate the address, specify Option.OutputRecordType=I. Formatted addresses are returned using the format specified by the Include a standard address, Include address line elements, and Include postal information check boxes. Note that if you select Include address line elements, the parsed address elements will contain the parsed, validated address for addresses that could be validated. If the address could not be validated the parsed address elements will contain the input address in parsed form. If you always want the output to contain the input address in parsed form, regardless of whether or not ValidateAddress could validate the address, select Include standardized input address elements. If you specify Y, you must specify "A" and/or "E" for OutputRecordType. If you specify Y, you must specify "A" and/or "E" for Option.OutputRecordType. If you check this option, you must select Include a standard address and/or Include address line elements. |
Option.OutputStreetNameAlias |
For U.S. addresses only, specifies how to handle street name aliases used in the input. A street alias is an alternate name for a street and applies only to a specific range of addresses on the street. If you enable this option, street name aliases used in the input will appear in the output. If you do not enable this option, street name aliases in the input will be converted to the base street name in the output, with the following exceptions:
This is one of three options that control how ValidateAddress handles street name aliases. The other two are Option.OutputPreferredAlias and Option.OutputAbbreviatedAlias. Note: If Option.OutputAbbreviatedAlias is enabled,
the abbreviated alias will always appear in the output even if
you have Option.OutputStreetNameAlias
disabled.
|
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 ValidateAddress 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.OutputCountryFormat 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 ValidateAddress 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.OutputAMAS |
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 ValidateAddress 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.OutputCountryFormat 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 ValidateAddress 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.
|