Reverse GeoCoder:Request Elements: Difference between revisions
No edit summary |
No edit summary |
||
| Line 59: | Line 59: | ||
The following elements set the basic options for each request. These apply to the entire request, not the individual records. | The following elements set the basic options for each request. These apply to the entire request, not the individual records. | ||
==Customer ID== | ==Customer ID== | ||
| Line 105: | Line 78: | ||
===REST=== | ===REST=== | ||
<pre> | <pre> | ||
id={string} | ?id = {string} | ||
</pre> | </pre> | ||
| Line 132: | Line 105: | ||
===REST=== | ===REST=== | ||
<pre> | <pre> | ||
lat={string} | &lat = {string} | ||
</pre> | </pre> | ||
| Line 159: | Line 132: | ||
===REST=== | ===REST=== | ||
<pre> | <pre> | ||
long={string} | &long = {string} | ||
</pre> | </pre> | ||
| Line 186: | Line 159: | ||
===REST=== | ===REST=== | ||
<pre> | <pre> | ||
dist={string} | &dist = {string} | ||
</pre> | </pre> | ||
| Line 213: | Line 186: | ||
===REST=== | ===REST=== | ||
<pre> | <pre> | ||
recs={string} | &recs = {string} | ||
</pre> | </pre> | ||
| Line 220: | Line 193: | ||
<RequestArray> | <RequestArray> | ||
<MaxRecords>string</MaxRecords> | <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> | </RequestArray> | ||
</pre> | </pre> | ||
| Line 230: | Line 230: | ||
===REST=== | ===REST=== | ||
<pre> | <pre> | ||
json={string} | &json = {string} | ||
</pre> | </pre> | ||
Revision as of 17:39, 2 October 2014
← Reverse GeoCoder Web Service Reference
| Reverse GeoCoder Web Service Navigation | ||||
|---|---|---|---|---|
| ||||
| ||||
| ||||
| ||||
|
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
Request.CustomerID = string
JSON
“CustomerID”:”string”
REST
?id = {string}
XML
<RequestArray> <CustomerID>string</CustomerID> </RequestArray>
Latitude
Required. The latitude geographic coordinate in decimal format.
SOAP
Request.Latitude = string
JSON
“Latitude”:”string”
REST
&lat = {string}
XML
<RequestArray> <Latitude>string</Latitude> </RequestArray>
Longitude
Required. The longitude geographic coordinate in decimal format.
SOAP
Request.Longitude = string
JSON
“Longitude”:”string”
REST
&long = {string}
XML
<RequestArray> <Longitude>string</Longitude> </RequestArray>
MaxDistance
Optional. The requested maximum distance (in miles). If no MaxDistance is specified, the default is 10 miles.
SOAP
Request.MaxDistance = string
JSON
“MaxDistance”:”string”
REST
&dist = {string}
XML
<RequestArray> <MaxDistance>string</MaxDistance> </RequestArray>
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
Request.MaxRecords = string
JSON
“MaxRecords”:”string”
REST
&recs = {string}
XML
<RequestArray> <MaxRecords>string</MaxRecords> </RequestArray>
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
Request.TransmissionReference = string
JSON
“TransmissionReference”:”string”
REST
&t = {string}
XML
<RequestArray> < TransmissionReference >string</ TransmissionReference > </RequestArray>
Format
Optional. This specifies the format of the response to be JSON.
REST
&json = {string}