LeadGen Occupant:Response - Revision history

Admin at 16:53, 12 May 2016

2016-05-12T16:53:29Z

← Older revision		Revision as of 16:53, 12 May 2016
Line 1:		Line 1:
	{{LGXOccupantNav		{{LGXOccupantNav}}
	~~\|ResponseCollapse=~~
	}}

Admin: Admin moved page LeadGen:Occupant:Response to LeadGen Occupant:Response

2016-05-12T16:53:20Z

Admin moved page LeadGen:Occupant:Response to LeadGen Occupant:Response

← Older revision	Revision as of 16:53, 12 May 2016
(No difference)

Admin at 17:30, 14 July 2015

2015-07-14T17:30:42Z

← Older revision		Revision as of 17:30, 14 July 2015
Line 6:		Line 6:
	{{CustomTOC}}		{{CustomTOC}}

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

Admin at 21:35, 13 July 2015

2015-07-13T21:35:48Z

← Older revision		Revision as of 21:35, 13 July 2015
Line 192:		Line 192:

	==Examples==		==Examples==
	~~An example (from the buy list call in section 1):~~
	<pre>		<pre>
	<Occupant>		<Occupant>

Admin: Admin moved page LeadGen:Saturation:Response to LeadGen:Occupant:Response

2015-07-07T19:41:11Z

Admin moved page LeadGen:Saturation:Response to LeadGen:Occupant:Response

← Older revision	Revision as of 19:41, 7 July 2015
(No difference)

Admin at 19:40, 7 July 2015

2015-07-07T19:40:59Z

← Older revision		Revision as of 19:40, 7 July 2015
Line 1:		Line 1:
	{{~~LGXSaturationNav~~		{{LGXOccupantNav
	\|ResponseCollapse=		\|ResponseCollapse=
	}}		}}
Line 55:		Line 55:
	:<CityDeliveries_ResidentialAddresses>		:<CityDeliveries_ResidentialAddresses>
	\|rowspan="9"\|		\|rowspan="9"\|
	Options requests. True or False. See [[LeadGen:~~Saturation~~:Request Parameters#~~Saturation~~ Options\|~~Saturation~~ Options]].		Options requests. True or False. See [[LeadGen:Occupant:Request Parameters#Occupant Options\|Occupant Options]].
	\|-		\|-
	\|		\|
Line 172:		Line 172:
	\|		\|
	:<StatusCode>		:<StatusCode>
	\|Indicates the status of a request. Returns Declined, Approved, or Err. See [[LeadGen:~~Saturation~~:Result Codes#Status Codes\|Status Codes]] for details.		\|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 180:
	\|		\|
	::<Error>		::<Error>
	\|See [[LeadGen:~~Saturation~~:Result Codes#Error Codes\|Error Codes]] for details.		\|See [[LeadGen:Occupant:Result Codes#Error Codes\|Error Codes]] for details.
	\|-		\|-
	\|		\|
Line 239:		Line 239:

	[[Category:LeadGen]]		[[Category:LeadGen]]
	[[Category:LeadGen ~~Saturation~~]]		[[Category:LeadGen Occupant]]

Admin: Admin moved page LeadGen Xpress:Saturation:Response to LeadGen:Saturation:Response

2015-07-07T19:33:05Z

Admin moved page LeadGen Xpress:Saturation:Response to LeadGen:Saturation:Response

← Older revision	Revision as of 19:33, 7 July 2015
(No difference)

Admin at 19:32, 7 July 2015

2015-07-07T19:32:55Z

← Older revision		Revision as of 19:32, 7 July 2015
Line 55:		Line 55:
	:<CityDeliveries_ResidentialAddresses>		:<CityDeliveries_ResidentialAddresses>
	\|rowspan="9"\|		\|rowspan="9"\|
	Options requests. True or False. See [[LeadGen ~~Xpress~~:Saturation:Request Parameters#Saturation Options\|Saturation Options]].		Options requests. True or False. See [[LeadGen:Saturation:Request Parameters#Saturation Options\|Saturation Options]].
	\|-		\|-
	\|		\|
Line 172:		Line 172:
	\|		\|
	:<StatusCode>		:<StatusCode>
	\|Indicates the status of a request. Returns Declined, Approved, or Err. See [[LeadGen ~~Xpress~~:Saturation:Result Codes#Status Codes\|Status Codes]] for details.		\|Indicates the status of a request. Returns Declined, Approved, or Err. See [[LeadGen:Saturation:Result Codes#Status Codes\|Status Codes]] for details.
	\|-		\|-
	\|		\|
Line 180:		Line 180:
	\|		\|
	::<Error>		::<Error>
	\|See [[LeadGen ~~Xpress~~:Saturation:Result Codes#Error Codes\|Error Codes]] for details.		\|See [[LeadGen:Saturation:Result Codes#Error Codes\|Error Codes]] for details.
	\|-		\|-
	\|		\|
Line 238:		Line 238:


	[[Category:LeadGen ~~Xpress~~]]		[[Category:LeadGen]]
	[[Category:LeadGen ~~Xpress~~ Saturation]]		[[Category:LeadGen Saturation]]

Admin: Created page with "{{LGXSaturationNav |ResponseCollapse= }} {{CustomTOC}} Returned for both get-count and buy-list requests: {|class="alternate01" cellspacing="0" !XML Element !style="border..."

2015-03-05T00:40:14Z

Created page with "{{LGXSaturationNav |ResponseCollapse= }} {{CustomTOC}} Returned for both get-count and buy-list requests: {|class="alternate01" cellspacing="0" !XML Element !style="border..."

New page

{{LGXSaturationNav
|ResponseCollapse=
}}

{{CustomTOC}}

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

{|class="alternate01" cellspacing="0"
!XML Element
!style="border-right:0px;"|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.
|-
|style="margin-left:4px;"|<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>
|rowspan="9"|
Options requests. True or False. See [[LeadGen Xpress:Saturation:Request Parameters#Saturation Options|Saturation 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 [[LeadGen Xpress:Saturation:Result Codes#Status Codes|Status Codes]] for details.
|-
|
:<Errors>
|If <StatusCode> returns Err.
|-
|
::<Error>
|See [[LeadGen Xpress:Saturation:Result Codes#Error Codes|Error Codes]] for details.
|-
|
:::<ErrorCode>
|rowspan="2"|
|-
|
:::<ErrorDescription>
|}

==Examples==
An example (from the buy list call in section 1):
<pre>
<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>
</pre>

[[Category:LeadGen Xpress]]
[[Category:LeadGen Xpress Saturation]]