Global Address Object:Result Codes: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Global Address Object:Reference|← Global Address Object Reference]]
{{GlobalAddressObjectNav
|ResultCodeCollapse=
}}


{| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size:9pt; color:#0645ad; padding:8px 8px;"
{{CustomTOC}}
! style="text-align:left; color:black; border-bottom:1px solid #aaaaaa;"|'''Global Address Object Navigation'''
 
|-
==Result Codes==
| style="padding-right:220px;"|
Melissa Data's products use a result code system to indicate data quality; the status and any errors. These result codes are four-character codes (two letters followed by two numbers), delimited by commas. Result code definitions are shared among Melissa Data products.
|-
 
|
===Example===
{| class="mw-collapsible mw-collapsed" style="width:100%;"
An example returned result code string:
|- align="left"
 
! style="color:black;"|[[Global Address Object:Introduction|Introduction]]
<pre>AV14,AE11,AC14</pre>
 
Instead of looking at multiple properties and methods to determine status, you can look at the output of the results parameter.
 
From this output you can determine that the address is:
 
{|class="alternate01" cellspacing="0"
!Code
!Short Description
!Long Description
|-
|-
|[[Global Address Object:Platforms and Methods|Platforms and Methods]]
|AV14
|Premise Partial
|The address has been partially verified to the Premise (House or Building) Level, which is NOT the highest level possible with the reference data.
|-
|-
|[[Global Address Object:Licensing|Licensing]]
|AE11
|Premise Number Missing
|The premise (house or building) number for the address is missing.
|-
|-
|[[Global Address Object:Result Code Use|Result Code Use]]
|AC14
|}
|Sub Premise Number Change
|-
|The sub premise (suite) unit number was added or changed.
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Interface|Interface]]
|-
|[[Global Address Object:Address Handling|Address Handling]]
|-
|[[Global Address Object:Interface Use|Interface Use]]
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Methods|Methods]]
|-
|[[Global Address Object:Setup Methods|Setup Methods]]
|-
|[[Global Address Object:Input Methods|Input Methods]]
|-
|[[Global Address Object:Processing Methods|Processing Methods]]
|-
|[[Global Address Object:Output Methods|Output Methods]]
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Parameters|Parameters]]
|-
|[[Global Address Object:Input Parameters|Input Parameters]]
|-
|[[Global Address Object:Output Parameters|Output Parameters]]
|}
|-
|
{| class="mw-collapsible" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Result Codes|Result Codes]]
|-
|[[Returned Result Codes:APIs#Global Address Object|Returned Result Codes]]
|-
|[[Global Address Object:Other Codes|Other Codes]]
|}
|}
|}


Be sure to reference [[Result Codes]] for a list of Melissa Data's result codes.
===Understanding the Code===
To fully understand result codes, you need to know them. Knowing what codes are possible and what they indicate will be key in building an effective application. It is useful to know all the codes, but this does not necessarily mean you will use them all. Just because you have a toolbox, doesn't mean you will also try to use a screwdriver along with a hammer on a nail.
===Reference Data Quality Level===
Keep in mind that the reference data quality level is dependent on the country. Some countries have more precise reference data than others. This will affect what result codes will be returned by addresses from certain countries. Reference the [[Data Coverage by Country|Data Coverage by Country]] page for a detailed list of the country address reference data quality levels.


{{CustomTOC}}
For example, while the United States is level AV-5 (Verification Level - Delivery Point), Western Sahara is AV-2 (Verification Level - Locality). An address from the United States has the potential to return result codes verifying the street, building, house number, etc. While an address in Western Sahara won't have dunetop accuracy. The reference data quality is only to locality level, therefore you may be able to verify the city, but not any street or house level.


For a complete list of result codes and their definitions, please see [[Result Codes]].
For a complete list of result codes and their definitions, please see [[Result Codes]].
Line 74: Line 53:


The second number indicates the level of verification. There are five levels:
The second number indicates the level of verification. There are five levels:
[Image]


Administrative Area (level 1) verification is the most general verification area, with subpremise (level 5) being the most specific area. Ideally, all addresses should be verified to Premise (level 4) or subpremise (level 5.)  
Administrative Area (level 1) verification is the most general verification area, with subpremise (level 5) being the most specific area. Ideally, all addresses should be verified to Premise (level 4) or subpremise (level 5.)  
Line 83: Line 60:
For example:
For example:


