Difference between revisions of "Reverse GeoCoder:Request Elements"

From Melissa Data Wiki
Jump to navigation Jump to search
(Redirected page to Reverse GeoCoder:Request)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Reverse GeoCoder Web Service:Reference|← Reverse GeoCoder Web Service Reference]]
#REDIRECT [[Reverse GeoCoder:Request]]
 
{| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size:9pt; color:#0645ad; padding:8px 8px;"
! style="text-align:left; color:black; border-bottom:1px solid #aaaaaa;"|'''Reverse GeoCoder Web Service Navigation'''
|-
| style="padding-right:220px;"|
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Reverse GeoCoder Web Service:Introduction|Introduction]]
|-
|[[Reverse GeoCoder Web Service:Licensing|Licensing]]
|}
|-
|
{| class="mw-collapsible" style="width:100%;"
|- align="left"
! style="color:black;"|[[Reverse GeoCoder Web Service:Request|Request]]
|-
|[[Reverse GeoCoder Web Service:Request Elements|Request Elements]]
|-
|[[Reverse GeoCoder Web Service:Example Request|Example Request]]
|}
|-
|
{| class="mw-collapsible  mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Reverse GeoCoder Web Service:Response|Response]]
|-
|[[Reverse GeoCoder Web Service:Response Elements|Response Elements]]
|-
|[[Reverse GeoCoder Web Service:Response Record Elements|Response Record Elements]]
|-
|[[Reverse GeoCoder Web Service:Example Response|Example Response]]
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Reverse GeoCoder Web Service:Result Codes|Result Codes]]
|-
|[[Reverse GeoCoder Web Service:Result Codes#Result Code Use|Result Code Use]]
|-
|[[Returned Result Codes:Web Services#Reverse GeoCoder Web Service|Returned Result Codes]]
|}
|-
|
{| <!--class="mw-collapsible mw-collapsed"--> style="width:100%;"
|- align="left"
! style="color:black;"|[[Reverse GeoCoder Web Service:Sample Code|Sample Code]]
|}
|}
 
 
{{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 identification number issued to the customer by Melissa Data for the Reverse GeoCoder Web Service.
 
If this element is absent, the Web Service will return an error. To receive a customer ID, 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). 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 Web Service]]
[[Category:Reference]]

Latest revision as of 22:28, 7 March 2019