Canadian Address Options - Spectrum_OnDemand - addressing - web_services - 23.1

Spectrum Web Services Guide

Product type
Software
Portfolio
Integrate
Product family
Spectrum
Product
Spectrum > Web Services
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Web Services Guide
First publish date
2007
Last updated
2024-10-17
Published on
2024-10-17T00:33:46.811413

Option Name

optionName

Parameter

Description

Enable Canadian address processing

PerformCanadianProcessing

Option.PerformCanadianProcessing

Specifies whether to process Canadian addresses. If you enable Canadian address processing Validate MailingAddressUSCAN will attempt to validate Canadian addresses. If you disable Canadian address processing, Canadian addresses will fail, meaning they is returned with an "F" in the Status output field. The output field Status.Code will say "DisabledCoder." If you are not licensed for Canadian address processing you must disable Canadian address processing in order for your jobs to complete successfully, regardless of whether or not they contain Canadian addresses.

Note: You must have a valid license for Canadian address processing to successfully process Canadian addresses. If you enable Canadian address processing but are not licensed for this feature, or your license has expired, your entire job will fail you will receive an error.
N
No, do not process Canadian addresses.
Y
Yes, process Canadian addresses (default).

Database

Database.Canada

Option.Database.Canada

Specifies which database you want to use for validating Canadian addresses. To specify a database for Canadian address validation, select a database in the Database drop-down list. Only databases that have been defined in the CAN Database Resources panel in the Management Console are available.

Determine language using

CanFrenchFormat

Option.CanFrenchFormat

Specifies how to determine the language (English or French) to use to format the address and directional. The following example shows an address formatted in English and French:

English: 123 Main St W
French: 123 Rue Main O

The parameter controls the formatting of the address. It also affects the spelling of the directional but not spelling of the suffix.

Street suffix
C
Use the street suffix returned by the matching process to determine the language. The street suffix returned by the matching process, which is used internally by Validate MailingAddressUSCAN during processing, may be different from that in the input address. Ambiguous records are formatted like the input. Default. All addresses in Quebec are formatted using French.
CPC database
S
Use the Canadian database to determine the language. The Canadian database contains data from the Canada Post Corporation (CPC). All addresses in Quebec are formatted using French.
CanLanguage Input field
D
Use the CanLanguage input field to format the output address like the input whenever possible to preserve the original format (default).
Formatted in French order
T
Use the Formatted in French order field to determine the language. If there is a non-blank value in this field the address are formatted using French.

Default English apt label

CanEnglishApartmentLabel

Option.CanEnglishApartmentLabel

For English addresses, specifies the default apartment label to use in the output if there is no apartment label in the input address. This setting is ignored if you specify CanStandardAddressFormat=F. This setting is ignored if you specify Option.CanStandardAddressFormat=F. This setting is ignored if you select Number in front in the Secondary address format field.

Apt
Use Apt as the label. Default.
Apartment
Use Apartment as the label.
Suite
Use Suite as the label.
Unit
Use Unit as the label.

Default French apt label

CanFrenchApartmentLabel

Option.CanFrenchApartmentLabel

For French addresses, specifies the default apartment label to use in the output if there is no apartment label in the input address. This setting is ignored if you specify CanStandardAddressFormat=F. This setting is ignored if you specify Option.CanStandardAddressFormat=F. This setting is ignored if you select Number in front in the Secondary address format field.

App
Use App as the label. Default.
Appartement
Use Appartement as the label.
Bureau
Use Bureau as the label.
Suite
Use Suite as the label.
Unite
Use Unite as the label.

Force Correction for LVR/Single-Single CPC data record

ForceCorrectionLVR

Option.ForceCorrectionLVR

Changes the civic and/or suite information to match the Large Volume Receiver (LVR) or single-single record (used when there is only one record for that postal code/street name/street type).

N
Do not change the civic and/or suite information to match the LVR or single-single record. The LVR record will be marked as a valid but non-correctable record (VN). The single-single record will be corrected, if possible, or processed as a non-correctable record..
Y
Change the civic and/or suite information to match the LVR or single-single record.
Note: If you check this box, the Statement of Address Accuracy will not be printed because this is not a SERP-recognized setting.

Prefer house number on postal code conflict

CanPreferHouseNum

Option.CanPreferHouseNum

In cases where the house number and postal code are both valid but in conflict, you can force the postal code to be corrected based on the house number by specifying CanPreferHouseNum=Y. In cases where the house number and postal code are both valid but in conflict, you can force the postal code to be corrected based on the house number by specifying Option.CanPreferHouseNum=Y. In cases where the house number and postal code are both valid but in conflict, you can force the postal code to be corrected based on the house number by selecting Prefer house number on postal code conflict. If you do not select this option the house number is changed to match the postal code.

N
Change the house number to match the postal code. Default.
Y
Change the postal code to match the house number.

Return city alias

CanOutputCityAlias

Option.CanOutputCityAlias

Specifies whether or not to return the city alias when the alias is in the input address. This option is disabled when you specify CanOutputCityFormat=D. This option is disabled when you specify Option.CanOutputCityFormat=D. This option is disabled when you select Use default option in the City format field.

Y
Output the city alias when the city alias is in the input. Default.
N
Never output the city alias even if it is in the input.

