LeadGen Occupant:Response: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(6 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{ | {{LGXOccupantNav}} | ||
}} | |||
{{CustomTOC}} | {{CustomTOC}} | ||
==Return Elements== | |||
Returned for both get-count and buy-list requests: | Returned for both get-count and buy-list requests: | ||
Line 55: | Line 54: | ||
:<CityDeliveries_ResidentialAddresses> | :<CityDeliveries_ResidentialAddresses> | ||
|rowspan="9"| | |rowspan="9"| | ||
Options requests. True or False. See [[LeadGen: | Options requests. True or False. See [[LeadGen:Occupant:Request Parameters#Occupant Options|Occupant Options]]. | ||
|- | |- | ||
| | | | ||
Line 172: | Line 171: | ||
| | | | ||
:<StatusCode> | :<StatusCode> | ||
|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:Occupant:Result Codes#Status Codes|Status Codes]] for details. | ||
|- | |- | ||
| | | | ||
Line 180: | Line 179: | ||
| | | | ||
::<Error> | ::<Error> | ||
|See [[LeadGen: | |See [[LeadGen:Occupant:Result Codes#Error Codes|Error Codes]] for details. | ||
|- | |- | ||
| | | | ||
Line 192: | Line 191: | ||
==Examples== | ==Examples== | ||
<pre> | <pre> | ||
<Occupant> | <Occupant> | ||
Line 239: | Line 237: | ||
[[Category:LeadGen]] | [[Category:LeadGen]] | ||
[[Category:LeadGen | [[Category:LeadGen Occupant]] |
Latest revision as of 16:53, 12 May 2016
LeadGen Occupant Navigation |
---|
Introduction |
Request Parameters |
XML Response |
List/File |
Occupant Result Codes |
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 |
|
Returned if RadiusByMiles is called. Returns the number of miles. |
|
Returned if RadiusByRecordCount is called. Returns the number of records. |
<Address> | Returned if RadiusByRecords or RadisuByMiles is called. |
|
Returned if city, RadiusByRecords, or RadiusByMiles is called. This is an option only if the zip is given. |
|
Returned if county is called. This is an option only if the zip is given. |
|
Returned if city, county, RadiusByRecords, or RadiusByMiles is called. |
|
Returned if zip, RadiusByRecords, or RadiusByMiles is called. |
|
Returned if zip, city, or RadiusByMiles is called. |
<Options> | Requested options. |
|
Options requests. True or False. See Occupant Options. |
| |
| |
| |
| |
| |
| |
| |
| |
<TotalCount> | |
|
Total number of records returned. |
|
Total number of records with a name returned. |
<CarrierRoutes> | Returns a breakdown by Carrier Routes, for zip, city, and RadiusByMiles. |
|
Detailed info of each Carrier Route. |
|
5-digit ZIP |
|
4-digit Carrier Route. |
|
Number of occupants within this Carrier Route. |
<ZipCodes> | Breakdown by ZIP, for city and county types. |
|
Detailed information of each ZIP. |
|
5-digit ZIP. |
|
Number of occupants within this ZIP. |
<Streets> | Breakdown by street, for RadiusByMiles and RadiusByRecords type. |
|
Detailed information of each street. Format: street name, city, state, ZIP. |
|
Start number of the street with the requested criteria. |
|
End number of the street with the requested criteria. |
|
Number of occupants within this Carrier Route. |
|
|
<Order> | Buy Requests Only. Order details for a Buy request. |
|
Order Id. |
|
The URL to download the purchased file. |
|
Returned if po is specified. |
<Result> | Returns the status code. |
|
Indicates the status of a request. Returns Declined, Approved, or Err. See Status Codes for details. |
|
If <StatusCode> returns Err. |
|
See Error Codes for details. |
|
|
|
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>