Personator Consumer:Response: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
No edit summary
Line 314: Line 314:


Each of the following elements are returned for each record in the Response Array.
Each of the following elements are returned for each record in the Response Array.
<h3 style="background-color:rgb(240,240,240);">Address Delivery Installation</h3>
:
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressDeliveryInstallation":"'''''string'''''"</code>
|-
|SOAP/XML||<code><AddressDeliveryInstallation>'''''string'''''</AddressDeliveryInstallation></code>
|}
<h3 style="background-color:rgb(240,240,240);">FormattedAddress</h3>
:This is a string value that is the address in the correct format for mailing from the country specified in the CountryOfOrigin element. This includes the Organization as the first line, one or more lines in the origin country’s format, and the destination country (if required). Separate lines will be delimited by what is specified in the option. See [[Global Address Verification:Request#LineSeparator|LineSeparator]] for more information.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"FormattedAddress":"'''''string'''''"</code>
|-
|SOAP/XML||<code><FormattedAddress>'''''string'''''</FormattedAddress></code>
|}
<h3 style="background-color:rgb(240,240,240);">Organization</h3>
:This is a string value that matches the Organization request element. It is not modified or populated by the Cloud Service.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Organization":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Organization>'''''string'''''</Organization></code>
|}




Line 376: Line 337:
|-
|-
|SOAP/XML||<code><AddressLine2>'''''string'''''</AddressLine2></code>
|SOAP/XML||<code><AddressLine2>'''''string'''''</AddressLine2></code>
|}
<h3 style="background-color:rgb(240,240,240);">AddressLine3</h3>
:These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine3":"'''''string'''''"</code>
|-
|SOAP/XML||<code><AddressLine3>'''''string'''''</AddressLine3></code>
|}
<h3 style="background-color:rgb(240,240,240);">AddressLine4</h3>
:These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine4":"'''''string'''''"</code>
|-
|SOAP/XML||<code><AddressLine4>'''''string'''''</AddressLine4></code>
|}
<h3 style="background-color:rgb(240,240,240);">AddressLine5</h3>
:These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine5":"'''''string'''''"</code>
|-
|SOAP/XML||<code><AddressLine5>'''''string'''''</AddressLine5></code>
|}
<h3 style="background-color:rgb(240,240,240);">AddressLine6</h3>
:These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine6":"'''''string'''''"</code>
|-
|SOAP/XML||<code><AddressLine6>'''''string'''''</AddressLine6></code>
|}
<h3 style="background-color:rgb(240,240,240);">AddressLine7</h3>
:These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine7":"'''''string'''''"</code>
|-
|SOAP/XML||<code><AddressLine7>'''''string'''''</AddressLine7></code>
|}
<h3 style="background-color:rgb(240,240,240);">AddressLine8</h3>
:These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine8":"'''''string'''''"</code>
|-
|SOAP/XML||<code><AddressLine8>'''''string'''''</AddressLine8></code>
|}
<h3 style="background-color:rgb(240,240,240);">SubPremises</h3>
:This is a string value that is the parsed SubPremises from the AddressLine elements.
:'''US Term:''' Suite
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SubPremises":"'''''string'''''"</code>
|-
|SOAP/XML||<code><SubPremises>'''''string'''''</SubPremises></code>
|}
<h3 style="background-color:rgb(240,240,240);">DoubleDependentLocality</h3>
:This is a string value that is the standardized contents of the DoubleDependentLocality element.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"DoubleDependentLocality":"'''''string'''''"</code>
|-
|SOAP/XML||<code><DoubleDependentLocality>'''''string'''''</DoubleDependentLocality></code>
|}
<h3 style="background-color:rgb(240,240,240);">DependentLocality</h3>
:This is a string value that is the standardized contents of the DependentLocality element.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"DependentLocality":"'''''string'''''"</code>
|-
|SOAP/XML||<code><DependentLocality>'''''string'''''</DependentLocality></code>
|}
<h3 style="background-color:rgb(240,240,240);">Locality</h3>
:This is a string value that is the standardized contents of the Locality element.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Locality":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Locality>'''''string'''''</Locality></code>
|}
<h3 style="background-color:rgb(240,240,240);">SubAdministrativeArea</h3>
:This is a string value that is the standardized contents of the SubAdministrativeArea element.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SubAdministrativeArea":"'''''string'''''"</code>
|-
|SOAP/XML||<code><SubAdministrativeArea>'''''string'''''</SubAdministrativeArea></code>
|}
<h3 style="background-color:rgb(240,240,240);">AdministrativeArea</h3>
:This is a string value that is the standardized contents of the AdministrativeArea element.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AdministrativeArea":"'''''string'''''"</code>
|-
|SOAP/XML||<code><AdministrativeArea>'''''string'''''</AdministrativeArea></code>
|}
<h3 style="background-color:rgb(240,240,240);">PostalCode</h3>
:This is a string value that is the standardized contents of the PostalCode element.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PostalCode":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PostalCode>'''''string'''''</PostalCode></code>
|}
|}


