Personator Search:Request: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
No edit summary
Line 87: Line 87:
:''Optional.''
:''Optional.''


:Specifies the options/
:Specifies the options. See the options below for more information.


:{| class="alternate01"
:{| class="alternate01"
Line 105: Line 105:




:<h4 style="border-bottom:1px solid black;">SearchType</h4>
:<h4 style="border-bottom:1px solid black;">MaxEmail</h4>
::This options allows you to specify the type of search to perform.
::Sets the maximum number of emails that can be returned. Default maximum is "3" if this option is not set.


::{| class="alternate01 sortable"
::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
!Option Name !! Parameter !! Description
|-
|-
|rowspan="7"|'''SearchType'''||<code>Auto</code>||'''''Default.''''' Performs name, address, email, and phone searches until one or more matches are found.
|'''MaxPhone'''||<code># [0 - #]</code>||'''''Default set to 3.''''' Sets the maximum number of emails to be returned.
|-
|}
|<code>NameSearch</code>|| Uses name data as the primary pivot when verifying or appending information.
 
|-
 
|<code>AddressSearch</code>|| Uses address data as the primary pivot when verifying or appending information.
:<h4 style="border-bottom:1px solid black;">MaxPhone</h4>
|-
::Sets the maximum number of phone numbers that can be returned. Default maximum is "3" if this option is not set.
|<code>EmailSearch</code>|| Uses email data as the primary pivot when verifying or appending information.
 
|-
::{| class="alternate01 sortable"
|<code>PhoneSearch</code>|| Uses phone data as the primary pivot when verifying or appending information.
!Option Name !! Parameter !! Description
|-
|-
|<code>SmartSearch</code>||
|'''MaxPhone'''||<code># [0 - #]</code>||'''''Default set to 3.''''' Sets the maximum number of phone numbers to be returned
|-
|<code>StraightSearch</code>||
|}
|}




:<h4 style="border-bottom:1px solid black;">MaxEmail</h4>
:<h4 style="border-bottom:1px solid black;">Page</h4>
::
::Specifies which "page" to return for a given request. Your "page" length is set by [[#RecordsPerPage|RecordsPerPage]].
 
::If your request returns more than your '''RecordsPerPage''', these records will be split into "pages". Use this option to select which "page" to view. If your specified "page" is out of the range of possible "page" numbers, an error will be returned.
 
::This option is ignored if the option '''ReturnAllPages''' is set to "true".


::{| class="alternate01 sortable"
::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
!Option Name !! Parameter !! Description
|-
|-
|rowspan="7"|''''''||<code></code>||'''''Default.''''' .
|'''Page'''||<code># [0 - #]</code>||
|}
|}




:<h4 style="border-bottom:1px solid black;">MaxPhone</h4>
:<h4 style="border-bottom:1px solid black;">RecordsPerPage</h4>
::
::Specifies how many records are in a "page". The default value is 5.
 
::This option is ignored if the option '''ReturnAllPages''' is set to "true".


::{| class="alternate01 sortable"
::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
!Option Name !! Parameter !! Description
|-
|-
|rowspan="7"|''''''||<code></code>||'''''Default.''''' .
|'''RecordsPerPage'''||<code># [0 - #]</code>||'''''Default set to 5.''''' Sets the records per "page".
|}
|}




:<h4 style="border-bottom:1px solid black;">Page</h4>
:<h4 style="border-bottom:1px solid black;">ReturnAllPages</h4>
::
::


Line 153: Line 157:
!Option Name !! Parameter !! Description
!Option Name !! Parameter !! Description
|-
|-
|rowspan="7"|''''''||<code></code>||'''''Default.''''' .
|rowspan="2"|'''ReturnAllPages'''||<code>true</code>||Will return all records up to a limit of 500.
|-
|<code>false</code>||'''''Default.''''' Will not return all records.
|}
|}




:<h4 style="border-bottom:1px solid black;">ReturnAllPages</h4>
:<h4 style="border-bottom:1px solid black;">SearchConditions</h4>
::
::Specifies the type of search conditions to use when returning records. Only the populated input fields will be compared. A loose search condition is used by default.


::{| class="alternate01 sortable"
::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
!Option Name !! Parameter !! Description
|-
|-
|rowspan="7"|''''''||<code></code>||'''''Default.''''' .
|rowspan="2"|'''SearchConditions'''||<code>exact</code>||The input values should match the output values exactly.
|-
|<code>loose</code>||'''''Default.''''' No filtering will be done. Raw record results will be returned.
|}
|}




:<h4 style="border-bottom:1px solid black;">SortBy</h4>
:<h4 style="border-bottom:1px solid black;">SearchType</h4>
::
::This options allows you to specify the type of search to perform.


