LeadGen Business:Request Parameters: Difference between revisions
No edit summary |
No edit summary |
||
| Line 24: | Line 24: | ||
|- | |- | ||
|Action | |Action | ||
|" | |"get" or "buy" | ||
|- | |- | ||
|Geographic type | |Geographic type | ||
Revision as of 20:33, 2 March 2015
| LeadGen Business Navigation |
|---|
| Introduction |
| Request Parameters |
| XML Response |
| List/File |
| Business Result Codes |
Standard Components
| Parameter | Definition |
|---|---|
| Domain | |
| Version | Web Service version. |
| Web Service | Business |
| Protocol | REST. The protocol used by the Web Service. |
| Action | "get" or "buy" |
| Geographic type | ZIP, city, county, state. 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 businesses that fit in the given criteria. |
| Buy | Buy a list of businesses’ 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.
Geographic Types
Each request must specify a geographic types.
Don't forget! The call URL format: Calls.
| 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 |
| state? | State |
Format: 2-digit state code Multiple states can be requested, comma separated with no space. Ex. St=CA,AZ,NV |
| radius? | Radius |
Miles of radius from a given address, amd/or the closes so many records to a given address EX. to request the closest 100 businesses within 5 mile to the address 23412 Avenida Empresa, 92688: addr=23412+avenida+empresa&zip=92688&mile=5&records=100 |
Options
Each request takes a set of geographic input. Business 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 |
|---|---|---|
| ZIP (5 digits) or ZIP + 4 (9 digits) |
Required: zip Optional: radius |
Each five-digit ZIP is validated. Plus4 is a filter in data selection. |
| City |
Required: city Optional: radius |
Each city and state combination is validated |
| County | Required: county |
Each county and state combination is validated. FIPS is retrieved if valid. |
| State |
Required: state Optional: radius |
Two-digit state code is validated. |
| Addr | Required: radius |
Exact street number and street name are used in data selection. 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 latitude and longitude of a parameter so many miles away from the give address. |
| Records | Number of records that are the closest to the given address. | |
| Str | Optional: radius | A street name within the given zip. (The street name needs to be exact.) |
| Strzip | Optional: radius | Zip for a specific street that is within the given radius (combination with a given address). |
Business Options
| URL Parameter | Description | Default Value | Optional Output Parameter |
|---|---|---|---|
| sic | Append 6-digit SIC code to file if exists (see frequency in table 4.2) | sic=0 | sic=1 |
| sic-d | Various SIC codes as selection/filter | all inclusive | Otherwise specify the SIC’s (2 to 6 digits), use ‘-‘ dash to specify multiple SIC codes, i.e. sic-d=17-9999-729924 |
| staff | Append number of employees to file | staff=0 | staff=1 |
| staff-d |
Various sizes of staff as selection/filter
|
all inclusive | Otherwise specify the index; use ‘-‘ dash to specify multiple staff codes, i.e. staff-d =6-8-10 |
| sale | Append annual sales volume to file | sale=0 | sale=1 |
| sale-d |
Various ranges of annual sales volumes as selection/filter
|
all inclusive | Otherwise specify the index; use ‘-‘ dash to specify multiple sales volume codes, i.e. sale-d =6-8-10 |
General Options
| URL Parameter | Description | Default Value | Optional Output Parameter |
|---|---|---|---|
| one | One contact per business | one=1 | one=0 returns all contacts |
| dbug | Parameter check. If a parameter is spelt wrong or not suited for the given call, the request will be rejected. | dbug=0 | dbug=1 to check |
Other Purchase Options
| URL Parameter | Description | Default Value | Optional Output Parameter |
|---|---|---|---|
| name | Append contact name to file if exists | name=0 | To append: name=1 |
| po | Customer’s purchase order number | none | To specify: po=xxxx |
| multi | Multiple usage of the list (1 – 5 times) | multi=1 | Multi=(1 through 5) |
| file | Specify file format. | file=8 (csv) | Otherwise specify format from File Types |
| fax | Append fax number (if available) | fax=0 | fax=1 |
| phone | Append phone number (if available) | phone=0 | phone=1 |
| naics | Append 8-digit NAICS code to file if exists | naics=0 | naics=1 |
| numemp | Appends the number of actual employees (as opposed to a range like staff) | numemp=0 | numemp=1 |
| keyexec | Appends the Key Executive to file | keyexec=0 | keyexec=1 |
| numsales | Appends the estimated sales volume in thousands (as opposed to a range like sale) | numsales=0 | numsales=1 |