Reverse GeoCoder:Request Elements

From Melissa Data Wiki
Revision as of 01:41, 2 October 2014 by Admin (talk | contribs)
Jump to navigation Jump to search

← Reverse GeoCoder Web Service Reference

Reverse GeoCoder Web Service Navigation
Introduction
Licensing
Request
Request Elements
Request Record Elements
Example Request
Response
Response Elements
Response Record Elements
Example Response
Result Codes
Result Code Use
Returned Result Codes
Sample Code



The following elements set the basic options for each request. These apply to the entire request, not the individual records.

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>


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>


Format

Optional. This specifies the format of the response to be JSON.

REST

json={string}