Line 563: Line 366:
|}
|}


---


<h3 style="background-color:rgb(240,240,240);">SubNationalArea</h3>
:This is a string value that is the standardized contents of the SubNationalArea element.


:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SubNationalArea":"'''''string'''''"</code>
|-
|SOAP/XML||<code><SubNationalArea>'''''string'''''</SubNationalArea></code>
|}




<h3 style="background-color:rgb(240,240,240);">CountryName</h3>
<h3 style="background-color:rgb(240,240,240);">Latitude</h3>
:This is a string value that is the standardized contents of the CountryName element.
:Returns the geocoded latitude for the address entered in the AddressLine field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"CountryName":"'''''string'''''"</code>
|JSON||<code>"Latitude":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><CountryName>'''''string'''''</CountryName></code>
|SOAP/XML||<code><Latitude>'''''string'''''</Latitude></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">CountryISO3166_1_Alpha2</h3>
<h3 style="background-color:rgb(240,240,240);">Length of Residence</h3>
:This is a string value that is the parsed CountryISO3166_1_Alpha2 element from the input.
::Returns the range of the individual's length of residency in their current address.
 
:For example:


:{| class="alternate01"
:{| class="alternate01"
!Country !! Code
!Value
|-
|-
|United States||US
|Less than 1 year
|-
|-
|Canada||CA
|1-2 years
|-
|-
|Philippines||PH
|2-3 years
|}
 
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"CountryISO3166_1_Alpha2":"'''''string'''''"</code>
|3-4 years
|-
|-
|SOAP/XML||<code><CountryISO3166_1_Alpha2>'''''string'''''</CountryISO3166_1_Alpha2></code>
|4-5 years
|}
 
 
<h3 style="background-color:rgb(240,240,240);">CountryISO3166_1_Alpha3</h3>
:This is a string value that is the parsed CountryISO3166_1_Alpha3 element from the input.
 
:For example:
 
:{| class="alternate01"
!Country !! Code
|-
|-
|United States||USA
|5-6 years
|-
|-
|Canada||CAN
|6-7 years
|-
|-
|Philippines||PHL
|7-8 years
|}
 
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"CountryISO3166_1_Alpha3":"'''''string'''''"</code>
|8-9 years
|-
|-
|SOAP/XML||<code><CountryISO3166_1_Alpha3>'''''string'''''</CountryISO3166_1_Alpha3></code>
|9-10 years
|}
 
 
<h3 style="background-color:rgb(240,240,240);">CountryISO3166_1_Numeric</h3>
:This is a string value that is the parsed CountryISO3166_1_Numeric element from the input.
 
:For example:
 
:{| class="alternate01"
!Country !! Code
|-
|-
|United States||840
|10-11 years
|-
|-
|Canada||124
|11-12 years
|-
|-
|Philippines||608
|12-13 years
|}
 
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"CountryISO3166_1_Numeric":"'''''string'''''"</code>
|13-14 years
|-
|-
|SOAP/XML||<code><CountryISO3166_1_Numeric>'''''string'''''</CountryISO3166_1_Numeric></code>
|14-15 years
|}
 
 
<h3 style="background-color:rgb(240,240,240);">CountrySubdivisionCode</h3>
:This is the ISO3166-2 code for country subdivisions, usually the administrative area for a country. The format is the 2 letter country code followed by a dash followed by 2 or 3 characters or two numbers. Examples are: US-CA, CN-16, or AU-VIC.
 
