LeadGen Property:Request Parameters - Revision history

Admin at 17:31, 23 December 2016

2016-12-23T17:31:12Z

← Older revision		Revision as of 17:31, 23 December 2016
Line 28:		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 55:		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===

Admin: Admin moved page LeadGen:Property:Request Parameters to LeadGen Property:Request Parameters

2016-05-12T17:07:39Z

Admin moved page LeadGen:Property:Request Parameters to LeadGen Property:Request Parameters

← Older revision	Revision as of 17:07, 12 May 2016
(No difference)

Admin at 17:07, 12 May 2016

2016-05-12T17:07:33Z

← Older revision		Revision as of 17:07, 12 May 2016
Line 1:		Line 1:
	{{LGXPropertyNav		{{LGXPropertyNav}}
	~~\|RequestCollapse=~~
	}}

Admin at 22:26, 8 October 2015

2015-10-08T22:26:36Z

← Older revision		Revision as of 22:26, 8 October 2015
Line 177:		Line 177:
	\|occu-d		\|occu-d
	\|Occupant types:		\|Occupant types:
	#Absentee only		1 = Absentee only
	#Owner occupied
			2 = Owner occupied
	\|All, including unknown.		\|All, including unknown.
	\|		\|

Admin at 22:46, 6 October 2015

2015-10-06T22:46:41Z

← Older revision		Revision as of 22:46, 6 October 2015
Line 332:		Line 332:
	\|Sale date.		\|Sale date.
	\|no filter		\|no filter
	\|To specify a period, use ~~MYYYYMYYYY~~. 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.		\|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		\|mdt

Admin at 21:13, 6 October 2015

2015-10-06T21:13:08Z

Show changes

Admin at 20:23, 1 October 2015

2015-10-01T20:23:57Z

← Older revision		Revision as of 20:23, 1 October 2015
Line 197:		Line 197:
	!Value		!Value
	!File Format		!File Format
	\|-
	\|1
	~~\|Zipped .dbf~~
	\|-		\|-
	\|2		\|2
Line 209:		Line 206:
	\|4		\|4
	\|Zipped .xls (Excel)		\|Zipped .xls (Excel)
	\|-
	\|6
	~~\|.dbf~~
	\|-		\|-
	\|7		\|7

Admin at 18:37, 10 July 2015

2015-07-10T18:37:46Z

← Older revision		Revision as of 18:37, 10 July 2015
Line 83:		Line 83:
	\|		\|
	Format: 5-digit ZIP or 9-digit ZIP+4		Format: 5-digit ZIP or 9-digit ZIP+4

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

	Ex. zp=92688,85023,129265917		Ex. zp=92688,85023,129265917
	\|-		\|-
Line 90:		Line 92:
	\|		\|
	Format: 2-digit state;city name		Format: 2-digit state;city name

	Multiple cities be requested, comma separated with no space.		Multiple cities be requested, comma separated with no space.

	Ex. city=TX;Dallas,TX;Houston,TX;Austin		Ex. city=TX;Dallas,TX;Houston,TX;Austin
	\|-		\|-
Line 97:		Line 101:
	\|		\|
	Format: 2-digit state;county name		Format: 2-digit state;county name

	Multiple counties be requested, comma separated with no space.		Multiple counties be requested, comma separated with no space.

	Ex. county=CA;Lake,AZ;Mohave,AZ;Maricopa		Ex. county=CA;Lake,AZ;Mohave,AZ;Maricopa
	\|-		\|-

Admin: Created page with "{{LGXPropertyNav |RequestCollapse= }} {{CustomTOC}} ==Standard Components== {|class="alternate01" cellspacing="0" !Parameter !style="border-right:0px;"|Definition |- |Domai..."

2015-07-08T18:54:02Z

Created page with "{{LGXPropertyNav |RequestCollapse= }} {{CustomTOC}} ==Standard Components== {|class="alternate01" cellspacing="0" !Parameter !style="border-right:0px;"|Definition |- |Domai..."

New page

{{LGXPropertyNav
|RequestCollapse=
}}

{{CustomTOC}}

==Standard Components==
{|class="alternate01" cellspacing="0"
!Parameter
!style="border-right:0px;"|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|Geographic Types]] for more info.
|-
|Customer ID
|The requester’s Customer ID or email address.
|-
|Options
|
*[[#Geographic Options|Geographic Options]]
*[[#Property Options|Property Options]]
*[[#General Options|General Options]]
*[[#Other Purchase Options|Other Purchase Options]]
|}

==Actions==
The following actions are supported by the web service:

{|class="alternate01" cellspacing="0"
!Action
!style="border-right:0px;"|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 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”.

===Required===
{|class="alternate01" cellspacing="0"
!URL Parameter
!style="border-right:0px;"|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: [[LeadGen:Property#Calls|Property Call Format]].

{|class="alternate01" cellspacing="0"
!URL Parameter
!Geographic Type
!style="border-right:0px;"|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 [[LeadGen:Property:List/File#Columns in File|Columns in File]] for the format of all columns appended to file.

===Geographic Options===
{|class="alternate01" cellspacing="0"
!URL Parameter
!Geographic Type
!style="border-right:0px;"|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
|rowspan="2"|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===
{|class="alternate01" cellspacing="0"
!URL Parameter
!Description
!Default Value
!style="border-right:0px;"|Optional Output Parameter
|-
|abs
|Does not append the absentee indicator to file.
|abs=0
|Append the indicator to file: abs=1
|-
|abs-d
|Appends absentee owners only.
|abs-d=1
|Append all owner types: abs-d=0
|}

===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)
|-
|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
|-
|4
|Zipped .xls (Excel)
|-
|6
|.dbf
|-
|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===
{|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
|}

[[Category:LeadGen]]
[[Category:LeadGen Property]]