a. AV25 indicates a maximum possible verification to the subpremise (level 5.)
<ol style="list-style-type:upper-alpha">
b. AV24 indicates a maximum possible verification to the Premise (level 4.)
<li>AV25 indicates a maximum possible verification to the subpremise (level 5.)</li>
c. AV22 indicates a maximum possible verification to the Locality (level 2.)
<li>AV24 indicates a maximum possible verification to the Premise (level 4.)</li>
 
<li>AV22 indicates a maximum possible verification to the Locality (level 2.)</li>
This can occur if the reference data only contains data up to the Locality level.
This can occur if the reference data only contains data up to the Locality level.
<li>AV14 indicates a partial verification to the Premise (level 4.) This indicates that the reference data has verification up to the subpremise (level 5.)</li>
</ol>


d. AV14 indicates a partial verification to the Premise (level 4.) This indicates that the reference data has verification up to the subpremise (level 5.)
For a list of result codes returned by Global Address Object, see [[Returned Result Codes:APIs#Global Address Object|Returned Result Codes]].
 
For a list of AV codes returned by Global Address Object, see [[Returned Result Codes:APIs#Global Address Object|Returned Result Codes]].





Latest revision as of 21:55, 19 June 2017

← Global Address Object Reference

Global Address Object Navigation
Introduction
System Requirements
Setup
Licensing
Interface
Address Handling
Interface Use
Methods
Setup Methods
Input Methods
Processing Methods
Output Methods
Parameters
Input Parameters
Output Parameters
Result Codes
Global Address Object Result Codes
Other Codes



Result Codes

Melissa Data's products use a result code system to indicate data quality; the status and any errors. These result codes are four-character codes (two letters followed by two numbers), delimited by commas. Result code definitions are shared among Melissa Data products.

Example

An example returned result code string:

AV14,AE11,AC14

Instead of looking at multiple properties and methods to determine status, you can look at the output of the results parameter.

From this output you can determine that the address is:

Code Short Description Long Description
AV14 Premise Partial The address has been partially verified to the Premise (House or Building) Level, which is NOT the highest level possible with the reference data.
AE11 Premise Number Missing The premise (house or building) number for the address is missing.
AC14 Sub Premise Number Change The sub premise (suite) unit number was added or changed.

Be sure to reference Result Codes for a list of Melissa Data's result codes.

Understanding the Code

To fully understand result codes, you need to know them. Knowing what codes are possible and what they indicate will be key in building an effective application. It is useful to know all the codes, but this does not necessarily mean you will use them all. Just because you have a toolbox, doesn't mean you will also try to use a screwdriver along with a hammer on a nail.

Reference Data Quality Level

Keep in mind that the reference data quality level is dependent on the country. Some countries have more precise reference data than others. This will affect what result codes will be returned by addresses from certain countries. Reference the Data Coverage by Country page for a detailed list of the country address reference data quality levels.

For example, while the United States is level AV-5 (Verification Level - Delivery Point), Western Sahara is AV-2 (Verification Level - Locality). An address from the United States has the potential to return result codes verifying the street, building, house number, etc. While an address in Western Sahara won't have dunetop accuracy. The reference data quality is only to locality level, therefore you may be able to verify the city, but not any street or house level.

For a complete list of result codes and their definitions, please see Result Codes.

AV Verification Codes

  • AV2X denotes an address that has been verified to the highest possible level with the reference data.
  • AV1X denotes a partially verified address, but NOT to the highest level possible with the reference data.

The second number indicates the level of verification. There are five levels:

Administrative Area (level 1) verification is the most general verification area, with subpremise (level 5) being the most specific area. Ideally, all addresses should be verified to Premise (level 4) or subpremise (level 5.)

However this is dependent on the quality of the address data and the countries’ reference data. Some countries lack enough data to be verified to the subpremise. They may only have data to the Locality (level 2.) This is why it is possible to have an AV22 code. The address has been verified up to the Locality and the reference data only has verification up to that level.

For example:

  1. AV25 indicates a maximum possible verification to the subpremise (level 5.)
  2. AV24 indicates a maximum possible verification to the Premise (level 4.)
  3. AV22 indicates a maximum possible verification to the Locality (level 2.)
  4. This can occur if the reference data only contains data up to the Locality level.
  5. AV14 indicates a partial verification to the Premise (level 4.) This indicates that the reference data has verification up to the subpremise (level 5.)

For a list of result codes returned by Global Address Object, see Returned Result Codes.


For a complete list of result codes and their definitions, please see Result Codes.