Table of Contents

Search

  1. Preface
  2. Introduction to Informatica AddressDoctor Cloud
  3. Informatica AddressDoctor Cloud Interface
  4. Informatica AddressDoctor Cloud Request Parameters
  5. Informatica AddressDoctor Cloud Response Elements
  6. Examples

Developer Guide

Developer Guide

ResultDataSet

ResultDataSet

The
ResultDataSet
array contains various
ResultData
objects. Based on the
ProcessMode
,
ResultDataSet
can contain corrections for the input address or multiple address suggestions. If it is a response to a batch mode or certified mode, the
ResultDataSet
array might contain up to 1000 validated addresses.

ResultData

A ResultData object represents one suggestion or a corrected result, depending on the
ProcessMode
and
ProcessStatus
. It also might contain the following information about the processing and the corrected address or suggestions in the form of an address object.
MailabilityScore
Indicates the possibility of successful delivery to the address on the following 6-point scale:

    5
    . Completely confident of delivery.

    4
    . Almost certain.

    3
    . A good chance of delivery.

    2
    . A fair chance of delivery.

    1
    . Very low chance of delivery.

    0
    . No chance of delivery.

ResultPercentage
Indicates how similar is the corrected result to the input address. Values close to 100% imply high similarity. The
ResultPercentage
value enables you to filter out extensively corrected addresses, especially when the data quality requirements are very high. You can also use the
ResultPercentage
value to determine which of the interactive mode results show the least deviation from the input.
Element Status and Relevance values
ElementStatus
values give a detailed explanation of the outcome of a validation operation.
ElementStatus
values are relevant only when a validation operation has been performed. However, Informatica AddressDoctor Cloud returns some values for
ElementInputStatus
even after a parsing operation.
ElementInputStatus
and
ElementResultStatus
might contain status information for up to 20 address elements.
ElementInputStatus
provides per-element status on the matching of input elements with the reference data.
ElementResultStatus
provides per-element information about any corrections or modifications done to the input elements while generating the validated output. The following list shows element positions from left to right:
  1. PostalCode level 0
  2. PostalCode level 1 (for example, ZIP+4 - Plus 4 addition)
  3. Locality level 0
  4. Locality level 1 (for example, Urbanization, Dependent Locality)
  5. Province level 0
  6. Province level 1 (for example, Sub Province)
  7. Street level 0
  8. Street level 1 (for example, Dependent street)
  9. HouseNumber level 0
  10. HouseNumber level 1
  11. Delivery service level 0 (for example, PO Box, GPO, Packstation, Private Bags)
  12. Delivery service level 1
  13. Building level 0
  14. Building level 1
  15. SubBuilding level 0
  16. SubBuilding level 1
  17. Organization level 0
  18. Organization level 1
  19. Country level 0 (Mother country)
  20. Country level 1 (for example, Territory)
Level 0 in this list pertains to the Item 1 status information, whereas level 1 summarizes the status information for Items 2-6.
ElementInputStatus
Each character in the
ElementInputStatus
describes one address element as explained in the preceding bullet. The possible values are:

    0
    . The input address contains no data at this position.

    1
    . The data at this position cannot be found in the reference data.

    2
    . The position cannot be checked because reference data is missing.

    3
    . The data is incorrect. The reference database suggests that the Number or DeliveryService value is outside the range expected by the reference data. In batch and certified modes, the input data at this position is passed uncorrected as output. In suggestion list modes, Informatica AddressDoctor can provide alternatives.

    4
    . The data at this position matches the reference data, but with errors.

    5
    . The data at this position matches the reference data, but the data element was corrected or standardized.

    6
    . The data at this position matches the reference data without any error.

ElementResultStatus
Each character in the
ElementResultStatus
maps to one address element as explained earlier in this topic. The possible values for the first 18 positions (address elements without country) are:

    0
    . The output address contains no data at this position.

    1
    . The data at this position cannot be found in the reference data. The input data is copied to the output data.

    2
    . Data at this position is not checked but is standardized.

    3
    . Data at this position is checked but does not match the expected reference data. The reference data suggests that the number data is not in the valid range. The input data is copied to the output. The status value applies in batch mode only.

    4
    . Data at this position is copied from the input because the corresponding reference data is not available.

    5
    . Data at this position is validated but not changed because multiple matches exist in the reference data. The status value applies in batch mode only.

    6
    . Data validation deleted the input value at this position.

    7
    . Data at this position is validated but contained a spelling error. Validation corrected the error by copying the value from the reference data.

    8
    . Data at this position is validated and updated by adding a value from the reference data. It can also mean that the reference database contains additional data for the input element. For example, validation can add a building or sub-building number if a perfect match is found for the street name or building name.

    9
    . Data at this position is validated but not changed, and the delivery status is not clear. For example, the DPV value is wrong.

    C
    . Data at this position is validated and verified, but the name data is out of date. Validation changed the name data.

    D
    . Data at this position is validated and verified but changed from an exonym to an official name.

    E
    . Data at this position is validated and verified. However, data validation standardized the character case or the language. Address validation can change the language if the value fully matches a language alternative. For example, address validation can change "Brussels" to "Bruxelles" in a Belgian address.

    F
    . Data at this position is validated, verified, and not changed, due to a perfect match with reference data.

