LeadGen Business:Response: Difference between revisions
Jump to navigation
Jump to search
m Admin moved page LeadGen Xpress:Business:Response to LeadGen:Business:Response |
No edit summary |
||
Line 70: | Line 70: | ||
|- | |- | ||
|<ContactName> | |<ContactName> | ||
|True or False. See [[LeadGen | |True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options. | ||
|- | |- | ||
|<FaxNumber> | |<FaxNumber> | ||
|True or False. See [[LeadGen | |True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options. | ||
|- | |- | ||
|<Phone> | |<Phone> | ||
|True or False. See [[LeadGen | |True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options. | ||
|- | |- | ||
|<NAICS> | |<NAICS> | ||
|True or False. See [[LeadGen | |True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options. | ||
|- | |- | ||
|<KeyExecutive> | |<KeyExecutive> | ||
|True or False. See [[LeadGen | |True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options. | ||
|- | |- | ||
|<NumberOfEmployees> | |<NumberOfEmployees> | ||
|True or False. See [[LeadGen | |True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options. | ||
|- | |- | ||
|<EstimatedSales> | |<EstimatedSales> | ||
|True or False. See [[LeadGen | |True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options. | ||
|- | |- | ||
|<CountDetails> | |<CountDetails> | ||
Line 150: | Line 150: | ||
|- | |- | ||
|<Usage> | |<Usage> | ||
|Set by "multi" URL parameter. One or multi usage specified in buy call. See [[LeadGen | |Set by "multi" URL parameter. One or multi usage specified in buy call. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for details. | ||
|- | |- | ||
|<DownloadURL> | |<DownloadURL> | ||
Line 156: | Line 156: | ||
|- | |- | ||
|<PONumber> | |<PONumber> | ||
|Set by "po" URL parameter. Returned if po is specified. See [[LeadGen | |Set by "po" URL parameter. Returned if po is specified. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for details. | ||
|- | |- | ||
|<DeliveredQty> | |<DeliveredQty> | ||
Line 162: | Line 162: | ||
|- | |- | ||
|<Result> | |<Result> | ||
|Indicates the status of a request. Returns Declined, Approved, or Err. |See [[LeadGen | |Indicates the status of a request. Returns Declined, Approved, or Err. |See [[LeadGen:Business:Result Codes|Business Result Codes]] for details. | ||
|- | |- | ||
|<StatusCode> | |<StatusCode> | ||
|See [[LeadGen | |See [[LeadGen:Business:Result Codes#Status Codes|Status Codes]] for details. | ||
|- | |- | ||
|<Errors> | |<Errors> | ||
Line 171: | Line 171: | ||
|- | |- | ||
|<Error> | |<Error> | ||
|See [[LeadGen | |See [[LeadGen:Business:Result Codes#Error Codes|Error Codes]] for details. | ||
|- | |- | ||
|<ErrorCode> | |<ErrorCode> | ||
Line 221: | Line 221: | ||
[[Category:LeadGen | [[Category:LeadGen]] | ||
[[Category:LeadGen | [[Category:LeadGen Business]] |
Revision as of 19:20, 7 July 2015
LeadGen Business Navigation |
---|
Introduction |
Request Parameters |
XML Response |
List/File |
Business Result Codes |
Returned for both get-count and buy-list requests:
XML Element | XML Description |
---|---|
<Business> | Tag encapsulating the whole XML document. |
<Geography> | Geo request |
<City> |
Requests within Geo Selects. Tags returned depend on Geo type. |
<County> | |
<State> | |
<ZIP> | |
<Options> | |
<ContactPersonInfo> | |
<ContactPersonInfo> |
|
<NumberOfEmployees> | |
<IncludeAll> OR <Details> | Default output is <IncludeAll>True</IncludeAll>, unless details options are specified in request. For example, <Details>100 – 249;500 – 999;5,000 - 9,999</Details> would be shown with all chosen options separated by semi colon. |
<AppendToFile> | True or False |
<SalesVolumes> | Various ranges of annual sales volumes |
<IncludeAll> OR <Details> | Default output is <IncludeAll>True</IncludeAll>, unless details options are specified in request. For example, <Details>$10,000,000-$19,999,999;$50,000,000-$99,999,999;$500,000,000-$999,999,999</Details> would be shown with all chosen options separated by semi colon. |
<AppendToFile> | True or False |
<SICCodes> | 6-digit SIC code |
<IncludeAll> OR <Details> | Default output is <IncludeAll>True</IncludeAll>, unless details options are specified in request. For example, <Details>CONSTRUCTION-SPECIAL TRADE CONTRACTORS;NONCLASSIFIED ESTABLISHMENTS;CREDIT & DEBT COUNSELING SERVICES</Details> would be shown with all chosen options separated by semi colon. |
<AppendToFile> | True or False |
<AdditionalAppend> | |
<ContactName> | True or False. See Other Purchase Options for options. |
<FaxNumber> | True or False. See Other Purchase Options for options. |
<Phone> | True or False. See Other Purchase Options for options. |
<NAICS> | True or False. See Other Purchase Options for options. |
<KeyExecutive> | True or False. See Other Purchase Options for options. |
<NumberOfEmployees> | True or False. See Other Purchase Options for options. |
<EstimatedSales> | True or False. See Other Purchase Options for options. |
<CountDetails> | |
<StreetRange> | Contains a breakdown of the street range. |
<Street> | Individual streets. |
<StartNumber> | For Geo types radius. Shows the starting street number and ending street number in the count. |
<EndNumber> | |
<Geography> |
Location of count detail. The location varies by the request type:
|
<Zip> | For radius type only. |
<Count> |
Location of count detail. The location varies by the request type:
|
<Addresses> | Only returned with Radius when strzip is specified. Contains a breakdown of the addresses returned. |
<Address> | Individual addresses. |
<Count> |
Location of count detail. The location varies by the request type:
|
<TotalCount> | Total number of records returned with the selected options. |
<Order> | Buy Requests Only. Order details for a Buy request. |
<Id> | Order Id. |
<Usage> | Set by "multi" URL parameter. One or multi usage specified in buy call. See Other Purchase Options for details. |
<DownloadURL> | The URL to download the purchased file. |
<PONumber> | Set by "po" URL parameter. Returned if po is specified. See Other Purchase Options for details. |
<DeliveredQty> | Number of records returned. |
<Result> | See Business Result Codes for details. |
<StatusCode> | See Status Codes for details. |
<Errors> | If <StatusCode> returns Err. |
<Error> | See Error Codes for details. |
<ErrorCode> | |
<ErrorDescription> |
Examples
An example (from the buy list call in section 1):
<Business> <Geography> <ZIP>92688</ZIP> </Geography> <Options> <ContactPersonInfo> <ContactPersonInfo>One per Address</ContactPersonInfo> </ContactPersonInfo> <NumberOfEmployees> <IncludeAll>True</IncludeAll> <AppendToFile>False</AppendToFile> </NumberOfEmployees > <SalesVolumes> <Details>$5,000,000-$9,999,999</Details> <AppendToFile>False</AppendToFile> </SalesVolumes > <SICCodes> <IncludeAll>True</IncludeAll> <AppendToFile>False</AppendToFile> </SICCodes> <AdditionalAppend></AdditionalAppend> </Options> <TotalCount> <Count>63/Count> </TotalCount> <Order> <Id>123456</Id> <Usage>1</Usage> <DownloadURL>ftp://w10.melissadata.com/ListOrderFiles/123456.csv</DownloadURL> <DeliveredQty>63</DeliveredQty> </Order> <Result> <StatusCode>Approved</StatusCode> </Result> </Business>