Reverse GeoCoder:Request Elements: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
No edit summary
Line 1: Line 1:
[[Reverse GeoCoder Web Service:Reference|← Reverse GeoCoder Web Service Reference]]
{{ ReverseGeoCoderNav
 
|RequestCollapse=
{| 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]]
|}
|}




Line 60: Line 10:
==Customer ID==
==Customer ID==
'''Required.'''
'''Required.'''
This is a string value containing the identification number issued to the customer by Melissa Data for the Reverse GeoCoder Web Service.
This is a string value containing the identification number issued to the customer by Melissa Data for Reverse GeoCoder.


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.
If this element is absent, the service will return an error. To receive a customer ID, please contact your Melissa Data sales representative at 1-800-MELISSA.


===SOAP===
===SOAP===
Line 232: Line 182:




[[Category:Reverse GeoCoder Web Service]]
[[Category:Reverse GeoCoder]]
[[Category:Reference]]
[[Category:Reference]]

Revision as of 22:56, 10 March 2015

← 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



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 Reverse GeoCoder.

If this element is absent, the 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 {string}. Possible values for this option are "json" or "xml".

REST

&format = {string}
Retrieved from "http://wiki.melissadata.com/index.php?title=Reverse_GeoCoder:Request_Elements&oldid=8364"