Positions 19 and 20 in the output string relate to country data. The following values are possible for positions 19 and 20.

    0
    . The output address contains no data at this position.

    1
    . The country is not recognized.

    4
    . The country is recognized from the DefaultCountryISO3 setting.

    5
    . The country is not recognized because multiple matches are available.

    6
    . The country is recognized from a script.

    7
    . The country is recognized from the address format.

    8
    . The country is recognized from major town data.

    9
    . The country is recognized from province data.

    C
    . The country is recognized from territory data.

    D
    . The country is recognized from the country name, but the name contains errors.

    E
    . The country is recognized from the country name without errors.

    F
    . The country is recognized from the ForceCountryISO3 setting.

ElementRelevance
In addition to the element status values described in the preceding bullets, Informatica AddressDoctor Cloud provides you information about the relevance of various address elements with regard to the postal guidelines of the region. The possible values for each address element are 1 for relevant and 0 for not relevant. For any given address, all address elements with a value of 1 must be present for an output address to be deemed valid by the local postal authority.
ElementRelevance
may vary from address to address for countries with different address types, for example, rural verus metropolitan addressing. Furthermore,
AddressElements
that have actually been validated against reference data with
ElementResultStatus
7 and higher may override the default
ElementRelevance
value defined for that
AddressElement
.
Note that that
ElementRelevance
is meaningful only for addresses with the
ProcessStatus
value of C or V in batch and I3 and I4 for INTERACTIVE requests.
ExtElementStatus
The Extended Element Result Status or EERS code is a twenty-character output field for all valid or corrected addresses. The EERS indicates that additional information might be available in the reference database for the given address. The following EERS codes are available:

    1
    . Data available for the element in the database, but not used for validation.

    2
    . Element unchecked, but changed because of wrong syntax/format.

    3
    . Numeric in element correct, but element changed because of wrong syntax/descriptor.

    4
    . Element correct or unchecked, but moved because of wrong format.

    5
    . Alternative available in database – for example, language, preferred locality name, alias name.

    6
    . Unvalidated parts inside element like additional information.

    7
    . Level change like moving HNO1 to HNO2 or swapping Locality2 with Locality1.

    8
    . Type change for fielded input only; for example, moving SubBuilding to Building Level 2.

    9
    . General Postal Authority Rule.

    A
    . Dominant match for dual address processing.

    B
    . Relevance is only a country-wide default and cannot be trusted.

    C
    . Fast Completion Overflow.

    D
    . Numeric for range expansion (interpolated).

    E
    . Language not available for the country, database language returned.

    F
    . Output address is outdated.

For all other scenarios, Informatica AddressDoctor Cloud returns an EERS value of zero.
AddressResolutionCode
The Address Resolution Code or ARC is a twenty-character output field for all invalid records. The ARC explains why an address is rejected. The following ARC codes are available:

    2
    . Missing element in address.

    3
    . Numeric provided inside element is outside permissible range – for example, wrong numeric inside street name or house number; 100 Main St when house numbers range from 400-800.

    4
    . Multiple inputs for the element.

    5
    . Input element ambiguous / multiple matches.

    6
    . Element contradicts other elements. For example, the postal code information and locality information do not match.

    7
    . 3 strike rule/too many corrections in combination of several elements.

    8
    . General Postal Authority Rule.

For all other scenarios, Informatica AddressDoctor Cloud returns an ARC value of zero.
LanguageISO3
The LanguageISO3 field contains the ISO 639 3-letter code of the language in which Informatica AddressDoctor Cloud returns the result. For example,
DEU
for German.
For transliterated output, Informatica AddressDoctor Cloud specifies the original language in the output. For example,
JPN
in case of romanized Japanese output.
If the language information is not available, Informatica AddressDoctor returns a value of
XXX
in the LanguageISO3 code field.
Address
The
Address
object contains the address elements of a result. If there were multiple items, such as Locality and Dependent Locality, they are stored in a sequence of the same element.
<Locality> <string>Locality</string> <string>DependentLocality</string> </Locality>
In VB.NET this is represented as an Array. Note that AddressDoctor Cloud does not include the empty elements in the XML response.
The
Address
object also contains a
Residue
element that contains information that was part of the input but is not required for mail delivery in the country to which the address belongs. The
Residue
element can contain multiple strings of data that is superfluous to the validated output. You can set the
MaxItemCount
value for the
Residue
element to specify the maximum number of strings to include in the
Residue
element.

0 COMMENTS

We’d like to hear from you!