Difference between revisions of "LeadGen Business:Response"

From Melissa Data Wiki
Jump to navigation Jump to search
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[LeadGen Xpress|← LeadGen Xpress]]
{{ LGXBusinessNav}}
 
{| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size:9pt; color:#0645ad; padding:8px 8px;"
! style="text-align:left; color:black; border-bottom:1px solid #aaaaaa;"|'''LeadGen Xpress Business Navigation'''
|-
| style="padding-right:220px;"|
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[LeadGen Xpress:Business|Introduction]]
|-
|[[LeadGen Xpress:Business#Calls|Business Calls]]
|-
|[[LeadGen Xpress:Business#Request Format|Request Format]]
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[LeadGen Xpress:Business:Request Parameters|Request Parameters]]
|-
|[[LeadGen Xpress:Business:Request Parameters#Standard Components|Standard Components]]
|-
|[[LeadGen Xpress:Business:Request Parameters#Actions|Actions]]
|-
|[[LeadGen Xpress:Business:Request Parameters#Authentication|Authentication]]
|-
|[[LeadGen Xpress:Business:Request Parameters#Geographic Types|Geographic Types]]
|-
|[[LeadGen Xpress:Business:Request Parameters#Options|Options]]
|}
|-
|
{| class="mw-collapsible" style="width:100%;"
|- align="left"
! style="color:black;"|[[LeadGen Xpress:Business:Response|XML Response]]
|-
|[[#Examples|Examples]]
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[LeadGen Xpress:Business:List/File|List/File]]
|-
|[[LeadGen Xpress:Business:List/File#File Types|File Types]]
|-
|[[LeadGen Xpress:Business:List/File#Columns in File|Columns in File]]
|}
|-
|[[LeadGen Xpress:Business:Result Codes|Business Result Codes]]
|}




{{CustomTOC}}
{{CustomTOC}}


==Return Elements==
Returned for both get-count and buy-list requests:
Returned for both get-count and buy-list requests:


Line 93: Line 42:
|-
|-
|<IncludeAll> OR <Details>
|<IncludeAll> OR <Details>
|Default output is <IncludeAll>True</IncludeAll>, unless details options are specified in request. For the example in table 2.5.2, <Details>100 – 249;500 – 999;5,000 - 9,999</Details> would be shown with all chosen options separated by semi colon.
|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>
|<AppendToFile>
Line 102: Line 51:
|-
|-
|<IncludeAll> OR <Details>
|<IncludeAll> OR <Details>
|Default output is <IncludeAll>True</IncludeAll>, unless details options are specified in request. For the example in table 2.5.2, <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.
|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>
|<AppendToFile>
Line 111: Line 60:
|-
|-
|<IncludeAll> OR <Details>
|<IncludeAll> OR <Details>
|Default output is <IncludeAll>True</IncludeAll>, unless details options are specified in request. For the example in table 2.5.2, <Details>CONSTRUCTION-SPECIAL TRADE CONTRACTORS;NONCLASSIFIED ESTABLISHMENTS;CREDIT & DEBT COUNSELING SERVICES</Details> would be shown with all chosen options separated by semi colon.
|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>
|<AppendToFile>
Line 120: Line 69:
|-
|-
|<ContactName>
|<ContactName>
|True or False. (See [[LeadGen Xpress:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for sample request.)
|True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options.
|-
|-
|<FaxNumber>
|<FaxNumber>
|True or False. (See table 2.5.4 for sample request.)
|True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options.
|-
|-
|<Phone>
|<Phone>
|True or False. (See table 2.5.4 for sample request.)
|True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options.
|-
|-
|<NAICS>
|<NAICS>
|True or False. (See table 2.5.4 for sample request.)
|True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options.
|-
|-
|<KeyExecutive>
|<KeyExecutive>
|True or False. (See table 2.5.4 for sample request.)
|True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options.
|-
|-
|<NumberOfEmployees>
|<NumberOfEmployees>
|True or False. (See table 2.5.4 for sample request.)
|True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options.
|-
|-
|<EstimatedSales>
|<EstimatedSales>
|True or False. (See table 2.5.4 for sample request.)
|True or False. See [[LeadGen:Business:Request Parameters#Other Purchase Options|Other Purchase Options]] for options.
|-
|-
|<CountDetails>
|<CountDetails>
Line 200: Line 149:
|-
|-
|<Usage>
|<Usage>
|One or multi usage specified in buy call. (See table 2.5.4 for sample request.)
|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 206: Line 155:
|-
|-
|<PONumber>
|<PONumber>
|Returned if po is specified. (See table 2.5.4 for sample request.)
|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>
|Number of records returned.
|Number of records returned.
|-
|<RequestedQty>
|Returned if &qty is specified. (See table 2.5.4 for sample request.)
|-
|-
|<Result>
|<Result>
|Indicates the status of a request. Returns Declined, Approved, or Err. (See table 5 for details.)
|Indicates the status of a request. Returns Declined, Approved, or Err. |See [[LeadGen:Business:Result Codes|Business Result Codes]] for details.
|-
|-
|<StatusCode>
|<StatusCode>
|See table 5 for details.
|See [[LeadGen:Business:Result Codes#Status Codes|Status Codes]] for details.
|-
|-
|<Errors>
|<Errors>
Line 224: Line 170:
|-
|-
|<Error>
|<Error>
|See table 6 for details.
|See [[LeadGen:Business:Result Codes#Error Codes|Error Codes]] for details.
|-
|-
|<ErrorCode>
|<ErrorCode>
Line 233: Line 179:




==Examples==
An example (from the buy list call in section 1):
An example (from the buy list call in section 1):
<pre>
<pre>
Line 273: Line 220:




[[Category:LeadGen Xpress]]
[[Category:LeadGen]]
[[Category:LeadGen Xpress Business]]
[[Category:LeadGen Business]]

Latest revision as of 17:05, 12 May 2016

← LeadGen Cloud API

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



Return Elements

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>
  • one per business
  • all contacts
<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 type returns Zip plus 4.
  • City type returns city, state.
  • County type returns county, state.
  • State type returns state.
  • Radius type returns street, city, state
<Zip> For radius type only.
<Count>

Location of count detail. The location varies by the request type:

  • ZIP type returns Zip plus 4.
  • City type returns city, state.
  • County type returns county, state.
  • State type returns state.
  • Radius type returns street.
<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:

  • ZIP type returns Zip plus 4.
  • City type returns city, state.
  • County type returns county, state.
  • State type returns state.
<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>
Retrieved from "http://wiki.melissadata.com/index.php?title=LeadGen_Business:Response&oldid=10955"