Difference between revisions of "Global Address Verification:Response"

From Melissa Data Wiki
Jump to navigation Jump to search
(Created page with "{{GlobalAddressVerificationNav |InputOutputCollapse= }} {{CustomTOC}} A response is the result of a request. This consists of returned results codes, parsed address element...")
 
Line 124: Line 124:
The following elements are the basic options for each request. These apply to the entire response, not the individual records.
The following elements are the basic options for each request. These apply to the entire response, not the individual records.


<h3 style="background-color:rgb240,240,240;">Version</h3>
<h3 style="background-color:rgb(240,240,240);">Version</h3>
:This is a string value that is the current revision number of Global Address Verification.
:This is a string value that is the current revision number of Global Address Verification.


Line 136: Line 136:




<h3 style="background-color:rgb240,240,240;">Transmission Reference</h3>
<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>
:This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.
:This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.


Line 148: Line 148:




<h3 style="background-color:rgb240,240,240;">Transmission Results</h3>
<h3 style="background-color:rgb(240,240,240);">Transmission Results</h3>
:This is a string value that lists error codes from any errors caused by the most recent request as a whole.
:This is a string value that lists error codes from any errors caused by the most recent request as a whole.


Line 162: Line 162:




<h3 style="background-color:rgb240,240,240;">Total Records</h3>
<h3 style="background-color:rgb(240,240,240);">Total Records</h3>
:Displays the total number of records returned.
:Displays the total number of records returned.


Line 190: Line 190:




<h3 style="background-color:rgb240,240,240;">Record ID</h3>
<h3 style="background-color:rgb(240,240,240);">Record ID</h3>
:This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.
:This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.


Line 202: Line 202:




<h3 style="background-color:rgb240,240,240;">Results</h3>
<h3 style="background-color:rgb(240,240,240);">Results</h3>
:This is a string value with comma delimited status, error codes, and change codes for the record.
:This is a string value with comma delimited status, error codes, and change codes for the record.


Revision as of 22:36, 1 September 2016

← Global Address Verification

Global Address Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
REST JSONP
REST XML
Batch JSON
Batch SOAP
Batch XML
Result Codes
Result Code Use
Global Address Verification Result Codes
Sample Code



A response is the result of a request. This consists of returned results codes, parsed address elements, and appended address information.

Depending on the protocol used to make the request, the response will be in a certain protocol. Global Address Verification supports the JSON, JSONP, SOAP, and XML protocols.


Field Names

This is a list of the response field names and their protocol naming conventions.

Field Name Level JSON/XML
Version Request Version
Transmission Reference Request TransmissionReference
Transmission Results Request TransmissionResults
Total Records Request TotalRecords
Record ID Record RecordID
Results Record Results
Formatted Address Record FormattedAddress
Organization Record Organization
Address Line 1 Record AddressLine1
Address Line 2 Record AddressLine2
Address Line 3 Record AddressLine3
Address Line 4 Record AddressLine4
Address Line 5 Record AddressLine5
Address Line 6 Record AddressLine6
Address Line 7 Record AddressLine7
Address Line 8 Record AddressLine8
Sub Premises Record SubPremises
Double Dependent Locality Record DoubleDependentLocality
Dependent Locality Record DependentLocality
Locality Record Locality
Sub Administrative Area Record SubAdministrativeArea
Administrative Area Record AdministrativeArea
Postal Code Record PostalCode
Address Type Record AddressType
Address Key Record AddressKey
Sub National Area Record SubNationalArea
Country Name Record CountryName
CountryISO3166_1_Alpha2 Record CountryISO3166_1_Alpha2
CountryISO3166_1_Alpha3 Record CountryISO3166_1_Alpha3
CountryISO3166_1_Numeric Record CountryISO3166_1_Numeric
Country Subdivision Code Record CountrySubdivisionCode
Thoroughfare Record Thoroughfare
Thoroughfare Pre Direction Record ThoroughfarePreDirection
Thoroughfare Leading Type Record ThoroughfareLeadingType
Thoroughfare Name Record ThoroughfareName
Thoroughfare Trailing Type Record ThoroughfareTrailingType
Thoroughfare Post Direction Record ThoroughfarePostDirection
Dependent Thoroughfare Record DependentThoroughfare
Dependent Thoroughfare Pre Direction Record DependentThoroughfarePreDirection
Dependent Thoroughfare Leading Type Record DependentThoroughfareLeadingType
Dependent Thoroughfare Name Record DependentThoroughfareName
Dependent Thoroughfare Trailing Type Record DependentThoroughfareTrailingType
Dependent Thoroughfare Post Direction Record DependentThoroughfarePostDirection
Building Record Building
Premises Type Record PremisesType
Premises Number Record PremisesNumber
Sub Premises Type Record SubPremisesType
Sub Premises Number Record SubPremisesNumber
Post Box Record PostBox
Latitude Record Latitude
Longitude Record Longitude


Response Elements

The following elements are the basic options for each request. These apply to the entire response, not the individual records.

Version

This is a string value that is the current revision number of Global Address Verification.
Protocol Syntax
JSON "Version":"string"
SOAP/XML <Version>string</Version>


Transmission Reference

This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.
Protocol Syntax
JSON "TransmissionReference":"string"
SOAP/XML <TransmissionReference>string</TransmissionReference>


Transmission Results

This is a string value that lists error codes from any errors caused by the most recent request as a whole.
For a complete list of error codes, see Global Address Verification Result Codes.
Protocol Syntax
JSON "TransmissionResults":"string"
SOAP/XML <TransmissionResults>string</TransmissionResults>


Total Records

Displays the total number of records returned.
Protocol Syntax
JSON "TotalRecords":"string"
SOAP/XML <TotalRecords>string</TotalRecords>


Response Record Elements

JSON will only contain the Records element.

Protocol Definition
JSON Each record will be contained within [{}] under the Records element.
SOAP
XML

Each of the following elements are returned for each record in the Response Array.


Record ID

This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.
Protocol Syntax
JSON "RecordID":"string"
SOAP/XML <RecordID>string</RecordID>


Results

This is a string value with comma delimited status, error codes, and change codes for the record.
For a complete list of codes, see Global Address Verification Result Codes.
Protocol Syntax
JSON "Results":"string"
SOAP/XML <Results>string</Results>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>


This
Protocol Syntax
JSON "":"string"
SOAP/XML <>string</>
Retrieved from "http://wiki.melissadata.com/index.php?title=Global_Address_Verification:Response&oldid=11481"