LeadGen Occupant:Response

← LeadGen Cloud API

Return Elements

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

XML Element	XML Description
<Occupant>	Tag encapsulating the whole XML document.
<Geography>	Geo request
<RadiusByMiles>	Returned if RadiusByMiles is called. Returns the number of miles.
<RadiusByRecordCount>	Returned if RadiusByRecordCount is called. Returns the number of records.
<Address>	Returned if RadiusByRecords or RadisuByMiles is called.
<City>	Returned if city, RadiusByRecords, or RadiusByMiles is called. This is an option only if the zip is given.
<County>	Returned if county is called. This is an option only if the zip is given.
<State>	Returned if city, county, RadiusByRecords, or RadiusByMiles is called.
<ZIP>	Returned if zip, RadiusByRecords, or RadiusByMiles is called.
<CarrierRoute>	Returned if zip, city, or RadiusByMiles is called.
<Options>	Requested options.
<CityDeliveries_ResidentialAddresses>	Options requests. True or False. See Occupant Options.
<CityDeliveries_Apartments>
<CityDeliveries_BusinessAddresses>
<POBoxes_ResidentialAddresses>
<POBoxes_BusinessAddresses>
<RuralRoutes_ResidentialAddresses>
<RuralRoutes_Apartments>
<RuralRoutes_BusinessAddresses>
<IncludeNamesWhereAvailable>
<TotalCount>
<Count>	Total number of records returned.
<NameCount>	Total number of records with a name returned.
<CarrierRoutes>	Returns a breakdown by Carrier Routes, for zip, city, and RadiusByMiles.
<CarrierRoute>	Detailed info of each Carrier Route.
<Zip>	5-digit ZIP
<Route>	4-digit Carrier Route.
<Count>	Number of occupants within this Carrier Route.
<ZipCodes>	Breakdown by ZIP, for city and county types.
<Zip>	Detailed information of each ZIP.
<ZipCode>	5-digit ZIP.
<Count>	Number of occupants within this ZIP.
<Streets>	Breakdown by street, for RadiusByMiles and RadiusByRecords type.
<Street>	Detailed information of each street. Format: street name, city, state, ZIP.
<StartNumber>	Start number of the street with the requested criteria.
<EndNumber>	End number of the street with the requested criteria.
<Count>	Number of occupants within this Carrier Route.
<Zip>
<Order>	Buy Requests Only. Order details for a Buy request.
<Id>	Order Id.
<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

<Occupant>
  <Geography>
    <Zip>90602,92688</Zip>
    <CarrierRoute>c061-90602,c062-90602,b007-92688</CarrierRoute>
  </Geography>
  <Options>
    <CityDeliveries_ResidentialAddresses>True</CityDeliveries_ResidentialAddresses>
    <CityDeliveries_Apartments>True</CityDeliveries_Apartments>
    <CityDeliveries_BusinessAddresses>True</CityDeliveries_BusinessAddresses>
    <POBoxes_ResidentialAddresses>True</POBoxes_ResidentialAddresses>
    <POBoxes_BusinessAddresses>True</POBoxes_BusinessAddresses>
    <RuralRoutes_ResidentialAddresses>True</RuralRoutes_ResidentialAddresses>
    <RuralRoutes_Apartments>True</RuralRoutes_Apartments>
    <RuralRoutes_BusinessAddresses>True</RuralRoutes_BusinessAddresses>
    <IncludeNamesWhereAvailable>True</IncludeNamesWhereAvailable>
  </Options>
  <TotalCount>
    <Count>1737</Count>
    <NameCount>1003</NameCount>
  </TotalCount>
  <CarrierRoutes>
    <CarrierRoute>
      <Zip>90602</Zip>
      <Route>C061</Route>
      <Count>769</Count>
    </CarrierRoute>
    <CarrierRoute>
      <Zip>90602</Zip>
      <Route>C062</Route>
      <Count>872</Count>
      </CarrierRoute>
    <CarrierRoute>
      <Zip>92688</Zip>
      <Route>B007</Route>
      <Count>96</Count>
    </CarrierRoute>
    </CarrierRoutes>
    <Result>
      <StatusCode>Approved</StatusCode>
    </Result>
</Occupant>