Abbreviate non-civic keywords

CanNonCivicFormat

Option.CanNonCivicFormat

Specifies whether or not non-civic keywords are abbreviated in the output. For example, Post Office Box vs. PO Box.

A
Abbreviate non-civic keywords. Default.
F
Do not abbreviate non-civic keywords. The full keyword is used.

Enable SERP settings

EnableSERP

Option.EnableSERP

Specifies whether or not to use SERP options.

Y
Enable SERP options.
N
Do not enable SERP options. Default.

Secondary address format

CanStandardAddressFormat

Option.CanStandardAddressFormat

Specifies where to place secondary address information in the output address. Secondary address information refers to apartment numbers, suite numbers, and similar designators.

Use default option
D
Place apartment information in the location specified in theSecondary address format field in the Default Options tab StandardAddressFormat option Default.
End of address line
B
Place apartment information at the at the end (back) of the AddressLine1 field.
I
Place apartment information in the same location as the input address.
Front, number only
F
Place the apartment number only (no label) at the beginning of the AddressLine1 field. For example, 400-123 Rue Main
Front, number and label
E
Place the apartment number and label at the beginning of the AddressLine1 field. For example, Apt 400 123 Rue Main
Separate address line
S
Place apartment information on a separate line.
Same as input
S
Place apartment information in the same location as the input address.

City format

CanOutputCityFormat

Option.CanOutputCityFormat

Specifies whether to use the long, medium, or short version of the city if the city has a long name. For example,

Long: BUFFALO HEAD PRAIRIE
Medium: BUFFALO-HEAD-PR
Short: BUFFALO-HD-PR

Use default option
D
Use the default option specified by the OutputShortCityName option. Default. If you specify OutputShortCityName=V, the city is formatted as if you select LLong for this option (see below) andY for CanOutputCityAlias.
Use the default option specified by the Option.OutputShortCityName parameter. Default. If you specify Option.OutputShortCityName=V, the city is formatted as if you select LLong for this option (see below) andY for CanOutputCityAlias.
Use the default option specified on the Default Options tab, City format field. Default. If you select Non-mailing (vanity) in the City format field, the city is formatted as if you select LLong for this option (see below) and check the Return city alias box.
Short
S
Output short city name.
Long
L
Output the long city name.
Medium
M
Output the medium city name.
Same as input
I
Use the same city format as used in the input address. Output is L, M, or S.

Place rural route into in

CanRuralRouteFormat

Option.CanRuralRouteFormat

Specifies where to place rural route delivery information. An example of an address with rural route delivery information is:

36 GRANT RD RR 3
ANTIGONISH NS

In this address, "RR 3" is the rural route delivery information.

AddressLine1
A
Place rural route delivery information on the same line as the address, after the address information. Default. For example,

36 GRANT RD RR 3

AddressLine2
S
Place rural route delivery information on a separate address line. For example,

36 GRANT RD
RR 3

Place delivery office info in

CanDeliveryOfficeFormat

Option.CanDeliveryOfficeFormat

Specifies where to place station information. An example of an address with station information is:

PO BOX 8625 STN A
ST. JOHN'S NL

Same as input
I
Place station information in the same location as it is in the input address. Default.
AddressLine1
A
Place station information on the same line as the address, after the address information. For example,

PO BOX 8625 STN A

AddressLine2
S
Place station information on a separate address line. For example,

PO BOX 8625
STN A

Dual address logic

CanDualAddressLogic

Option.CanDualAddressLogic

Specifies whether Validate MailingAddressUSCAN should return a street match or a PO Box/non-civic match when the address contains both civic and non-civic information. One of the following:

Use default option
D
Use DualAddressLogic Global Option. Default.
PO Box Match
P
Match to PO Box or other non-street data.
Street Match
S
Match to street.

For example, given the following input address:

AddressLine1: 36 GRANT RD
AddressLine2: RR 4
City: ANTIGONISH
StateProvince: NS

Validate MailingAddressUSCAN would return one of the following:

  • If CanDualAddressLogic is set to S, Validate MailingAddressUSCAN returns the following: If Option.CanDualAddressLogic is set to S, Validate MailingAddressUSCAN returns the following: If Dual address logic is set to Street Match, Validate Address returns the following:

    AddressLine1: 36 GRANT RD
    AddressLine2: RR 3
    City: ANTIGONISH
    StateProvince: NS
    PostalCode: B2G 2L1

  • If CanDualAddressLogic is set to P, Validate MailingAddressUSCAN returns the following: If Option.CanDualAddressLogic is set to P, Validate MailingAddressUSCAN returns the following: If Dual address logic is set to PO Box Match, Validate Address returns the following:

    AddressLine1: RR 4
    City: ANTIGONISH
    StateProvince: NS
    PostalCode: B2G 2L2

The address data that is not used to standardize the address is returned in the AdditionalInputData field. For more information, see Output Data Options.

Switch default valid postal code confidence

canSwitchManagedPostalCodeConfidence

Option.canSwitchManagedPostalCodeConfidence

The valid values for this parameter are Y and N. The default value is N.

Send the value Y to lower the output Confidence score of the record. This is useful for the non-correctable (VN) records. You can identify such records by the DefaultValidPostalCode value. The value is Y for VN type of records and blank for others.