:Currently, this field is only populated for some countries. These countries are: AU, BR, CA, CN, CR, DM, GT, HN, NI, MX, SV, US.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"CountrySubdivisionCode":"'''''string'''''"</code>
|15+ years
|-
|-
|SOAP/XML||<code><CountrySubdivisionCode>'''''string'''''</CountrySubdivisionCode></code>
|Unknown
|}
|}
<h3 style="background-color:rgb(240,240,240);">Thoroughfare</h3>
:This is a string value that is the parsed Thoroughfare element from the input.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"Thoroughfare":"'''''string'''''"</code>
|JSON||<code>"LengthOfResidence":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><Thoroughfare>'''''string'''''</Thoroughfare></code>
|SOAP/XML||<code><LengthOfResidence>'''''string'''''</LengthOfResidence></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">ThoroughfarePreDirection</h3>
<h3 style="background-color:rgb(240,240,240);">Longitude</h3>
:This is a string value that is the parsed ThoroughfarePreDirection element from the input.
:Returns the geocoded longitude for the address entered in the AddressLine field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"ThoroughfarePreDirection":"'''''string'''''"</code>
|JSON||<code>"Longitude":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><ThoroughfarePreDirection>'''''string'''''</ThoroughfarePreDirection></code>
|SOAP/XML||<code><Longitude>'''''string'''''</Longitude></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">ThoroughfareLeadingType</h3>
<h3 style="background-color:rgb(240,240,240);">Mailbox Name</h3>
:This is a string value that is the parsed ThoroughfareLeadingType element from the input.
:Returns the parsed mailbox name for the email entered in the Email field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"ThoroughfareLeadingType":"'''''string'''''"</code>
|JSON||<code>"MailboxName":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><ThoroughfareLeadingType>'''''string'''''</ThoroughfareLeadingType></code>
|SOAP/XML||<code><MailboxName>'''''string'''''</MailboxName></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">ThoroughfareName</h3>
<h3 style="background-color:rgb(240,240,240);">Marital Status</h3>
:This is a string value that is the parsed ThoroughfareName element from the input.
:Returns the individual's marital status.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"ThoroughfareName":"'''''string'''''"</code>
|JSON||<code>"MaritalStatus":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><ThoroughfareName>'''''string'''''</ThoroughfareName></code>
|SOAP/XML||<code><MaritalStatus>'''''string'''''</MaritalStatus></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">ThoroughfareTrailingType</h3>
<h3 style="background-color:rgb(240,240,240);">Melissa Address Key</h3>
:This is a string value that is the parsed ThoroughfareTrailingType element from the input.
:Returns a unique key associated with an address.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"ThoroughfareTrailingType":"'''''string'''''"</code>
|JSON||<code>"MelissaAddressKey":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><ThoroughfareTrailingType>'''''string'''''</ThoroughfareTrailingType></code>
|SOAP/XML||<code><MelissaAddressKey>'''''string'''''</MelissaAddressKey></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">ThoroughfarePostDirection</h3>
<h3 style="background-color:rgb(240,240,240);">Melissa Address Key Base</h3>
:This is a string value that is the parsed ThoroughfarePostDirection element from the input.
:Returns a unique key associated with a building containing multiple suites/apartments.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"ThoroughfarePostDirection":"'''''string'''''"</code>
|JSON||<code>"MelissaAddressKeyBase":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><ThoroughfarePostDirection>'''''string'''''</ThoroughfarePostDirection></code>
|SOAP/XML||<code><MelissaAddressKeyBase>'''''string'''''</MelissaAddressKeyBase></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">DependentThoroughfare</h3>
<h3 style="background-color:rgb(240,240,240);">Move Date</h3>
:This is a string value that is the parsed DependentThoroughfare element from the input.
:Returns the date associated with the move address.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"DependentThoroughfare":"'''''string'''''"</code>
|JSON||<code>"MoveDate":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><DependentThoroughfare>'''''string'''''</DependentThoroughfare></code>
|SOAP/XML||<code><MoveDate>'''''string'''''</>MoveDate</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">DependentThoroughfarePreDirection</h3>
<h3 style="background-color:rgb(240,240,240);">Name First</h3>
:This is a string value that is the parsed DependentThoroughfarePreDirection element from the input.
:Returns the first name in the FullName field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"DependentThoroughfarePreDirection":"'''''string'''''"</code>
|JSON||<code>"NameFirst":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><DependentThoroughfarePreDirection>'''''string'''''</DependentThoroughfarePreDirection></code>
|SOAP/XML||<code><NameFirst>'''''string'''''</NameFirst></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">DependentThoroughfareLeadingType</h3>
<h3 style="background-color:rgb(240,240,240);">Name First 2</h3>
:This is a string value that is the parsed DependentThoroughfareLeadingType element from the input.
:Only used if 2 names are in the FullName field. Returns the second name in the FullName field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"DependentThoroughfareLeadingType":"'''''string'''''"</code>
|JSON||<code>"NameFirst2":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><DependentThoroughfareLeadingType>'''''string'''''</DependentThoroughfareLeadingType></code>
|SOAP/XML||<code><NameFirst2>'''''string'''''</NameFirst2></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">DependentThoroughfareName</h3>
<h3 style="background-color:rgb(240,240,240);">Name Full</h3>
:This is a string value that is the parsed DependentThoroughfareName element from the input.
:Returns the full name for the record.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"DependentThoroughfareName":"'''''string'''''"</code>
|JSON||<code>"NameFull":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><DependentThoroughfareName>'''''string'''''</DependentThoroughfareName></code>
|SOAP/XML||<code><NameFull>'''''string'''''</NameFull></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">DependentThoroughfareTrailingType</h3>
<h3 style="background-color:rgb(240,240,240);">Name Last</h3>
:This is a string value that is the parsed DependentThoroughfareTrailingType element from the input.
:Returns the last name in the FullName field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"DependentThoroughfareTrailingType":"'''''string'''''"</code>
|JSON||<code>"NameLast":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><DependentThoroughfareTrailingType>'''''string'''''</DependentThoroughfareTrailingType></code>
|SOAP/XML||<code><NameLast>'''''string'''''</NameLast></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">DependentThoroughfarePostDirection</h3>
<h3 style="background-color:rgb(240,240,240);">Name Last 2</h3>
:This is a string value that is the parsed DependentThoroughfarePostDirection element from the input.
:Only used if 2 names are in the FullName field. Returns a last name for the second name in the FullName field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"DependentThoroughfarePostDirection":"'''''string'''''"</code>
|JSON||<code>"NameLast2":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><DependentThoroughfarePostDirection>'''''string'''''</DependentThoroughfarePostDirection></code>
|SOAP/XML||<code><NameLast2>'''''string'''''</NameLast2></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">Building</h3>
<h3 style="background-color:rgb(240,240,240);">Name Middle</h3>
:This is a string value that is the parsed Building element from the input.
:Returns a middle name for the name in the FullName field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"Building":"'''''string'''''"</code>
|JSON||<code>"NameMiddle":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><Building>'''''string'''''</Building></code>
|SOAP/XML||<code><NameMiddle>'''''string'''''</NameMiddle></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">PremisesType</h3>
<h3 style="background-color:rgb(240,240,240);">Name Middle 2</h3>
:This is a string value that is the parsed PremisesType element from the input.
:Only used if 2 names are in the FullName field. Returns a middle name for the second name in the FullName field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"PremisesType":"'''''string'''''"</code>
|JSON||<code>"NameMiddle2":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><PremisesType>'''''string'''''</PremisesType></code>
|SOAP/XML||<code><NameMiddle2>'''''string'''''</NameMiddle2></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">PremisesNumber</h3>
<h3 style="background-color:rgb(240,240,240);">Name Prefix</h3>
:This is a string value that is the parsed PremisesNumber element from the input.
:Returns a prefix for the name in the FullName field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"PremisesNumber":"'''''string'''''"</code>
|JSON||<code>"NamePrefix":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><PremisesNumber>'''''string'''''</PremisesNumber></code>
|SOAP/XML||<code><NamePrefix>'''''string'''''</NamePrefix></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">SubPremisesType</h3>
<h3 style="background-color:rgb(240,240,240);">Name Prefix 2</h3>
:This is a string value that is the parsed SubPremisesType element from the input.
:Only used if 2 names are in the FullName field. Returns a prefix for the second name in the FullName field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"SubPremisesType":"'''''string'''''"</code>
|JSON||<code>"NamePrefix2":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><SubPremisesType>'''''string'''''</SubPremisesType></code>
|SOAP/XML||<code><NamePrefix2>'''''string'''''</NamePrefix2></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">SubPremisesNumber</h3>
<h3 style="background-color:rgb(240,240,240);">Name Suffix</h3>
:This is a string value that is the parsed SubPremisesNumber element from the input.
:Returns a suffix for the name in the FullName field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"SubPremisesNumber":"'''''string'''''"</code>
|JSON||<code>"NameSuffix":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><SubPremisesNumber>'''''string'''''</SubPremisesNumber></code>
|SOAP/XML||<code><NameSuffix>'''''string'''''</NameSuffix></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">PostBox</h3>
<h3 style="background-color:rgb(240,240,240);">Name Suffix 2</h3>
:This is a string value that is the parsed PostBox element from the input.
:Only used if 2 names are in the FullName field. Returns a suffix for the second name in the FullName field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"PostBox":"'''''string'''''"</code>
|JSON||<code>"NameSuffix2":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><PostBox>'''''string'''''</PostBox></code>
|SOAP/XML||<code><NameSuffix2>'''''string'''''</NameSuffix2></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">Latitude</h3>
<h3 style="background-color:rgb(240,240,240);">New Area Code</h3>
:Returns the geocoded latitude for the address entered in the AddressLine field.
:Returns the parsed new area code for the phone number entered in the Phone field.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"Latitude":"'''''string'''''"</code>
|JSON||<code>"NewAreaCode":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><Latitude>'''''string'''''</Latitude></code>
|SOAP/XML||<code><NewAreaCode>'''''string'''''</NewAreaCode></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">Length of Residence</h3>
<h3 style="background-color:rgb(240,240,240);">Occupation</h3>
::Returns the range of the individual's length of residency in their current address.
:Returns the category for the individual's occupation.


