Difference between revisions of "Personator Search:Response"

From Melissa Data Wiki
Jump to navigation Jump to search
(Created page with "{{PersonatorSearchNav |InputOutputCollapse= }} {{CustomTOC}} A response is the result of a request. This consists of returned result codes. The web service returns back a ...")
 
 
(3 intermediate revisions by the same user not shown)
Line 17: Line 17:
!Field Name !! Level !! JSON
!Field Name !! Level !! JSON
|-
|-
|Transmission Reference ||rowspan="6" valign="center"| Response (Base) || TransmissionReference
|Results ||rowspan="6" valign="center"| Response (Base) || Results
|-
|-
|Transmission Results || TransmissionResults
|Transmission Results || TransmissionResults
|-
|-
|Total Records || TotalRecords
|Transmission Reference || TransmissionReference
|-
|-
|Total Pages || TotalPages
|Total Pages || TotalPages
|-
|-
|Results || Results
|Total Records || TotalRecords
|-
|-
|Version || Version
|Version || Version
|-
|-
|Records ||rowspan="6" valign="center"| Record || Results
|Record ID ||rowspan="11" valign="center"| Record || RecordID
|-
|-
|Current Address || CurrentAddress
|Results || Results
|-
|-
|Full Name || FullName
|Full Name || FullName
Line 38: Line 38:
|-
|-
|Last Name || LastName
|Last Name || LastName
|-
|Middle Name || MiddleName
|-
|-
|Date of Birth || DateOfBirth
|Date of Birth || DateOfBirth
Line 45: Line 43:
|Date of Death || DateOfDeath
|Date of Death || DateOfDeath
|-
|-
|Record ID || RecordID
|Current Address || CurrentAddress
|-
|-
|Results || Results
|Previous Address || PreviousAddress
|-
|Phone Records || PhoneRecords
|-
|Email Records || EmailRecords
|-
|Address Line 1 ||rowspan="9" valign="center"| CurrentAddress || AddressLine1
|-
|Suite || Suite
|-
|City || City
|-
|State || State
|-
|Postal Code || PostalCode
|-
|Plus4 || Plus4
|-
|Melissa Address Key || MelissaAddressKey
|-
|Melissa Address Key Base || MelissaAddressKeyBase
|-
|Move Date || MoveDate
|-
|-
|Address Line 1 ||rowspan="" valign="center"| CurrentAddress || AddressLine1
|Address Line 1 ||rowspan="9" valign="center"| PreviousAddressRecords || AddressLine1
|-
|-
|Suite || Suite
|Suite || Suite
Line 67: Line 87:
|Move Date || MoveDate
|Move Date || MoveDate
|-
|-
 
|Phone || PhoneRecords || Phone
|-
|Email || EmailRecords || Email
|}
|}


Line 76: Line 98:


