Developer Guide

4.0
- 6.5.0
- 6.4.0
- 6.2.0
- 6.1.0
- 6.0.0
- 3.0
- 2.0

Back Next

GlobalPreferredDescriptor

You can configure the

GlobalPreferredDescriptor

attribute to specify the output format for street, building, and sub-building element descriptors in several countries.

The

GlobalPreferredDescriptor

attribute applies to element descriptors in Australia, Canada, Ireland, United States, and New Zealand addresses. The attribute also applies to the

Strasse

element descriptor in Austria, Germany, and Switzerland addresses.

You can set the

GlobalPreferredDescriptor

attribute in batch, interactive, certified, and fast completion modes. Certified mode requires the default setting for the attribute.

Specify one of the following values for the

GlobalPreferredDescriptor

attribute:

DATABASE: Returns the element descriptor available in the reference address database. This is the default value. If there is no matching entry in the database, Address Verification copies the input to the output.
LONG: Returns the expanded form of the element descriptor.; For example, Address Verification returns STREET for the input element ST.
SHORT: Returns the abbreviated form of the element descriptor.; For example, Address Verification returns AVE for the input element AVENUE.
PRESERVE_INPUT: Copies the element descriptor in the input to the output. If the input element descriptor is not an official name, Address Verification returns the corresponding value from the database in the output. For example, when you validate an Australia address that contains BD for boulevard, Address Verification corrects the descriptor to BVD. BVD is the standard short form for boulevard in Australia.

The following SOAP request includes a

GlobalPreferredDescriptor

of PRESERVE_INPUT:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://validator5.AddressDoctor.com/Webservice5/v4">
	<soapenv:Header/>
	<soapenv:Body>
		<Process xmlns="http://validator5.AddressDoctor.com/Webservice5/v4">
			<login>*******</login>
			<password>********</password>
			<parameters>
				<ProcessMode>INTERACTIVE</ProcessMode>
				<ValidationParameters>
					<GlobalPreferredDescriptor>PRESERVE_INPUT
     </GlobalPreferredDescriptor>
				</ValidationParameters>
			</parameters>
			<addresses>
				<Address>
					<FormattedAddress>
						<string>OCEAN BD 2</string>
						<string>SEACLIFF PARK 5049</string>
						<string>SOUTH AUSTRALIA</string>
						<string>AUS</string>
					</FormattedAddress>
				</Address>
			</addresses>
		</Process>
	</soapenv:Body>
</soapenv:Envelope>

In the following response, Address Verification replaces BD with BVD, which is the standard short form for boulevard in Australia addresses:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ProcessResponse xmlns="http://validator5.AddressDoctor.com/Webservice5/v4">
         <ProcessResult>
            <StatusCode>100</StatusCode>
            <StatusMessage>OK</StatusMessage>
            <Results>
               <Result>
                  <ProcessStatus>C4</ProcessStatus>
                  <CountryISO3>AUS</CountryISO3>
                  <ResultDataSet>
                     <ResultData>
                        <ResultNumber>1</ResultNumber>
                        <MailabilityScore>4</MailabilityScore>
                        <ResultPercentage>97.76</ResultPercentage>
                        <ElementInputStatus>60605040600000000060</ElementInputStatus>
                        <ElementResultStatus>F0F0E070F000000000E0</ElementResultStatus>
                        <ElementRelevance>10101010100000000010</ElementRelevance>
                        <ExtElementStatus>00000000000000000000</ExtElementStatus>
                        <AddressResolutionCode>00000000000000000000
                        </AddressResolutionCode>
                        <AddressType>S</AddressType>
                        <LanguageISO3>ENG</LanguageISO3>
                        <Address>
                           <Street>
                              <string>OCEAN BVD</string>
                           </Street>
                           <HouseNumber>
                              <string>2</string>
                           </HouseNumber>
                           <Locality>
                              <string>SEACLIFF PARK</string>
                           </Locality>
                           <PostalCode>
                              <string>5049</string>
                           </PostalCode>
                           <Province>
                              <string>SA</string>
                           </Province>
                           <Country>
                              <string>AUSTRALIA</string>
                           </Country>
                           <DeliveryAddressLines>
                              <string>2 OCEAN BVD</string>
                           </DeliveryAddressLines>
                           <CountrySpecificLocalityLine>
                              <string>SEACLIFF PARK  SA  5049</string>
                           </CountrySpecificLocalityLine>
                           <FormattedAddress>
                              <string>2 OCEAN BVD</string>
                              <string>SEACLIFF PARK  SA  5049</string>
                              <string>AUSTRALIA</string>
                           </FormattedAddress>
                           <AddressComplete>2 OCEAN BVD;SEACLIFF PARK SA 5049;
                            AUSTRALIA</AddressComplete>
                        </Address>
                     </ResultData>
                  </ResultDataSet>
               </Result>
            </Results>
         </ProcessResult>
      </ProcessResponse>
   </soap:Body>
</soap:Envelope>

If you set

GlobalPreferredDescriptor

to a value other than DATABASE, the

GlobalPreferredDescriptor

setting takes precedence over the

ElementAbbreviation

setting for descriptors in the relevant countries.

GlobalPreferredDescriptor Behavior in Multi-Language Countries

Address Verification returns descriptors in the language that the

PreferredLanguage

attribute specifies and in the form that the

GlobalPreferredDescriptor

attribute specifies.

The following table shows how Address Verification applies a global preferred descriptor of PRESERVE_INPUT to a French-language address when you specify English as the preferred language:

Input Address	Output Address
800 BOUL RENE-LEVESQUE O MONTREAL QC H3B 1Y8	800 RENE-LEVESQUE BVD W MONTREAL QC H3B 1Y8

If the reference database for the preferred language does not contain the descriptor in the form that the global preferred descriptor specifies, Address Verification falls back to the default format for the descriptor in the preferred language.

If you set the global preferred descriptor to PRESERVE_INPUT and you specify a preferred language that differs from the input language, the

PreferredLanguage

attribute takes precedence.

Validation Parameters

Configurable Output Format for Element Descriptors (5.6.0)

Download Guide

Watch

Comments

Communities

Knowledge Base

Success Portal