:{| class="alternate01"
:{| class="alternate01"
!Value
!Value
|-
|-
|Less than 1 year
|Physician/Dentist
|-
|Healthcare
|-
|Lawyer/Judge
|-
|Professional/Technical
|-
|Management
|-
|Teacher/Educator
|-
|-
|1-2 years
|Sales/Marketing
|-
|-
|2-3 years
|Clerical/Service Worker
|-
|-
|3-4 years
|Tradesmen/Laborer
|-
|-
|4-5 years
|Farmer
|-
|-
|5-6 years
|Student
|-
|-
|6-7 years
|Homemaker
|-
|-
|7-8 years
|Retired
|-
|-
|8-9 years
|Federal Employee
|-
|-
|9-10 years
|Unknown
|-
|-
|10-11 years
|Military
|-
|-
|11-12 years
|Military Retired
|-
|-
|12-13 years
|Other
|-
|-
|13-14 years
|Business Owner
|-
|-
|14-15 years
|Religious
|-
|-
|15+ years
|Self Employed
|-
|-
|Unknown
|Financial
|}
|}


Line 949: Line 703:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"LengthOfResidence":"'''''string'''''"</code>
|JSON||<code>"Occupation":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><LengthOfResidence>'''''string'''''</LengthOfResidence></code>
|SOAP/XML||<code><Occupation>'''''string'''''</Occupation></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">Longitude</h3>
<h3 style="background-color:rgb(240,240,240);">Own Rent</h3>
:Returns the geocoded longitude for the address entered in the AddressLine field.
:Returns the individual's status as owner or renter of the property.
 
