Admin at 17:34, 11 July 2018

2018-07-11T17:34:19Z

← Older revision		Revision as of 17:34, 11 July 2018
Line 342:		Line 342:
	==CurrentAddress/PreviousAddressRecords==		==CurrentAddress/PreviousAddressRecords==
	<h3 style="background-color:rgb(240,240,240);">AddressLine1</h3>		<h3 style="background-color:rgb(240,240,240);">AddressLine1</h3>
	:This is a string values of the first ~~addres~~ line.		:This is a string values of the first address line.

	:{\| class="alternate01"		:{\| class="alternate01"

Admin at 17:06, 3 May 2017

2017-05-03T17:06:52Z

← Older revision		Revision as of 17:06, 3 May 2017
Line 45:		Line 45:
	\|Current Address \|\| CurrentAddress		\|Current Address \|\| CurrentAddress
	\|-		\|-
	\|Previous Address ~~Records~~ \|\| ~~PreviousAddressRecords~~		\|Previous Address \|\| PreviousAddress
	\|-		\|-
	\|Phone Records \|\| PhoneRecords		\|Phone Records \|\| PhoneRecords
Line 267:		Line 267:


	<h3 style="background-color:rgb(240,240,240);">~~PreviousAddressRecords~~</h3>		<h3 style="background-color:rgb(240,240,240);">PreviousAddress</h3>
	:This returns an array of records for the previous address ~~records~~, containing the following fields:		:This returns an array of records for the previous address, containing the following fields:

	::{\| class="alternate01"		::{\| class="alternate01"

Admin at 18:56, 20 March 2017

2017-03-20T18:56:53Z

Show changes

Admin at 23:50, 14 March 2017

2017-03-14T23:50:31Z

Show changes

Admin: 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 ..."

2017-03-14T23:37:52Z

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

New page

{{PersonatorSearchNav
|InputOutputCollapse=
}}

{{CustomTOC}}

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.

{| class="alternate01 sortable"
!Field Name !! Level !! JSON
|-
|Transmission Reference ||rowspan="6" valign="center"| Response (Base) || TransmissionReference
|-
|Transmission Results || TransmissionResults
|-
|Total Records || TotalRecords
|-
|Total Pages || TotalPages
|-
|Results || Results
|-
|Version || Version
|-
|Records ||rowspan="6" valign="center"| Record || Results
|-
|Current Address || CurrentAddress
|-
|Full Name || FullName
|-
|First Name || FirstName
|-
|Last Name || LastName
|-
|Middle Name || MiddleName
|-
|Date of Birth || DateOfBirth
|-
|Date of Death || DateOfDeath
|-
|Record ID || RecordID
|-
|Results || Results
|-
|Address Line 1 ||rowspan="" 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
|-

|}

==Response Elements==
The following fields are in the response.

==Response (Base Level)==
<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.

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

<h3 style="background-color:rgb(240,240,240);">Results</h3>
: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 [[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);">Version</h3>
:This is a string value that is the current revision number of Personator Search web service.

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

==Identity==
<h3 style="background-color:rgb(240,240,240);">Results</h3>
: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"
!Protocol !! Syntax
|-
|JSON||<code>"Results":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">DateOfBirth</h3>
:A string value containing the input date of birth returned as is.

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

==Name==
<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.

:For a complete list of 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);">Company</h3>
:This is a string value of the standardized company name.

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

<h3 style="background-color:rgb(240,240,240);">NameFirst</h3>
:This is a string value of the first name from an inputted full 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"
!Protocol !! Syntax
|-
|JSON||<code>"NameFirst":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">NameLast</h3>
:This is a string value of the last name from an inputted full 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"
!Protocol !! Syntax
|-
|JSON||<code>"NameLast":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AddressLine1</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>"AddressLine1":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">AddressLine2</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>"AddressLine2":"'''''string'''''"</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>
|}

<h3 style="background-color:rgb(240,240,240);">CountryCode</h3>
:This is a string value that is the parsed CountryCode element from the input.

:For example:

:{| class="alternate01"
!Country !! Code
|-
|United States||US
|-
|Canada||CA
|-
|Philippines||PH
|}

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

<h3 style="background-color:rgb(240,240,240);">PostBox</h3>
:This is a string value that is the parsed PostBox element from the input.

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

==Email==
<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.

:For a complete list of 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);">Email Address</h3>
:This is a string value listing the email address, including any corrections or changes made by Global Email.

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

==Phone==
<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.

:For a complete list of 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);">Phone Number</h3>
:This is a string value of the standardized phone number after a successful call to the service.

: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" cellspacing="0"
!Input Phone!!Input Country!!Input Country of Origin!!Phone Returned
|-
|495-728-5802||RU||RU||495-728-5802
|-
| +7 495-728-5802||RU||RU||495-728-5802
|-
| +1 495-728-5802||RU||RU||495-728-5802
|}

: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"
!Input Phone!!Input Country!!Input Country of Origin!!Phone Returned
|-
|495-728-5802||RU||US|| +7 495-728-5802
|-
| +7 495-728-5802||RU||US|| +7 495-728-5802
|-
| +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"
!Input Phone!!Input Country!!Input Country of Origin!!Phone Returned
|-
|495-728-5802||RU||<blank>||495-728-5802
|-
| +7 495-728-5802||RU||<blank>|| +7 495-728-5802
|-
| +1 495-728-5802||RU||<blank>|| +7 495-728-5802
|}

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

[[Category:Personator Search]]
[[Category:Reference]]

Personator Search:Response - Revision history

Admin at 17:34, 11 July 2018

Admin at 17:06, 3 May 2017

Admin at 18:56, 20 March 2017

Admin at 23:50, 14 March 2017

Admin: 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 ..."