::{| class="alternate01 sortable"
::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
!Option Name !! Parameter !! Description
|-
|-
|rowspan="7"|''''''||<code></code>||'''''Default.''''' .
|rowspan="7"|'''SearchType'''||<code>Auto</code>||'''''Default.''''' Performs name, address, email, and phone searches until one or more matches are found.
|-
|<code>NameSearch</code>|| Uses name data as the primary pivot when verifying or appending information.
|-
|<code>AddressSearch</code>|| Uses address data as the primary pivot when verifying or appending information.
|-
|<code>EmailSearch</code>|| Uses email data as the primary pivot when verifying or appending information.
|-
|<code>PhoneSearch</code>|| Uses phone data as the primary pivot when verifying or appending information.
|-
|<code>SmartSearch</code>||
|-
|<code>StraightSearch</code>||
|}
|}




:<h4 style="border-bottom:1px solid black;">SearchConditions</h4>
:<h4 style="border-bottom:1px solid black;">SortBy</h4>
::
::Allows sorting records in a particular order.


::{| class="alternate01 sortable"
::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
!Option Name !! Parameter !! Description
|-
|-
|rowspan="7"|''''''||<code></code>||'''''Default.''''' .
|rowspan="11"|'''SortBy'''||<code>PostalCode-ascending</code><br><code>PostalCode-descending</code>||Sort by postal code. Plus4 is also included with the ordering.
|-
|<code>CityState-ascending</code><br><code>CityState-descending</code>||Sort by state then city.
|-
|<code>AddressLine1-ascending</code><br><code>AddressLine1-descending</code>||Sort by address line 1.
|-
|<code>FullName-ascending</code><br><code>FullName-descending</code>||Sort by full name.
|-
|<code>FirstName-ascending</code><br><code>FirstName-descending</code>||Sort by first name.
|-
|<code>LastName-ascending</code><br><code>LastName-descending</code>||Sort by last name.
|-
|<code>DateOfBirth-ascending</code><br><code>DateOfBirth-descending</code>||Sort by date of birth.
|-
|<code>DateOfDeath-ascending</code><br><code>DateOfDeath-descending</code>||Sort by date of death.
|-
|<code>MoveDate-ascending</code><br><code>MoveDate-descending</code>||Sort by move date.
|-
|<code>MelissaAddressKey-ascending</code><br><code>MelissaAddressKey-descending</code>||Sort by Melissa Address Key.
|-
|<code>MelissaAddressKeyBase-ascending</code><br><code>MelissaAddressKeyBase-descending</code>||Sort by Melissa Address Key Base.
|}
|}


Revision as of 22:58, 14 March 2017

← 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. See the options below for more information.
Protocol Syntax
REST &opt = string


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


MaxEmail

Sets the maximum number of emails that can be returned. Default maximum is "3" if this option is not set.
Option Name Parameter Description
MaxPhone # [0 - #] Default set to 3. Sets the maximum number of emails to be returned.


MaxPhone

Sets the maximum number of phone numbers that can be returned. Default maximum is "3" if this option is not set.
Option Name Parameter Description
MaxPhone # [0 - #] Default set to 3. Sets the maximum number of phone numbers to be returned


Page

Specifies which "page" to return for a given request. Your "page" length is set by RecordsPerPage.
If your request returns more than your RecordsPerPage, these records will be split into "pages". Use this option to select which "page" to view. If your specified "page" is out of the range of possible "page" numbers, an error will be returned.
This option is ignored if the option ReturnAllPages is set to "true".
Option Name Parameter Description
Page # [0 - #]


RecordsPerPage

Specifies how many records are in a "page". The default value is 5.
This option is ignored if the option ReturnAllPages is set to "true".
Option Name Parameter Description
RecordsPerPage # [0 - #] Default set to 5. Sets the records per "page".


ReturnAllPages

Option Name Parameter Description
ReturnAllPages true Will return all records up to a limit of 500.
false Default. Will not return all records.


SearchConditions

Specifies the type of search conditions to use when returning records. Only the populated input fields will be compared. A loose search condition is used by default.
Option Name Parameter Description
SearchConditions exact The input values should match the output values exactly.
loose Default. No filtering will be done. Raw record results will be returned.


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


SortBy

Allows sorting records in a particular order.
Option Name Parameter Description
SortBy PostalCode-ascending
PostalCode-descending		 Sort by postal code. Plus4 is also included with the ordering.
CityState-ascending
CityState-descending		 Sort by state then city.
AddressLine1-ascending
AddressLine1-descending		 Sort by address line 1.
FullName-ascending
FullName-descending		 Sort by full name.
FirstName-ascending
FirstName-descending		 Sort by first name.
LastName-ascending
LastName-descending		 Sort by last name.
DateOfBirth-ascending
DateOfBirth-descending		 Sort by date of birth.
DateOfDeath-ascending
DateOfDeath-descending		 Sort by date of death.
MoveDate-ascending
MoveDate-descending		 Sort by move date.
MelissaAddressKey-ascending
MelissaAddressKey-descending		 Sort by Melissa Address Key.
MelissaAddressKeyBase-ascending
MelissaAddressKeyBase-descending		 Sort by Melissa Address Key Base.


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
Retrieved from "http://wiki.melissadata.com/index.php?title=Personator_Search:Request&oldid=12669"