:{| class="alternate01"
!Value
|-
|Unknown
|-
|Definite Renter
|-
|Inferred Renter
|-
|Inferred Owner
|-
|Definite Owner
|}


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"Longitude":"'''''string'''''"</code>
|JSON||<code>"OwnRent":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><Longitude>'''''string'''''</Longitude></code>
|SOAP/XML||<code><OwnRent>'''''string'''''</OwnRent></code>
|}
|}




Revision as of 22:51, 26 June 2017

← Personator Consumer

Personator Consumer Navigation
Introduction
Basics
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
REST JSONP
REST XML
JSON
Batch JSON
XML
Batch XML
Result Codes
Result Code Use
Personator Consumer 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. Personator 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 Response Version
Transmission Reference TransmissionReference
Transmission Results TransmissionResults
Total Records TotalRecords
AddressDeliveryInstallation Record AddressDeliveryInstallation
AddressExtras AddressExtras
AddressHouseNumber AddressHouseNumber
AddressKey AddressKey
AddressLine1 AddressLine1
AddressLine2 AddressLine2
AddressLockBox AddressLockBox
AddressPostDirection AddressPostDirection
AddressPreDirection AddressPreDirection
AddressPrivateMailboxName AddressPrivateMailboxName
AddressPrivateMailboxRange AddressPrivateMailboxRange
AddressRouteService AddressRouteService
AddressStreetName AddressStreetName
AddressStreetSuffix AddressStreetSuffix
AddressSuiteName AddressSuiteName
AddressSuiteNumber AddressSuiteNumber
AddressTypeCode AddressTypeCode
AreaCode AreaCode
CBSACode CBSACode
CBSADivisionCode CBSADivisionCode
CBSADivisionLevel CBSADivisionLevel
CBSADivisionTitle CBSADivisionTitle
CBSALevel CBSALevel
CBSATitle CBSATitle
CarrierRoute CarrierRoute
CensusBlock CensusBlock
CensusKey CensusKey
CensusTract CensusTract
ChildrenAgeRange ChildrenAgeRange
City City
CityAbbreviation CityAbbreviation
CompanyName CompanyName
CongressionalDistrict CongressionalDistrict
CountryCode CountryCode
CountryName CountryName
CountyFIPS CountyFIPS
CountyName CountyName
CountySubdivisionCode CountySubdivisionCode
CountySubdivisionName CountySubdivisionName
CreditCardUser CreditCardUser
DateOfBirth DateOfBirth
DateOfDeath DateOfDeath
DeliveryIndicator DeliveryIndicator
DeliveryPointCheckDigit DeliveryPointCheckDigit
DeliveryPointCode DeliveryPointCode
DemographicsGender DemographicsGender
DemographicsResults DemographicsResults
DomainName DomainName
Education Education
ElementarySchoolDistrictCode ElementarySchoolDistrictCode
ElementarySchoolDistrictName ElementarySchoolDistrictName
EmailAddress EmailAddress
Gender Gender
Gender2 Gender2
HouseholdIncome HouseholdIncome
HouseholdSize HouseholdSize
Latitude Latitude
LengthOfResidence LengthOfResidence
Longitude Longitude
MailboxName MailboxName
MaritalStatus MaritalStatus
MelissaAddressKey MelissaAddressKey
MelissaAddressKeyBase MelissaAddressKeyBase
MoveDate MoveDate
NameFirst NameFirst
NameFirst2 NameFirst2
NameFull NameFull
NameLast NameLast
NameLast2 NameLast2
NameMiddle NameMiddle
NameMiddle2 NameMiddle2
NamePrefix NamePrefix
NamePrefix2 NamePrefix2
NameSuffix NameSuffix
NameSuffix2 NameSuffix2
NewAreaCode NewAreaCode
Occupation Occupation
OwnRent OwnRent
PhoneCountryCode PhoneCountryCode
PhoneCountryName PhoneCountryName
PhoneExtension PhoneExtension
PhoneNumber PhoneNumber
PhonePrefix PhonePrefix
PhoneSuffix PhoneSuffix
PlaceCode PlaceCode
PlaceName PlaceName
Plus4 Plus4
PoliticalParty PoliticalParty
PostalCode PostalCode
PresenceOfChildren PresenceOfChildren
PresenceOfSenior PresenceOfSenior
PrivateMailBox PrivateMailBox
RecordExtras RecordExtras
RecordID RecordID
Reserved Reserved
Results Results
Salutation Salutation
SecondarySchoolDistrictCode SecondarySchoolDistrictCode
SecondarySchoolDistrictName SecondarySchoolDistrictName
State State
StateDistrictLower StateDistrictLower
StateDistrictUpper StateDistrictUpper
StateName StateName
Suite Suite
TopLevelDomain TopLevelDomain
TypesOfVehicles TypesOfVehicles
UTC UTC
UnifiedSchoolDistrictCode UnifiedSchoolDistrictCode
UnifiedSchoolDistrictName UnifiedSchoolDistrictName
UrbanizationName UrbanizationName


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 Personator.
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 Personator 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.