==Response (Base Level)==
==Response (Base Level)==
<h3 style="background-color:rgb(240,240,240);">Results</h3>
:This is a string value that lists result codes for the most recent request as a whole.
For a complete list of result codes, see [[Result Code Details#Personator Search|Personator Search Result Codes]].
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Results":"'''''string'''''"</code>
|}
<h3 style="background-color:rgb(240,240,240);">TransmissionResults</h3>
:This is a string value that lists result codes from the web service. For a complete list of result codes, see [[Result Code Details#Personator Search|Personator Search Result Codes]].
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionResults":"'''''string'''''"</code>
|}
<h3 style="background-color:rgb(240,240,240);">TransmissionReference</h3>
<h3 style="background-color:rgb(240,240,240);">TransmissionReference</h3>
:This is a string value that serves as a unique identifier for this request. It is returned as sent in the request, allowing you to match the response to the request.
:This is a string value that serves as a unique identifier for this request. It is returned as sent in the request, allowing you to match the response to the request.
Line 86: Line 129:




<h3 style="background-color:rgb(240,240,240);">Results</h3>
<h3 style="background-color:rgb(240,240,240);">TotalPages</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 containing the number of total pages returned by the request. The amount of records per page is set with the [[Personator Search:Request#RecordsPerPage|RecordsPerPage]] option.
For a complete list of error codes, see [[Result Code Details#Personator Search|Personator Search Result Codes]].


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"Results":"'''''string'''''"</code>
|JSON||<code>"TotalPages":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">Version</h3>
<h3 style="background-color:rgb(240,240,240);">TotalRecords</h3>
:This is a string value that is the current revision number of Personator Search web service.
:This is a string value containing the number of total records returned by the request, up to a maximum of 500.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"Version":"'''''string'''''"</code>
|JSON||<code>"TotalRecords":"'''''string'''''"</code>
|}
|}




==Identity==
<h3 style="background-color:rgb(240,240,240);">Version</h3>
<h3 style="background-color:rgb(240,240,240);">Results</h3>
:This is a string value that is the current revision number of Personator Search web service.
:This is a string value that lists the ID verification codes (KV*).
 
:For a complete list of ID verification codes, see [[Result Code Details#Personator Search|Personator Search Result Codes]].


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"Results":"'''''string'''''"</code>
|JSON||<code>"Version":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">DateOfBirth</h3>
==Record==
:A string value containing the input date of birth returned as is.
<h3 style="background-color:rgb(240,240,240);">RecordID</h3>
:This is a string value containing the record ID for the current record.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"DateOfBirth":"'''''string'''''"</code>
|JSON||<code>"RecordID":"'''''string'''''"</code>
|}
|}




==Name==
<h3 style="background-color:rgb(240,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 that lists result codes for the current record.


:For a complete list of codes, see [[Result Code Details#Personator Search|Personator Search Result Codes]].
:For a complete list of result codes, see [[Result Code Details#Personator Search|Personator Search Result Codes]].


:{| class="alternate01"
:{| class="alternate01"
Line 143: Line 182:




<h3 style="background-color:rgb(240,240,240);">Company</h3>
<h3 style="background-color:rgb(240,240,240);">FullName</h3>
:This is a string value of the standardized company name.
:This is a string value of the full name.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"Company":"'''''string'''''"</code>
|JSON||<code>"FullName":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">NameFirst</h3>
<h3 style="background-color:rgb(240,240,240);">FirstName</h3>
:This is a string value of the first name from an inputted full name.
:This is a string value of the first name.
 
:If the FullName input property contained a single name, the first name, if any, will be returned here. If two names were passed, the first of the two first names will be returned by this property.


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




<h3 style="background-color:rgb(240,240,240);">NameLast</h3>
<h3 style="background-color:rgb(240,240,240);">LastName</h3>
:This is a string value of the last name from an inputted full name.
:This is a string value of the last name.
 
:If the FullName input property contained a single name, the last name, if any, will be returned here. If two names were passed, the first of the two last names will be returned by this property.


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




<h3 style="background-color:rgb(240,240,240);">AddressLine1</h3>
<h3 style="background-color:rgb(240,240,240);">DateOfBirth</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.
:This is a string value of the date of birth of the individual. Format should be YYYYMM.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"AddressLine1":"'''''string'''''"</code>
|JSON||<code>"DateOfBirth":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">AddressLine2</h3>
<h3 style="background-color:rgb(240,240,240);">DateOfDeath</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.
:This is a string value of the date of death of the individual. Format should be YYYYMM.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"AddressLine2":"'''''string'''''"</code>
|JSON||<code>"DateOfDeath":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">PostalCode</h3>
<h3 style="background-color:rgb(240,240,240);">CurrentAddress</h3>
:This is a string value that is the standardized contents of the PostalCode element.
:This returns an array of records for the current address, containing the following fields:
 
::{| class="alternate01"
!Field Name
|-
|Address Line 1
|-
|Suite
|-
|City
|-
|State
|-
|Postal Code
|-
|Plus4
|-
|Melissa Address Key
|-
|Melissa Address Key Base
|-
|Move Date
|}
 
:For more information on these fields, see [[#CurrentAddress/PreviousAddressRecords|CurrentAddress/PreviousAddressRecords]] below.
 


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"PostalCode":"'''''string'''''"</code>
|JSON||<code>"CurrentAddress":{'''''array'''''}</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">CountryCode</h3>
<h3 style="background-color:rgb(240,240,240);">PreviousAddress</h3>
:This is a string value that is the parsed CountryCode element from the input.
:This returns an array of records for the previous address, containing the following fields:


:For example:
::{| class="alternate01"
 
!Field Name
:{| class="alternate01"
|-
!Country !! Code
|Address Line 1
|-
|Suite
|-
|City
|-
|State
|-
|Postal Code
|-
|Plus4
|-
|-
|United States||US
|Melissa Address Key
|-
|-
|Canada||CA
|Melissa Address Key Base
|-
|-
|Philippines||PH
|Move Date
|}
|}
:For more information on these fields, see [[#CurrentAddress/PreviousAddressRecords|CurrentAddress/PreviousAddressRecords]] below.




Line 226: Line 298:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"CountryCode":"'''''string'''''"</code>
|JSON||<code>"PreviousAddressRecords":{'''''array'''''}</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">PostBox</h3>
<h3 style="background-color:rgb(240,240,240);">PhoneRecords</h3>
:This is a string value that is the parsed PostBox element from the input.
:This returns an array of phone records, containing the following field:
 
::{| class="alternate01"
!Field Name
|-
|Phone
|}
 
:For more information on this field, see [[#Phone|Phone]] below.
 


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




==Email==
<h3 style="background-color:rgb(240,240,240);">EmailRecords</h3>
<h3 style="background-color:rgb(240,240,240);">Results</h3>
:This returns an array of email records, containing the following field:
:This is a string value with comma delimited status, error codes, and change codes for the record.
 
::{| class="alternate01"
!Field Name
|-
|Email
|}
 
:For more information on this field, see [[#Email|Email]] below.


:For a complete list of codes, see [[Result Code Details#Personator Search|Personator Search Result Codes]].


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"Results":"'''''string'''''"</code>
|JSON||<code>"EmailRecords":{'''''array'''''}</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">Email Address</h3>
==CurrentAddress/PreviousAddressRecords==
:This is a string value listing the email address, including any corrections or changes made by Global Email.
<h3 style="background-color:rgb(240,240,240);">AddressLine1</h3>
:This is a string values of the first address line.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"EmailAddress":"'''''string'''''"</code>
|JSON||<code>"AddressLine1":"'''''string'''''"</code>
|}
|}




==Phone==
<h3 style="background-color:rgb(240,240,240);">Suite</h3>
<h3 style="background-color:rgb(240,240,240);">Results</h3>
:This is a string value of the suite.
:This is a string value with comma delimited status, error codes, and change codes for the record.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Suite":"'''''string'''''"</code>
|}
 


:For a complete list of codes, see [[Result Code Details#Personator Search|Personator Search Result Codes]].
<h3 style="background-color:rgb(240,240,240);">City</h3>
:This is a string value of the city.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"Results":"'''''string'''''"</code>
|JSON||<code>"City":"'''''string'''''"</code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">Phone Number</h3>
<h3 style="background-color:rgb(240,240,240);">State</h3>
:This is a string value of the standardized phone number after a successful call to the service.
:This is a string value of the state.


:The phone number will return in varying formats depending on the inputs. If the inputted country and country of origin are the same the returned number will include the National Destination Code + Subscriber Number. For example:
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"State":"'''''string'''''"</code>
|}


:{|class="alternate01" cellspacing="0"
 
!Input Phone!!Input Country!!Input Country of Origin!!Phone Returned
<h3 style="background-color:rgb(240,240,240);">PostalCode</h3>
:This is a string value of the ZIP/Postal Code.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|495-728-5802||RU||RU||495-728-5802
|JSON||<code>"PostalCode":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Plus4</h3>
:This is a string value of the Plus4 of the address.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
| +7 495-728-5802||RU||RU||495-728-5802
|JSON||<code>"Plus4":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">MelissaAddressKey</h3>
:This is a string value of the Melissa Address Key, a unique key assigned to this address record.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
| +1 495-728-5802||RU||RU||495-728-5802
|JSON||<code>"MelissaAddressKey":"'''''string'''''"</code>
|}
|}


:If the inputted country and country of origin differ, the returned number  will include a leading ‘+’ followed by the Country Code + National Destination Code + Subscriber Number. The leading ‘+’ represents the International Prefix that is required to dial a number outside of the caller’s country. For example:


:{|class="alternate01" cellspacing="0"
<h3 style="background-color:rgb(240,240,240);">MelissaAddressKeyBase</h3>
!Input Phone!!Input Country!!Input Country of Origin!!Phone Returned
:This is a string value of the Melissa Address Key Base, a unique key assigned to the base address of a complex with apartments or suites.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|495-728-5802||RU||US|| +7 495-728-5802
|JSON||<code>"MelissaAddressKeyBase":"'''''string'''''"</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">MoveDate</h3>
:This is a string value of the move date associated with this individual and '''previous address'''.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
| +7 495-728-5802||RU||US|| +7 495-728-5802
|JSON||<code>"MoveDate":"'''''string'''''"</code>
|-
| +1 495-728-5802||RU||US|| +7 495-728-5802
|}
|}


:If a country is entered and a country of origin is left blank or not passed in, the returned number will match the format of the inputted phone number. For example:


:{|class="alternate01" cellspacing="0"
==PhoneRecords==
!Input Phone!!Input Country!!Input Country of Origin!!Phone Returned
<h3 style="background-color:rgb(240,240,240);">Phone</h3>
|-
:This is a string value listing the phone number.
|495-728-5802||RU||<blank>||495-728-5802
 
|-
:{| class="alternate01"
| +7 495-728-5802||RU||<blank>|| +7 495-728-5802
!Protocol !! Syntax
|-
|-
| +1 495-728-5802||RU||<blank>|| +7 495-728-5802
|JSON||<code>"Phone":"'''''string'''''"</code>
|}
|}


==EmailRecords==
<h3 style="background-color:rgb(240,240,240);">Email</h3>
:This is a string value listing the email address.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"PhoneNumber":"'''''string'''''"</code>
|JSON||<code>"Email":"'''''string'''''"</code>
|}
|}


Latest revision as of 17:34, 11 July 2018

← Personator Search

Personator Search Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
Result Codes
Result Code Use
Personator Search Result Codes
Sample Code



A response is the result of a request. This consists of returned result codes.

The web service returns back a response in a JSON format.


Field Names

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

Field Name Level JSON
Results Response (Base) Results
Transmission Results TransmissionResults
Transmission Reference TransmissionReference
Total Pages TotalPages
Total Records TotalRecords
Version Version
Record ID Record RecordID
Results Results
Full Name FullName
First Name FirstName
Last Name LastName
Date of Birth DateOfBirth
Date of Death DateOfDeath
Current Address CurrentAddress
Previous Address PreviousAddress
Phone Records PhoneRecords
Email Records EmailRecords
Address Line 1 CurrentAddress AddressLine1
Suite Suite
City City
State State
Postal Code PostalCode
Plus4 Plus4
Melissa Address Key MelissaAddressKey
Melissa Address Key Base MelissaAddressKeyBase
Move Date MoveDate
Address Line 1 PreviousAddressRecords AddressLine1
Suite Suite
City City
State State
Postal Code PostalCode
Plus4 Plus4
Melissa Address Key MelissaAddressKey
Melissa Address Key Base MelissaAddressKeyBase
Move Date MoveDate
Phone PhoneRecords Phone
Email EmailRecords Email


Response Elements

The following fields are in the response.


Response (Base Level)

Results

This is a string value that lists result codes for the most recent request as a whole.

For a complete list of result codes, see Personator Search Result Codes.

Protocol Syntax
JSON "Results":"string"


TransmissionResults

This is a string value that lists result codes from the web service. For a complete list of result codes, see Personator Search Result Codes.
Protocol Syntax
JSON "TransmissionResults":"string"


TransmissionReference

This is a string value that serves as a unique identifier for this request. It is returned as sent in the request, allowing you to match the response to the request.
Protocol Syntax
JSON "TransmissionReference":"string"


TotalPages

This is a string value containing the number of total pages returned by the request. The amount of records per page is set with the RecordsPerPage option.
Protocol Syntax
JSON "TotalPages":"string"


TotalRecords

This is a string value containing the number of total records returned by the request, up to a maximum of 500.
Protocol Syntax
JSON "TotalRecords":"string"


Version

This is a string value that is the current revision number of Personator Search web service.
Protocol Syntax
JSON "Version":"string"


Record

RecordID

This is a string value containing the record ID for the current record.
Protocol Syntax
JSON "RecordID":"string"


Results

This is a string value that lists result codes for the current record.
For a complete list of result codes, see Personator Search Result Codes.
Protocol Syntax
JSON "Results":"string"


FullName

This is a string value of the full name.
Protocol Syntax
JSON "FullName":"string"


FirstName

This is a string value of the first name.
Protocol Syntax
JSON "FirstName":"string"


LastName

This is a string value of the last name.
Protocol Syntax
JSON "LastName":"string"


DateOfBirth

This is a string value of the date of birth of the individual. Format should be YYYYMM.
Protocol Syntax
JSON "DateOfBirth":"string"


DateOfDeath

This is a string value of the date of death of the individual. Format should be YYYYMM.
Protocol Syntax
JSON "DateOfDeath":"string"


CurrentAddress

This returns an array of records for the current address, containing the following fields:
Field Name
Address Line 1
Suite
City
State
Postal Code
Plus4
Melissa Address Key
Melissa Address Key Base
Move Date
For more information on these fields, see CurrentAddress/PreviousAddressRecords below.


Protocol Syntax
JSON "CurrentAddress":{array}


PreviousAddress

This returns an array of records for the previous address, containing the following fields:
Field Name
Address Line 1
Suite
City
State
Postal Code
Plus4
Melissa Address Key
Melissa Address Key Base
Move Date
For more information on these fields, see CurrentAddress/PreviousAddressRecords below.


Protocol Syntax
JSON "PreviousAddressRecords":{array}


PhoneRecords

This returns an array of phone records, containing the following field:
Field Name
Phone
For more information on this field, see Phone below.


Protocol Syntax
JSON "PhoneRecords":{array}


EmailRecords

This returns an array of email records, containing the following field:
Field Name
Email
For more information on this field, see Email below.


Protocol Syntax
JSON "EmailRecords":{array}


CurrentAddress/PreviousAddressRecords

AddressLine1

This is a string values of the first address line.
Protocol Syntax
JSON "AddressLine1":"string"


Suite

This is a string value of the suite.
Protocol Syntax
JSON "Suite":"string"


City

This is a string value of the city.
Protocol Syntax
JSON "City":"string"


State

This is a string value of the state.
Protocol Syntax
JSON "State":"string"


PostalCode

This is a string value of the ZIP/Postal Code.
Protocol Syntax
JSON "PostalCode":"string"


Plus4

This is a string value of the Plus4 of the address.
Protocol Syntax
JSON "Plus4":"string"


MelissaAddressKey

This is a string value of the Melissa Address Key, a unique key assigned to this address record.
Protocol Syntax
JSON "MelissaAddressKey":"string"


MelissaAddressKeyBase

This is a string value of the Melissa Address Key Base, a unique key assigned to the base address of a complex with apartments or suites.
Protocol Syntax
JSON "MelissaAddressKeyBase":"string"


MoveDate

This is a string value of the move date associated with this individual and previous address.
Protocol Syntax
JSON "MoveDate":"string"


PhoneRecords

Phone

This is a string value listing the phone number.
Protocol Syntax
JSON "Phone":"string"


EmailRecords

Email

This is a string value listing the email address.
Protocol Syntax
JSON "Email":"string"
Retrieved from "http://wiki.melissadata.com/index.php?title=Personator_Search:Response&oldid=14869"