LeadGen Property:Request Parameters: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older edit
No edit summary
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{LGXPropertyNav
{{LGXPropertyNav}}
|RequestCollapse=
}}




Line 30: Line 28:
|-
|-
|Customer ID
|Customer ID
|The requester’s Customer ID or email address.
|The requester’s License Key or email address.
|-
|-
|Options
|Options
Line 57: Line 55:


==Authentication==
==Authentication==
Each customer’s ID or email address is passed in as “id” in the URL. This is checked against the list of registered customers. If the required customer ID has not been activated for LeadGen Property, the service will return <Status Code> with the value “Declined”.
Each License Key or email address is passed in as “id” in the URL. This is checked against the list of registered customers. If the required License Key has not been activated for LeadGen Property, the service will return <Status Code> with the value “Declined”.


===Required===
===Required===
Line 164: Line 162:
!style="border-right:0px;"|Optional Output Parameter
!style="border-right:0px;"|Optional Output Parameter
|-
|-
|abs
|opt
|Does not append the absentee indicator to file.
|Extra data added to the file returned: basic or detailed.
|abs=0
When not mentioned, the simplest set of data is returned for those who have not opted out mail: owner names, property and mailing addresses.
|Append the indicator to file: abs=1
|opt=0 (Basic)
|opt=1 (Detailed)
|-
|-
|abs-d
|occu
|Appends absentee owners only.
|Append OccupantType to file.
|abs-d=1
|occu=0
|Append all owner types: abs-d=0
|To append: occu=1
|-
|occu-d
|Occupant types:
1 = Absentee only
 
2 = Owner occupied
|All, including unknown.
|
|-
|mval
|Market value. Specify with the index and use ‘-‘ dash to specify multiple choices: mval=2-3-4
|all
|
{|class="alternate01" cellspacing="0"
!Value
!Definition
|-
|1
|$1 - 49,999
|-
|2
|$50,000 - 99,999
|-
|3
|$100,000 - 149,999
|-
|4
|$150,000 - 199,999
|-
|5
|$200,000 - 249,999
|-
|6
|$250,000 - 299,999
|-
|7
|$300,000 - 349,999
|-
|8
|$350,000 - 399,999
|-
|9
|$400,000 - 449,999
|-
|10
|$450,000 - 499,999
|-
|11
|$500,000 - 574,999
|-
|12
|$575,000 - 649,999
|-
|13
|$650,000 - 724,999
|-
|14
|$725,000 - 799,999
|-
|15
|$800,000 - 899,999
|-
|16
|$900,000 - 999,999
|-
|17
|$1,000,000 - 1,999,999
|-
|18
|$2,000,000+
|}
|-
|ptype
|Property type. To specify the index; use ‘-‘ dash to specify multiple choices, i.e. ptype =1-2
|all
|
{|class="alternate01" cellspacing="0"
!Value
!Definition
|-
|1
|Single Family Residence/Townhouse
|-
|2
|Condominium (residential)
|-
|3
|Commercial
|-
|4
|Duplex, Triplex, Quadplex
|-
|5
|Apartment
|-
|6
|Hotel, Motel
|-
|7
|Commercial (condominium)
|-
|8
|Retail
|-
|9
|Service (general public)
|-
|10
|Office Building
|-
|11
|Warehouse
|-
|12
|Financial Institution
|-
|13
|Hospital (medical complex, clinic)
|-
|14
|Parking
|-
|15
|Amusement-Recreation
|-
|16
|Industrial
|-
|17
|Industrial Light
|-
|18
|Industrial Heavy
|-
|19
|Transport
|-
|20
|Utilities
|-
|21
|Agricultural
|-
|22
|Vacant
|-
|23
|Exempt
|-
|24
|Miscellaneous
|-
|25
|Not Available / None
|}
|-
|sdt
|Sale date.
|no filter
|To specify a period, use MYYYY. The start month starts on the 1st; the end month ends on the last day, i.e. sdt=32010-122014, this covers 3/1/2010 to 12/31/2014.
|-
|mdt
|Mortgage date
|no filter
|To specify a period, use MYYYY. The start month starts on the 1st; the end month ends on the last day, i.e. mdt=32010-122014, this covers 3/1/2010 to 12/31/2014.
|}
|}


Latest revision as of 17:31, 23 December 2016

← LeadGen Cloud API

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



Standard Components