AddressLine1

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax
JSON "AddressLine1":"string"
SOAP/XML <AddressLine1>string</AddressLine1>


AddressLine2

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Protocol Syntax
JSON "AddressLine2":"string"
SOAP/XML <AddressLine2>string</AddressLine2>


Appended Address Record Elements

AddressType

This is an appended string value that returns a one-character code for the type of address coded. This element works only for US and Canadian addresses.
Protocol Syntax
JSON "AddressType":"string"
SOAP/XML <AddressType>string</AddressType>


AddressKey

This is a string value that is a unique key for the address. Only for US and Canadian addresses.
The AddressKey can be used by other Melissa Data services, such as Geocoder or RBDI.
Protocol Syntax
JSON "AddressKey":"string"
SOAP/XML <AddressKey>string</AddressKey>

---



Latitude

Returns the geocoded latitude for the address entered in the AddressLine field.
Protocol Syntax
JSON "Latitude":"string"
SOAP/XML <Latitude>string</Latitude>


Length of Residence

Returns the range of the individual's length of residency in their current address.
Value
Less than 1 year
1-2 years
2-3 years
3-4 years
4-5 years
5-6 years
6-7 years
7-8 years
8-9 years
9-10 years
10-11 years
11-12 years
12-13 years
13-14 years
14-15 years
15+ years
Unknown
Protocol Syntax
JSON "LengthOfResidence":"string"
SOAP/XML <LengthOfResidence>string</LengthOfResidence>


Longitude

Returns the geocoded longitude for the address entered in the AddressLine field.
Protocol Syntax
JSON "Longitude":"string"
SOAP/XML <Longitude>string</Longitude>


Mailbox Name

Returns the parsed mailbox name for the email entered in the Email field.
Protocol Syntax
JSON "MailboxName":"string"
SOAP/XML <MailboxName>string</MailboxName>


Marital Status

Returns the individual's marital status.
Protocol Syntax
JSON "MaritalStatus":"string"
SOAP/XML <MaritalStatus>string</MaritalStatus>


Melissa Address Key

Returns a unique key associated with an address.
Protocol Syntax
JSON "MelissaAddressKey":"string"
SOAP/XML <MelissaAddressKey>string</MelissaAddressKey>


Melissa Address Key Base

Returns a unique key associated with a building containing multiple suites/apartments.
Protocol Syntax
JSON "MelissaAddressKeyBase":"string"
SOAP/XML <MelissaAddressKeyBase>string</MelissaAddressKeyBase>


Move Date

Returns the date associated with the move address.
Protocol Syntax
JSON "MoveDate":"string"
SOAP/XML <MoveDate>string</>MoveDate


Name First

