Difference between revisions of "Reverse GeoCoder:Request Elements"

From Melissa Data Wiki
Jump to navigation Jump to search
(Redirected page to Reverse GeoCoder:Request)
 
Line 1: Line 1:
{{ ReverseGeoCoderNav
#REDIRECT [[Reverse GeoCoder:Request]]
|RequestCollapse=
}}
 
 
{{CustomTOC}}
 
The following elements set the basic options for each request. These apply to the entire request, not the individual records.
 
==Customer ID==
'''Required.'''
This is a string value containing the License Key issued to the customer by Melissa Data for Reverse GeoCoder.
 
If this element is absent, the service will return an error. To receive a License Key, please contact your Melissa Data sales representative at 1-800-MELISSA.
 
===SOAP===
<pre>
Request.CustomerID = string
</pre>
 
===JSON===
<pre>
“CustomerID”:”string”
</pre>
 
===REST===
<pre>
?id = {string}
</pre>
 
===XML===
<pre>
<RequestArray>
  <CustomerID>string</CustomerID>
</RequestArray>
</pre>
 
 
==Latitude==
'''Required.'''
The latitude geographic coordinate in decimal format.
 
===SOAP===
<pre>
Request.Latitude = string
</pre>
 
===JSON===
<pre>
“Latitude”:”string”
</pre>
 
===REST===
<pre>
&lat = {string}
</pre>
 
===XML===
<pre>
<RequestArray>
  <Latitude>string</Latitude>
</RequestArray>
</pre>
 
 
==Longitude==
'''Required.'''
The longitude geographic coordinate in decimal format.
 
===SOAP===
<pre>
Request.Longitude = string
</pre>
 
===JSON===
<pre>
“Longitude”:”string”
</pre>
 
===REST===
<pre>
&long = {string}
</pre>
 
===XML===
<pre>
<RequestArray>
  <Longitude>string</Longitude>
</RequestArray>
</pre>
 
 
==MaxDistance==
'''Optional.'''
The requested maximum distance (in miles). The maximum possible distance is 10 miles. If no MaxDistance is specified, the default is 10 miles.
 
===SOAP===
<pre>
Request.MaxDistance = string
</pre>
 
===JSON===
<pre>
“MaxDistance”:”string”
</pre>
 
===REST===
<pre>
&dist = {string}
</pre>
 
===XML===
<pre>
<RequestArray>
  <MaxDistance>string</MaxDistance>
</RequestArray>
</pre>
 
 
==MaxRecords==
'''Optional.'''
The requested number of records. The Maximum number of records the user can get is 100 records. This is also the default if no MaxRecords is specified.
 
===SOAP===
<pre>
Request.MaxRecords = string
</pre>
 
===JSON===
<pre>
“MaxRecords”:”string”
</pre>
 
===REST===
<pre>
&recs = {string}
</pre>
 
===XML===
<pre>
<RequestArray>
  <MaxRecords>string</MaxRecords>
</RequestArray>
</pre>
 
 
==Transmission Reference==
'''Optional.'''
This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
 
===SOAP===
<pre>
Request.TransmissionReference = string
</pre>
 
===JSON===
<pre>
“TransmissionReference”:”string”
</pre>
 
===REST===
<pre>
&t = {string}
</pre>
 
===XML===
<pre>
<RequestArray>
  < TransmissionReference >string</ TransmissionReference >
</RequestArray>
</pre>
 
 
==Format==
'''Optional.'''
This specifies the format of the response to be {string}. Possible values for this option are "json" or "xml".
 
===REST===
<pre>
&format = {string}
</pre>
 
 
[[Category:Reverse GeoCoder]]
[[Category:Reference]]

Latest revision as of 22:28, 7 March 2019