LeadGen Consumer:Response: Difference between revisions
Jump to navigation
Jump to search
Created page with "{{LGXConsumerNav |ResponseCollapse= }} {{CustomTOC}} ==Return Elements== Returned for both get-count and buy-list requests: {|class="alternate01" cellspacing="0" !XML Elem..." |
m Admin moved page LeadGen:Consumer:Response to LeadGen Consumer:Response |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{LGXConsumerNav | {{LGXConsumerNav}} | ||
}} | |||
Latest revision as of 16:42, 12 May 2016
| LeadGen Consumer Navigation |
|---|
| Introduction |
| Request Parameters |
| XML Response |
| List/File |
| Consumer Result Codes |
Return Elements
Returned for both get-count and buy-list requests:
| XML Element | XML Description |
|---|---|
| <Consumer> | Tag encapsulating the whole XML document. |
| <Geography> | Geo request |
|
Requests within Geo Selects. Tags returned depend on Geo type. |
| |
| |
| |
| |
|
Returned if Radius is called with &records specification. |
|
Returned if Radius is called with &mile specification. |
| <Options> | Requested options. |
|
Specific options tag within Demographic Selects. |
| |
| |
|
|
|
|
|
Depends on request options. Tags included from this tag to <TargetHomeValuationModelIn1000s> inclusive. |
| |
|
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <CountDetails> | Contains a breakdown of the total count. |
|
Contains a breakdown of the street range. |
|
Individual streets. |
|
For Geo types radius and street. Shows the starting street number and ending street number in the count. |
| |
|
Location of count detail. The location varies by the request type:
|
|
For radius and street types. |
|
Number of records that <StartNumber>, <EndNumber>, <Geography>, and <Zip> apply to. |
|
Contains a breakdown of the addresses returned. |
|
Individual addresses. |
|
<TotalCount> |
Total number of records returned with the selected options. |
|
<Order> |
Buy Requests Only. Order details for a Buy request. |
|
Order Id. |
|
|
|
The URL to download the purchased file. |
|
Returned if po is specified. |
|
|
|
Returned if &qty is specified. |
|
<Result> |
Returns the status code. |
|
Indicates the status of the ID. Returns Declined, Approved, or Err. If Err is returned, see Result Codes for more information. |
Examples
Get Call
http://list.melissadata.net/V1/Consumer/rest/Service.svc/get/radius?id=customer@domain.com&addr=22382 avenida empresa&zip=92688&records=100&dwell=2&hinc-d=1-3-5
XML Output
<Consumer>
<Geography>
<Address>22382 Avenida Empresa</Address>
<City>Rancho Santa Margarita</City>
<State>CA</State>
<Zip>92688</Zip>
<Records>100</Records>
</Geography>
<Options>
<ContactPersonInfo>
<ContactPersonInfo>One per Address</ContactPersonInfo>
</ContactPersonInfo>
<BuildingType>
<Details>Single Family Only</Details>
</BuildingType>
<HouseholdIncome>
<Details>$0 - 14,999;$20,000 - 29,999;$40,000 - 49,999</Details>
<AppendToFile>False</AppendToFile>
</HouseholdIncome>
<ContactAgeGroup>
<IncludeAll>True</IncludeAll>
<AppendToFile>False</AppendToFile>
</ContactAgeGroup>
<HomeOwnerRenter>
<IncludeAll>True</IncludeAll>
<AppendToFile>False</AppendToFile>
</HomeOwnerRenter>
<MaritalStatus>
<IncludeAll>True</IncludeAll>
<AppendToFile>False</AppendToFile>
</MaritalStatus>
<LengthOfResidentCode>
<IncludeAll>True</IncludeAll>
<AppendToFile>False</AppendToFile>
</LengthOfResidentCode>
<HouseholdAgeCode>
<IncludeAll>True</IncludeAll>
<AppendToFile>False</AppendToFile>
</HouseholdAgeCode>
<Gender>
<IncludeAll>True</IncludeAll>
<AppendToFile>False</AppendToFile>
</Gender>
<NumPersonsInHousehold>
<IncludeAll>True</IncludeAll>
<AppendToFile>False</AppendToFile>
</NumPersonsInHousehold>
<NumAdultsInHousehold>
<IncludeAll>True</IncludeAll>
<AppendToFile>False</AppendToFile>
</NumAdultsInHousehold>
<NumChildrenInHousehold>
<IncludeAll>True</IncludeAll>
<AppendToFile>False</AppendToFile>
</NumChildrenInHousehold>
<HouseholdCreditCardInfo>
<IncludeAll>True</IncludeAll>
<AppendToFile>False</AppendToFile>
</HouseholdCreditCardInfo>
<MailResponsiveInfo>
<IncludeAll>True</IncludeAll>
<AppendToFile>False</AppendToFile>
</MailResponsiveInfo>
<NetWorthModel>
<IncludeAll>True</IncludeAll>
<AppendToFile>False</AppendToFile>
</NetWorthModel>
<TargetHomeValuationModeIn1000s>
<IncludeAll>True</IncludeAll>
<AppendToFile>False</AppendToFile>
</TargetHomeValuationModeIn1000s>
<AdditionalAppend/>
</Options>
<CountDetails>
<StreetRange>
<Street>
<StartNumber>60</StartNumber>
<EndNumber>96</EndNumber>
<Geography>ABRIGO , Rancho Santa Margarita CA</Geography>
<Count>5</Count>
</Street>
...
</StreetRange>
<TotalCount>
<Count>100</Count>
</TotalCount>
<Result>
<StatusCode>Approved</StatusCode>
</Result>
</CountDetails>
</Consumer>