Returns the first name in the FullName field.
Protocol Syntax
JSON "NameFirst":"string"
SOAP/XML <NameFirst>string</NameFirst>


Name First 2

Only used if 2 names are in the FullName field. Returns the second name in the FullName field.
Protocol Syntax
JSON "NameFirst2":"string"
SOAP/XML <NameFirst2>string</NameFirst2>


Name Full

Returns the full name for the record.
Protocol Syntax
JSON "NameFull":"string"
SOAP/XML <NameFull>string</NameFull>


Name Last

Returns the last name in the FullName field.
Protocol Syntax
JSON "NameLast":"string"
SOAP/XML <NameLast>string</NameLast>


Name Last 2

Only used if 2 names are in the FullName field. Returns a last name for the second name in the FullName field.
Protocol Syntax
JSON "NameLast2":"string"
SOAP/XML <NameLast2>string</NameLast2>


Name Middle

Returns a middle name for the name in the FullName field.
Protocol Syntax
JSON "NameMiddle":"string"
SOAP/XML <NameMiddle>string</NameMiddle>


Name Middle 2

Only used if 2 names are in the FullName field. Returns a middle name for the second name in the FullName field.
Protocol Syntax
JSON "NameMiddle2":"string"
SOAP/XML <NameMiddle2>string</NameMiddle2>


Name Prefix

Returns a prefix for the name in the FullName field.
Protocol Syntax
JSON "NamePrefix":"string"
SOAP/XML <NamePrefix>string</NamePrefix>


Name Prefix 2

Only used if 2 names are in the FullName field. Returns a prefix for the second name in the FullName field.
Protocol Syntax
JSON "NamePrefix2":"string"
SOAP/XML <NamePrefix2>string</NamePrefix2>


Name Suffix

Returns a suffix for the name in the FullName field.
Protocol Syntax
JSON "NameSuffix":"string"
SOAP/XML <NameSuffix>string</NameSuffix>


Name Suffix 2

Only used if 2 names are in the FullName field. Returns a suffix for the second name in the FullName field.
Protocol Syntax
JSON "NameSuffix2":"string"
SOAP/XML <NameSuffix2>string</NameSuffix2>


New Area Code

Returns the parsed new area code for the phone number entered in the Phone field.
Protocol Syntax
JSON "NewAreaCode":"string"
SOAP/XML <NewAreaCode>string</NewAreaCode>


Occupation

Returns the category for the individual's occupation.
Value
Physician/Dentist
Healthcare
Lawyer/Judge
Professional/Technical
Management
Teacher/Educator
Sales/Marketing
Clerical/Service Worker
Tradesmen/Laborer
Farmer
Student
Homemaker
Retired
Federal Employee
Unknown
Military
Military Retired
Other
Business Owner
Religious
Self Employed
Financial
Protocol Syntax
JSON "Occupation":"string"
SOAP/XML <Occupation>string</Occupation>


Own Rent

Returns the individual's status as owner or renter of the property.
Value
Unknown
Definite Renter
Inferred Renter
Inferred Owner
Definite Owner
Protocol Syntax
JSON "OwnRent":"string"
SOAP/XML <OwnRent>string</OwnRent>


Phone Country Code

Returns the 2 character country code for the phone number entered in the Phone field.
Protocol Syntax
JSON "PhoneCountryCode":"string"
SOAP/XML <PhoneCountryCode>string</PhoneCountryCode>


Phone Country Name

Returns the full country name for the phone number entered in the Phone field.
Protocol Syntax
JSON "PhoneCountryName":"string"
SOAP/XML <PhoneCountryName>string</PhoneCountryName>


Phone Extension

Returns the parsed extension for the phone number entered in the Phone field.
Protocol Syntax
JSON "PhoneExtension":"string"
SOAP/XML <PhoneExtension>string</PhoneExtension>


Phone Number

Returns the standardized phone number for the record.
Protocol Syntax
JSON "PhoneNumber":"string"
SOAP/XML <PhoneNumber>string</PhoneNumber>


Phone Prefix

Returns the parsed prefix for the phone number entered in the Phone field.
Protocol Syntax
JSON "PhonePrefix":"string"
SOAP/XML <PhonePrefix>string</PhonePrefix>


Phone Suffix

Returns the parsed suffix for the phone number entered in the Phone field.
Protocol Syntax
JSON "PhoneSuffix":"string"
SOAP/XML <PhoneSuffix>string</PhoneSuffix>


Place Code

When ZIP codes overlap, the City field will always return the city that covers most of the ZIP area. If the address is located outside of that city but within the ZIP Code, Place Code will refer to that area.
Protocol Syntax
JSON "PlaceCode":"string"
SOAP/XML <PlaceCode>string</PlaceCode>


