LeadGen Consumer:Request Parameters: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
No edit summary
Line 73: Line 73:


Don't forget! The call URL format: [[LeadGen:Consumer#Calls|Consumer Call Format]].
Don't forget! The call URL format: [[LeadGen:Consumer#Calls|Consumer Call Format]].
For examples of each type, see [[#Examples|examples]] below.


{|class="alternate01" cellspacing="0"
{|class="alternate01" cellspacing="0"
Line 115: Line 117:
|street?
|street?
|Returns the records from a specified street within a specified ZIP code.
|Returns the records from a specified street within a specified ZIP code.
|
|str=
|
|
|Get/Buy
|Get/Buy
Line 189: Line 191:
|<code>http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/ZipsByCity?id=customer@domain.com&city=ca;irvine,ca;tustin</code>
|<code>http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/ZipsByCity?id=customer@domain.com&city=ca;irvine,ca;tustin</code>
|}
|}


==Options==
==Options==
Line 235: Line 234:
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|hInc
|hInc
|Household Income. With no input, it will include all. When 0, this option will not be considered. May be dash delimited to include specific ranges.
|Household Income. With no input, it will include all. When 0, this option will not be considered. May be dash delimited to include specific ranges. For a list of possible values, see [[#hInc Values|hInc Values]].
|N/A
|N/A
|
|
Include all: hInc=
Include all: hInc=


To specify: hInc-d=xx
To specify: hInc-d=''value''
|- style="vertical-align:top;"
|cAge
|Contact Age Group. With no input, it will include all. When 0, this option will not be considered. May be dash delimited to include specific ranges. For a list of possible values, see [[#cAge Values|cAge Values]].
|N/A
|
Include all: cAge=
 
To specify: cAge-d=''value''
|}
 
 
===Purchase Options===
The following options are for buy requestes only.
 
{|class="alternate01" cellspacing="0"
!URL Parameter
!Description
!Default Value
!style="border-right:0px;"|Optional Output Parameter
|-
|multi
|Buy Requests Only. By default, purchased lists may be used once. With this parameter included in the Buy call, you can purchase the right to use a list for multiple mailings. Specify the number of uses like this: multi=4. The maximum number of uses allowed for any purchased list is 5.
|multi=1
|multi=(1 through 5)
|- style="vertical-align:top;"
|file
|Buy Requests Only. Defines the desired file format of a purchased list.
|file=8
|
{|class="alternate01" cellspacing="0"
!Value
!File Format
|-
|1
|Zipped .dbf
|-
|2
|Zipped .txt
|-
|3
|Zipped .csv
|-
|5
|Zipped .xls (Excel)
|-
|6
|.dbf
|-
|7
|.txt
|-
|8
|.csv
|-
|10
|.xls (Excel)
|}
|-
|po
|Buy Requests Only. Defines the customer’s purchase order number.
|N/A
|To specify: po=xxxx
|}
 
 
===General Options===
{|class="alternate01" cellspacing="0"
!URL Parameter
!Description
!Default Value
!style="border-right:0px;"|Optional Output Parameter
|-
 
|-
|dbug
|Parameter check. If a parameter in the url is spelled wrong or not suited for the given call, the request will be rejected.
|dbug=0
|To check: dbug=1
|}
 


===Option Value===
====hInc Values====
{|class="alternate01" cellspacing="0"
{|class="alternate01" cellspacing="0"
!Value
!Value
Line 285: Line 366:
|$250,000 or more.
|$250,000 or more.
|}
|}
|- style="vertical-align:top;"
|cAge
|Contact Age Group. With no input, it will include all. When 0, this option will not be considered. May be dash delimited to include specific ranges.
|N/A
|
Include all: cAge=
To specify: cAge-d=xx


====cAge Values====
{|class="alternate01" cellspacing="0"
{|class="alternate01" cellspacing="0"
!Value
!Value
Line 336: Line 410:
|13
|13
|76+ years
|76+ years
|}
|}
===Purchase Options===
The following options are for buy requestes only.
{|class="alternate01" cellspacing="0"
!URL Parameter
!Description
!Default Value
!style="border-right:0px;"|Optional Output Parameter
|-
|multi
|Buy Requests Only. By default, purchased lists may be used once. With this parameter included in the Buy call, you can purchase the right to use a list for multiple mailings. Specify the number of uses like this: multi=4. The maximum number of uses allowed for any purchased list is 5.
|multi=1
|multi=(1 through 5)
|- style="vertical-align:top;"
|file
|Buy Requests Only. Defines the desired file format of a purchased list.
|file=8
|
{|class="alternate01" cellspacing="0"
!Value
!File Format
|-
|1
|Zipped .dbf
|-
|2
|Zipped .txt
|-
|3
|Zipped .csv
|-
|5
|Zipped .xls (Excel)
|-
|6
|.dbf
|-
|7
|.txt
|-
|8
|.csv
|-
|10
|.xls (Excel)
|}
|-
|po
|Buy Requests Only. Defines the customer’s purchase order number.
|N/A
|To specify: po=xxxx
|}
===General Options===
{|class="alternate01" cellspacing="0"
!URL Parameter
!Description
!Default Value
!style="border-right:0px;"|Optional Output Parameter
|-
|-
|dbug
|Parameter check. If a parameter in the url is spelled wrong or not suited for the given call, the request will be rejected.
|dbug=0
|To check: dbug=1
|}
|}


Revision as of 17:44, 13 July 2015

← LeadGen Cloud API

LeadGen Consumer Navigation
Introduction
Request Parameters
XML Response
List/File
Consumer Result Codes



Standard Components

Parameter Definition
Domain
Version Web Service version.
Web Service Consumer
Protocol REST. The protocol used by the Web Service.
Action "get" or "buy"
Geographic type ZIP, city, county, state, radius. See Geographic Types for more info.
Customer ID The requester’s Customer ID or email address.
Options


Actions

The following actions are supported by the web service:

Action Service Description
Get Get count of consumers that fit in the given criteria.
Buy Buy a list of consumers’ info that fit the given criteria.


Authentication

Each Customer’s ID or email address is passed in as id in the URL. It is checked against the list of registered customers.

Required

URL Parameter Description
id Required. User ID or Email Address. You must be subscribed to the LeadGen Customer Web Service.


Geographic Types

Each request must specify a geographic type.

Don't forget! The call URL format: Consumer Call Format.

For examples of each type, see examples below.

URL Parameter Format Required Optional Get/Buy
zip? 5-digit ZIP or 9-digit ZIP+4. Multiple ZIP or ZIP+4 can be requested, comma separated with no space. zip= Get/Buy
city? 2-digit state;city name. Multiple cities be requested, comma separated with no space. city= Get/Buy
county? 2-digit state;county name. Multiple counties be requested, comma separated with no space. county= Get/Buy
state? 2-digit state. State requests will return records from a specified state. Multiple states be requested, comma separated with no space. st= Get/Buy
radius? Radius requests will return the nearest records to the selected address, up to 100,000 records (65,535 when requesting Excel files). records= mile=

str= strzip=

Get/Buy
street? Returns the records from a specified street within a specified ZIP code. str= Get/Buy
CitiesByCounty? Returns a complete list of cities within the specified U.S. County. Get
CitiesByState? Returns a complete list of cities within the specified U.S. State. Get
CountiesByState? Returns a complete list of counties within the specified U.S. State. Get
States? Returns a complete list of Sates within the United States of America. Get
ZipsByCity? Returns a complete list of ZIP Codes within the specified City. State is separated from city with a “;” semi-colon. Multiple entries are delimited with a “,” comma. Get


Examples

URL Parameter Example URL
zip? http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/zip?id=customer@domain.com&zip=926882112,92612
city? http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/city?id=customer@domain.com&city=ca;irvine,tx;dallas
county? http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/county?id=customer@domain.com&county=ca;lake,ak;anchorage
state? http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/state?id=customer@domain.com&st=ca,ak
radius? http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/radius?id=customer@domain.com&addr=22382avenidaempresa&zip=92688&records=100&mile=1
street? http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/street?id=customer@domain.com&zip=92688&str=empresa
CitiesByCounty? http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/CitiesByCounty?id=customer@domain.com&st=ca&county=orange
CitiesByState? http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/CitiesByState?id=customer@domain.com&st=ak
CountiesByState? http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/CountiesByState?id=customer@domain.com&st=ak
States? http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/States?id=customer@domain.com
ZipsByCity? http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/ZipsByCity?id=customer@domain.com&city=ca;irvine,ca;tustin

Options

Each request takes a set of geographic input. Consumer address types and other input are optional with default values, as well as purchase options. See Columns in File for the format of all columns appended to file.

Geographic Options

URL Parameter Geographic Type Description
str

Required: street

Optional: radius

For street: If exact street name cannot be found, similar street names will be returned. Ex: If no street called “Gilberto” is found, similar streets like “Gilberto Ave” and “Gilberton” will be returned.

For radius: Exact street name will be searched within the radius. If nothing found, nothing is returned.

records Required: radius

Defines the number of records to be returned.

mile Optional: radius Defines the number of miles from &addr and &zip a record can be returned. If used with &records the search will be for the specified number of records within the given number of miles. Maximum value is 10.
strzip Optional: radius All addresses within the radius and with this zip will be returned.


Demographic Options

URL Parameter Description Default Value Optional Output Parameter
hInc Household Income. With no input, it will include all. When 0, this option will not be considered. May be dash delimited to include specific ranges. For a list of possible values, see hInc Values. N/A

Include all: hInc=

To specify: hInc-d=value

cAge Contact Age Group. With no input, it will include all. When 0, this option will not be considered. May be dash delimited to include specific ranges. For a list of possible values, see cAge Values. N/A

Include all: cAge=

To specify: cAge-d=value


Purchase Options

The following options are for buy requestes only.

URL Parameter Description Default Value Optional Output Parameter
multi Buy Requests Only. By default, purchased lists may be used once. With this parameter included in the Buy call, you can purchase the right to use a list for multiple mailings. Specify the number of uses like this: multi=4. The maximum number of uses allowed for any purchased list is 5. multi=1 multi=(1 through 5)
file Buy Requests Only. Defines the desired file format of a purchased list. file=8
Value File Format
1 Zipped .dbf
2 Zipped .txt
3 Zipped .csv
5 Zipped .xls (Excel)
6 .dbf
7 .txt
8 .csv
10 .xls (Excel)
po Buy Requests Only. Defines the customer’s purchase order number. N/A To specify: po=xxxx


General Options

URL Parameter Description Default Value Optional Output Parameter
dbug Parameter check. If a parameter in the url is spelled wrong or not suited for the given call, the request will be rejected. dbug=0 To check: dbug=1


Option Value

hInc Values

Value Income Range
1 Less than $14,999
2 $15,000 - $19,999
3 $20,000 - $29,999
4 $30,000 - $39,999
5 $40,000 - $49,999
6 $50,000 - $74,999
7 $75,000 - $99,999
8 $100,000 - $124,999
9 $125,000 - $149,999
10 $150,000 - $174,999
11 $175,000 - $199,999
12 $200,000 - $249,999
13 $250,000 or more.

cAge Values

Value Age Group
1 18-20 years
2 21-25 years
3 26-30 years
4 31-35 years
5 36-40 years
6 41-45 years
7 46-50 years
8 51-55 years
9 56-60 years
10 61-65 years
11 66-70 years
12 71-75 years
13 76+ years
Retrieved from "http://wiki.melissadata.com/index.php?title=LeadGen_Consumer:Request_Parameters&oldid=9281"