Difference between revisions of "Reverse GeoCoder:REST XML"

From Melissa Data Wiki
Jump to navigation Jump to search
(Created page with "{{ ReverseGeoCoderNav |RequestCollapse= }} {{CustomTOC}} ==REST Request== There is no recordID element because a REST request can only submit one record per request: <pre>...")
 
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{ ReverseGeoCoderNav
{{ReverseGeoCoderNav
|RequestCollapse=
|ExampleCollapse=
}}
}}


Line 6: Line 6:
{{CustomTOC}}
{{CustomTOC}}


==REST Request==
==doLookup==
===REST Request===
There is no recordID element because a REST request can only submit one record per request:
There is no recordID element because a REST request can only submit one record per request:


Line 17: Line 18:
&recs={MaxRecords}
&recs={MaxRecords}
&t={TransmissionReference}
&t={TransmissionReference}
&opt={Options}
&format=xml
</pre>
</pre>


 
===XML Response===
==XML==
<pre>
<pre>
<ResponseArray>
<ResponseArray>
Line 40: Line 42:
       <Longitude>string</Longitude>
       <Longitude>string</Longitude>
       <Distance>string</Distance>
       <Distance>string</Distance>
      <MelissaAddressKey>string</MelissaAddressKey>
      <MelissaAddressKeyBase>string</MelissaAddressKeyBase>
     </ResponseRecord>
     </ResponseRecord>
   </Records>
   </Records>
</ResponseArray>
</ResponseArray>
</pre>
==doLookupPostalCodes==
===REST Request===
There is no recordID element because a REST request can only submit one record per request:
<pre>
http://ReverseGeo.melissadata.net/V3/WEB/ReverseGeoCode/doLookupPostalCodes
?id={CustomerId}
&lat={Latitude}
&long={Longitude}
&dist={MaxDistance}
&recs={MaxRecords}
&t={TransmissionReference}
&opt={Options}
&format=xml
</pre>
===XML Response===
<pre>
<PostalResponseArray>
  <Version>string</Version>
  <TransmissionReference>string</TransmissionReference>
  <TransmissionResults>string</TransmissionResults>
  <Results>string</Results>
  <TotalRecords>string</TotalRecords>
  <Records>
    <PostalLookupResponseRecord>
      <City>string</City>
      <State>string</State>
      <PostalCode>string</PostalCode>
      <Latitude>string</Latitude>
      <Longitude>string</Longitude>
      <Distance>string</Distance>
    </PostalLookupResponseRecord>
  </Records>
</PostalResponseArray>
</pre>
</pre>



Latest revision as of 22:07, 6 December 2021

← Reverse GeoCoder

Reverse GeoCoder Navigation
Introduction
Licensing
Input/Output
doLookup
  ↳  Request
  ↳  Response
doLookupPostalCodes
  ↳  Request
  ↳  Response
doLookupFromList
  ↳  Request
  ↳  Response
Examples
REST XML
REST JSON
JSON
XML
Result Codes
Result Code Use
Reverse GeoCoder Result Codes
Sample Code



doLookup

REST Request

There is no recordID element because a REST request can only submit one record per request:

http://ReverseGeo.melissadata.net/V3/WEB/ReverseGeoCode/doLookup
?id={CustomerId}
&lat={Latitude}
&long={Longitude}
&dist={MaxDistance}
&recs={MaxRecords}
&t={TransmissionReference}
&opt={Options}
&format=xml

XML Response

<ResponseArray>
  <Version>string</Version>
  <TransmissionReference>string</TransmissionReference>
  <TransmissionResults>string</TransmissionResults>
  <Results>string</Results>
  <TotalRecords>string</TotalRecords>
  <Records>
    <ResponseRecord>
      <AddressLine1>string</AddressLine1>
      <SuiteName>string</SuiteName>
      <SuiteCount>string</SuiteCount>
      <City>string</City>
      <State>string</State>
      <PostalCode>string</PostalCode>
      <AddressKey>string</AddressKey>
      <Latitude>string</Latitude>
      <Longitude>string</Longitude>
      <Distance>string</Distance>
      <MelissaAddressKey>string</MelissaAddressKey>
      <MelissaAddressKeyBase>string</MelissaAddressKeyBase>
    </ResponseRecord>
  </Records>
</ResponseArray>


doLookupPostalCodes

REST Request

There is no recordID element because a REST request can only submit one record per request:

http://ReverseGeo.melissadata.net/V3/WEB/ReverseGeoCode/doLookupPostalCodes
?id={CustomerId}
&lat={Latitude}
&long={Longitude}
&dist={MaxDistance}
&recs={MaxRecords}
&t={TransmissionReference}
&opt={Options}
&format=xml

XML Response

<PostalResponseArray>
  <Version>string</Version>
  <TransmissionReference>string</TransmissionReference>
  <TransmissionResults>string</TransmissionResults>
  <Results>string</Results>
  <TotalRecords>string</TotalRecords>
  <Records>
    <PostalLookupResponseRecord>
      <City>string</City>
      <State>string</State>
      <PostalCode>string</PostalCode>
      <Latitude>string</Latitude>
      <Longitude>string</Longitude>
      <Distance>string</Distance>
    </PostalLookupResponseRecord>
  </Records>
</PostalResponseArray>