Personator Search:Response

← Personator Search

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