Parameter Definition
Domain
Version Web Service version.
Web Service Property
Protocol REST. The protocol used by the Web Service.
Action "Get Count" or "Buy List"
Geographic type ZIP, City, County, or Radius. See Geographic Types for more info.
Customer ID The requester’s License Key or email address.
Options


Actions

The following actions are supported by the web service:

Action Service Description
Get Get the count of customers who fit the geographic and property criteria.
Buy Buy a list of customers' info that fit the geographic and property criteria.


Authentication

Each License Key or email address is passed in as “id” in the URL. This is checked against the list of registered customers. If the required License Key has not been activated for LeadGen Property, the service will return <Status Code> with the value “Declined”.

Required

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


Geographic Types

Each request must specify one of the following geographic types:

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

URL Parameter Geographic Type Description
zip? Zip

Format: 5-digit ZIP or 9-digit ZIP+4

Multiple ZIP or ZIP+4 can be requested, comma separated with no space.

Ex. zp=92688,85023,129265917

city? City

Format: 2-digit state;city name

Multiple cities be requested, comma separated with no space.

Ex. city=TX;Dallas,TX;Houston,TX;Austin

county? County

Format: 2-digit state;county name

Multiple counties be requested, comma separated with no space.

Ex. county=CA;Lake,AZ;Mohave,AZ;Maricopa

radius? Radius

Miles of radius from a given address, or the closest records to a given address.


Options

Each request takes a set of geographic input. Property 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
zip

Required: zip

Optional: radius

Each five-digit ZIP is validated. Plus4 is a filter in the data section.

city Required: city

Optional: radius

Each city and state combinations is validated.
county Required: county Each county and state combination is validated. FIPS is retrieved if valid.
addr Required: radius Exact street number and street name are used in the data section. No validation.

Latitude and longitude are retrieved if the address exists.

mile Optional: radius

(One of the two should be given, not required together.)

Mile is used to find out the latitudes/longitudes of a parameter so many miles from the given address.
records Number of records that are the closest to the given address.


Property Options

URL Parameter Description Default Value Optional Output Parameter
opt Extra data added to the file returned: basic or detailed.

When not mentioned, the simplest set of data is returned for those who have not opted out mail: owner names, property and mailing addresses.

opt=0 (Basic) opt=1 (Detailed)
occu Append OccupantType to file. occu=0 To append: occu=1
occu-d Occupant types:

1 = Absentee only

2 = Owner occupied

All, including unknown.
mval Market value. Specify with the index and use ‘-‘ dash to specify multiple choices: mval=2-3-4 all
Value Definition
1 $1 - 49,999
2 $50,000 - 99,999
3 $100,000 - 149,999
4 $150,000 - 199,999
5 $200,000 - 249,999
6 $250,000 - 299,999
7 $300,000 - 349,999
8 $350,000 - 399,999
9 $400,000 - 449,999
10 $450,000 - 499,999
11 $500,000 - 574,999
12 $575,000 - 649,999
13 $650,000 - 724,999
14 $725,000 - 799,999
15 $800,000 - 899,999
16 $900,000 - 999,999
17 $1,000,000 - 1,999,999
18 $2,000,000+
ptype Property type. To specify the index; use ‘-‘ dash to specify multiple choices, i.e. ptype =1-2 all
Value Definition
1 Single Family Residence/Townhouse
2 Condominium (residential)
3 Commercial
4 Duplex, Triplex, Quadplex
5 Apartment
6 Hotel, Motel
7 Commercial (condominium)
8 Retail
9 Service (general public)
10 Office Building
11 Warehouse
12 Financial Institution
13 Hospital (medical complex, clinic)
14 Parking
15 Amusement-Recreation
16 Industrial
17 Industrial Light
18 Industrial Heavy
19 Transport
20 Utilities
21 Agricultural
22 Vacant
23 Exempt
24 Miscellaneous
25 Not Available / None
sdt Sale date. no filter To specify a period, use MYYYY. The start month starts on the 1st; the end month ends on the last day, i.e. sdt=32010-122014, this covers 3/1/2010 to 12/31/2014.
mdt Mortgage date no filter To specify a period, use MYYYY. The start month starts on the 1st; the end month ends on the last day, i.e. mdt=32010-122014, this covers 3/1/2010 to 12/31/2014.


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
2 Zipped .txt
3 Zipped .csv
4 Zipped .xls (Excel)
7 .txt
8 (Default) .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
Retrieved from "http://wiki.melissadata.com/index.php?title=LeadGen_Property:Request_Parameters&oldid=12058"