Personator Search:Request

From Melissa Data Wiki
Revision as of 23:45, 13 March 2017 by Admin (talk | contribs)
Jump to navigation Jump to search

← 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 request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your Customer ID (License Key) and the fields listed as Required below.

The web service supports REST and JSON protocols.


Field Names

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

Field Name REST
Transmission Reference t
License id
Options opt
Columns cols
Free Form ff
Full Name full
First Name first
Last Name last
Company comp
Address Line 1 a1
Address Line 2 a2
City city
State state
Postal postal
Country ctry
Phone Number phone
Email Address email
Melissa Address Key (MAK) mak


Request Elements

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

Transmission Reference

Optional.
This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Protocol Syntax
REST ?t = string


License

Required.
This is a string value containing the License Key issued to the customer by Melissa Data for the web service.
If this element is absent, the web service will return an error. To receive a License Key, please contact your Melissa Data sales representative at 1-800-MELISSA.
Protocol Syntax
REST &id = string


Options

Optional.
Specifies the options/
Protocol Syntax
REST &opt = string


List options in the following format, with multiple options delimited with a ",".
Syntax
OptionName:Parameter,OptionName:Parameter


SearchType

This options allows you to specify the type of search to perform.
Option Name Parameter Description
SearchType Auto Default. Performs name, address, email, and phone searches until one or more matches are found.
NameSearch Uses name data as the primary pivot when verifying or appending information.
AddressSearch Uses address data as the primary pivot when verifying or appending information.
EmailSearch Uses email data as the primary pivot when verifying or appending information.
PhoneSearch Uses phone data as the primary pivot when verifying or appending information.
SmartSearch
StraightSearch


MaxEmail

Option Name Parameter Description
' Default. .


MaxPhone

Option Name Parameter Description
' Default. .


Page

Option Name Parameter Description
' Default. .


ReturnAllPages

Option Name Parameter Description
' Default. .


SortBy

Option Name Parameter Description
' Default. .


SearchConditions

Option Name Parameter Description
' Default. .


Columns

Optional.
Specifies which column(s) to be output as a column delimited string.
Protocol Syntax
REST &cols = string

Entering the column name to return the column. Specifying a group name will return all columns in the group.

Field Name Default Group Groups GrpAll
FullName [DEFAULT]
Returned by default.
N/A GrpAll
FirstName
LastName
AddressLine1 PreviousAddress
AddressLine2
Suite
City
State
PostalCode
Suite
Plus4
MelissaAddressKey
MelissaAddressKeyBase
Phone N/A Phone
Email Email
MoveDate MoveDate
DateOfDeath DateOfDeath
DateOfBirth DateOfBirth
Sources* Sources


Free Form

Optional.
Accepts delimited or undelimited free form input. This will be parsed by the service.
Protocol Syntax
REST &ff = string


Full Name

Recommended.
The full name.
Protocol Syntax
REST &full = string


First Name

Optional.
The first name.
Protocol Syntax
REST &first = string


Last Name

Optional.
The last name.
Protocol Syntax
REST &last = string


Company

Optional.
The company/organization name.
Protocol Syntax
REST &comp = string


Address Line 1

Optional.
The input field for the address. This should contain the delivery address information (house number, street, building, suite, etc.) but should not contain locality information (city, state, postal code, etc.) which have their own inputs.
Protocol Syntax
REST &a1 = string


Address Line 2

Optional.
The input field for the address. This should contain the delivery address information (house number, street, building, suite, etc.) but should not contain locality information (city, state, postal code, etc.) which have their own inputs.
Protocol Syntax
REST &a2 = string


City

Optional.
The city.
Protocol Syntax
REST &city = string


State

Optional.
The US state.
Protocol Syntax
REST &state = string


Postal

Optional.
The postal code.
Protocol Syntax
REST &postal = string


Country

Optional.
The country name, abbreviation, or code.
Protocol Syntax
REST &ctry = string


Phone Number

Optional.
The phone number.
Protocol Syntax
REST &phone = string


Email Address

Optional.
The email address.
Protocol Syntax
REST &email = string


Melissa Address Key (MAK)

Optional.
A propietary unique key identifier for an address.
Protocol Syntax
REST &mak = string