LeadGen Property:Response

From Melissa Data Wiki
Revision as of 17:31, 14 July 2015 by Admin (talk | contribs)
Jump to navigation Jump to search

← LeadGen Cloud API

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



Return Elements

Returned for both get-count and buy-list requests:

XML Element XML Description
<Property> Tag encapsulating the whole XML document.
<Geography> Geo request.
<Address>
Tags returned dependent on Geo type.
<City>
<County>
<State>
<ZIP>
<Records>
Returned if radius is called with number of records is requested.
<Miles>
Returned if radius is called with mile parameter is requested.
<Options> Property request.
<OwnerTypes>
<IncludeALL> Or <Details>
Default is: <Details>Absentees only</Details>

Otherwise: <IncludeAll>True</IncludeAll>

<AppendToFile>
True or False
<CountDetails> A breakdown of the areas’ count with the selected options.
<Area>
An included area.
<Geography>

Area details vary by the request type:

  • ZIP type returns Zip plus 4.
  • City type returns city, state.
  • County type returns county, state.
  • Radius type returns street, city, state, ZIP.
<Count>
Count of the area.
<TotalCount> Total number of records of all areas.
<Order> Buy Requests Only. Order details for a Buy request.
<Id>
Order Id.
<Usage>
<DownloadURL>
The URL to download the purchased file.
<PONumber>
Returned if po is specified.
<Result> Returns the status code.
<StatusCode>
Indicates the status of a request. Returns Declined, Approved, or Err. See Status Codes for details.
<Errors>
If <StatusCode> returns Err.
<Error>
See Error Codes for details.
<ErrorCode>
<ErrorDescription>


Examples

An example:

<Property>
  <Geography>
    <City>CA;orange,CA;irvine</City>
  </Geography>
  <Options>
    <OwnerTypes>
      <Details>Absentees only</Details>
      <AppendToFile>False</AppendToFile>
    </OwnerTypes>
  </Options>
  <CountDetails>
    <Area>
      <Geography>Orange, CA</Geography>
      <Count>16000</Count>
    </Area>
    <Area>
      <Geography>Irvine, CA</Geography>
      <Count>14000</Count>
    </Area>
  </CountDetails>
  <TotalCount>
    <Count>30000</Count>
  </TotalCount>
  <Order>
    <Id>123456</Id>
    <Usage>1</Usage>
    <DownloadURL>ftp://w10.melissadata.com/ListOrderFiles/123456.csv</DownloadURL>
  </Order>
  <Result>
    <StatusCode>Approved</StatusCode>
  </Result>
</Property>