Difference between revisions of "Reverse GeoCoder:XML"

From Melissa Data Wiki
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
 
{{CustomTOC}}
 
{{CustomTOC}}
  
==XML Request==
+
==doLookup==
A maximum of up to 100 records per request can be sent.
+
===XML Request===
 
+
====Request Header====
===Request Header===
 
 
The HTTP header requires the following values:
 
The HTTP header requires the following values:
 
<pre>Content-Type: application/json
 
<pre>Content-Type: application/json
Line 15: Line 14:
 
</pre>
 
</pre>
  
===Request Body===
+
====Request Body====
 
<pre>
 
<pre>
 
<RequestArray>
 
<RequestArray>
Line 28: Line 27:
 
</pre>
 
</pre>
  
 
+
===XML Response===
==XML Response==
 
 
<pre>
 
<pre>
 
<ResponseArray>
 
<ResponseArray>
Line 54: Line 52:
 
   </Records>
 
   </Records>
 
</ResponseArray>
 
</ResponseArray>
 +
</pre>
 +
 +
 +
==doLookupPostalCodes==
 +
===XML Request===
 +
====Request Header====
 +
The HTTP header requires the following values:
 +
<pre>Content-Type: application/json
 +
Accept: application/json
 +
</pre>
 +
 +
====Request Body====
 +
<pre>
 +
<RequestArray>
 +
  <CustomerId>string</CustomerId>
 +
  <Latitude>string</Latitude>
 +
  <Longitude>string</Longitude>
 +
  <MaxDistance>string</MaxDistance>
 +
  <MaxRecords>string</MaxRecords>
 +
  <TransmissionReference>string</TransmissionReference>
 +
  <Options>string</Options>
 +
</RequestArray>
 +
</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>
 +
    <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:08, 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

XML Request

Request Header

The HTTP header requires the following values:

Content-Type: application/json
Accept: application/json

Request Body

<RequestArray>
  <CustomerId>string</CustomerId>
  <Latitude>string</Latitude>
  <Longitude>string</Longitude>
  <MaxDistance>string</MaxDistance>
  <MaxRecords>string</MaxRecords>
  <TransmissionReference>string</TransmissionReference>
  <Options>string</Options>
</RequestArray>

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

XML Request

Request Header

The HTTP header requires the following values:

Content-Type: application/json
Accept: application/json

Request Body

<RequestArray>
  <CustomerId>string</CustomerId>
  <Latitude>string</Latitude>
  <Longitude>string</Longitude>
  <MaxDistance>string</MaxDistance>
  <MaxRecords>string</MaxRecords>
  <TransmissionReference>string</TransmissionReference>
  <Options>string</Options>
</RequestArray>

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>
    <PostalLookupResponseRecord>
      <City>string</City>
      <State>string</State>
      <PostalCode>string</PostalCode>
      <Latitude>string</Latitude>
      <Longitude>string</Longitude>
      <Distance>string</Distance>
    </PostalLookupResponseRecord>
  </Records>
</PostalResponseArray>