Place Name

When ZIP codes overlap, the City field will always return the city that covers most of the ZIP area. If the address is located outside of that city but within the ZIP Code, Place Name will refer to that area.
Protocol Syntax
JSON "PlaceName":"string"
SOAP/XML <PlaceName>string</PlaceName>


Plus 4

Returns the 4-digit plus4 for the input address. If this column is requested, the PostalCode field will only contain the 5-digit ZIP for U.S. addresses.
Protocol Syntax
JSON "Plus4":"string"
SOAP/XML <Plus4>string</Plus4>


!!!Political Party


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


Postal Code

Returns the 9-digit postal code for U.S. addresses and 6-digit postal code for Canadian addresses.
Protocol Syntax
JSON "PostalCode":"string"
SOAP/XML <PostalCode>string</PostalCode>


Presence Of Children

Returns the presence of children in the household.
Protocol Syntax
JSON "PresenceOfChildren":"string"
SOAP/XML <PresenceOfChildren>string</PresenceOfChildren>


Presence Of Senior

Returns the presence of seniors in the household.
Protocol Syntax
JSON "PresenceOfSenior":"string"
SOAP/XML <PresenceOfSenior>string</PresenceOfSenior>


Private MailBox

Returns the private mail box number for the address in the AddressLine field, if any. Private mailboxes are private mail boxes in commercial mail receiving agencies, like a UPS Store. If requested, the Private mailbox will be populated in this field instead of the Address field.
Protocol Syntax
JSON "PrivateMailBox":"string"
SOAP/XML <PrivateMailBox>string</PrivateMailBox>


!!!Record Extras


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


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>


!!!Reserved


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


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 Personator Result Codes.
Protocol Syntax
JSON "Results":"string"
SOAP/XML <Results>string</Results>


Salutation

Returns a salutation for the name in the FullName field.
Protocol Syntax
JSON "Salutation":"string"
SOAP/XML <Salutation>string</>Salutation


Secondary School District Code

Returns a 5 digit string representing the Secondary School District Code for the requested record.
Protocol Syntax
JSON "SecondarySchoolDistrictCode":"string"
SOAP/XML <SecondarySchoolDistrictCode>string</SecondarySchoolDistrictCode>


Secondary School District Name

Returns the Secondary School District Name for the requested record.
Protocol Syntax
JSON "SecondarySchoolDistrictName":"string"
SOAP/XML <SecondarySchoolDistrictName>string</SecondarySchoolDistrictName>


State

Returns the state for the record.
Protocol Syntax
JSON "State":"string"
SOAP/XML <State>string</State>


State District Lower

Returns a 3 digit string representing the Lower State District Code for the requested record.
Protocol Syntax
JSON "StateDistrictLower":"string"
SOAP/XML <StateDistrictLower>string</StateDistrictLower>


State District Upper

Returns a 3 digit string representing the Upper State District Code for the requested record.
Protocol Syntax
JSON "StateDistrictUpper":"string"
SOAP/XML <StateDistrictUpper>string</StateDistrictUpper>


State Name

Returns the full name of the state entered in the State field.
Protocol Syntax
JSON "StateName":"string"
SOAP/XML <StateName>string</StateName>


Suite

Returns the suite for the address in the AddressLine field, if any. If requested, the suite will be populated in this field instead of the Address field.
Protocol Syntax
JSON "Suite":"string"
SOAP/XML <Suite>string</Suite>


Top Level Domain

Returns the parsed top-level domain name for the email entered in the Email field.
Protocol Syntax
JSON "TopLevelDomain":"string"
SOAP/XML <TopLevelDomain>string</TopLevelDomain>


!!!Types Of Vehicles

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


UTC

Returns the time zone of the requested record. All Melissa Data products express time zones in UTC (Coordinated Universal Time).
Protocol Syntax
JSON "UTC":"string"
SOAP/XML <UTC>string</UTC>


Unified School District Code

Returns a 5 digit string representing the Unified School District Code for the requested record.
Protocol Syntax
JSON "UnifiedSchoolDistrictCode":"string"
SOAP/XML <UnifiedSchoolDistrictCode>string</UnifiedSchoolDistrictCode>


Unified School District Name

Returns the Secondary Unified District Name for the requested record.
Protocol Syntax
JSON "UnifiedSchoolDistrictName":"string"
SOAP/XML <UnifiedSchoolDistrictName>string</UnifiedSchoolDistrictName>


UrbanizationName

Returns the urbanization name for the address entered in the AddressLine field. Usually only used if the address is in Puerto Rico.
Protocol Syntax
JSON "UrbanizationName":"string"
SOAP/XML <UrbanizationName>string</UrbanizationName>





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