Reverse GeoCoder:Request: 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:
{{ ReverseGeoCoderNav
{{ReverseGeoCoderNav
|RequestCollapse=
|RequestCollapse=
}}
}}
Line 5: Line 5:


{{CustomTOC}}
{{CustomTOC}}
==Request==


A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your License Key and at least one set of geo-coordinates.
A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your License Key and at least one set of geo-coordinates.
Line 15: Line 13:
==URL==
==URL==
{{URL-ReverseGeoCoder}}
{{URL-ReverseGeoCoder}}
==Field Names==
This is a list of the request field names and their protocol naming conventions.
{| class="alternate01 sortable"
!Field Name !! Level !! REST !! JSON
|-
|Transmission Reference||rowspan="7" valign="center"|Request||t||TransmissionReference
|-
|License Key||id||CustomerID
|-
|Latitude||lat||Latitude
|-
|Longitude||long||Longitude
|-
|MaxDistance||dist||MaxDistance
|-
|MaxRecords||recs||MaxRecords
|-
|Format||format||
|}
==Request Elements==
The following elements set the basic options for each request. These apply to the entire request, not the individual records.
<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>
:''Optional.''
:This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|-
|REST||<code>?t = '''''string'''''</code>
|-
|SOAP/XML||<code><TransmissionReference>'''''string'''''</TransmissionReference></code>
|}
<h3 style="background-color:rgb(240,240,240);">License Key</h3>
:''Required.''
:This is a string value containing the License Key issued to you for this product.
:If this element is absent, the Web Service will return an error. To receive a License Key, please contact your Melissa sales representative at 1-800-MELISSA.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CustomerID":"'''''string'''''"</code>
|-
|REST||<code>&id = '''''string'''''</code>
|-
|SOAP/XML||<code><CustomerID>'''''string'''''</CustomerID></code>
|}
<h3 style="background-color:rgb(240,240,240);">Latitude</h3>
:''Required.''
:The latitude geographic coordinate in decimal format.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Latitude":"'''''string'''''"</code>
|-
|REST||<code>&lat = '''''string'''''</code>
|-
|SOAP/XML||<code><Latitude>'''''string'''''</Latitude></code>
|}
<h3 style="background-color:rgb(240,240,240);">Longitude</h3>
:''Required.''
:The longitude geographic coordinate in decimal format.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Longitude":"'''''string'''''"</code>
|-
|REST||<code>&long = '''''string'''''</code>
|-
|SOAP/XML||<code><Longitude>'''''string'''''</Longitude></code>
|}
<h3 style="background-color:rgb(240,240,240);">MaxDistance</h3>
:''Optional.''
:The requested maximum distance (in miles). The maximum possible distance is 10 miles. If no MaxDistance is specified, the default is 10 miles.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MaxDistance":"'''''string'''''"</code>
|-
|REST||<code>&dist = '''''string'''''</code>
|-
|SOAP/XML||<code><MaxDistance>'''''string'''''</MaxDistance></code>
|}
<h3 style="background-color:rgb(240,240,240);">MaxRecords</h3>
:''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.
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MaxRecords":"'''''string'''''"</code>
|-
|REST||<code>&recs = '''''string'''''</code>
|-
|SOAP/XML||<code><MaxRecords>'''''string'''''</MaxRecords></code>
|}
<h3 style="background-color:rgb(240,240,240);">Format</h3>
:''Optional.''
:The desired format of the response. Possible values for this option are "json" or "xml".
:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||<code>&format = '''''string'''''</code>
|}




[[Category:Reverse GeoCoder]]
[[Category:Reverse GeoCoder]]
[[Category:Reference]]
[[Category:Reference]]

Revision as of 22:27, 7 March 2019

← 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



A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your License Key and at least one set of geo-coordinates.

Reverse GeoCoder supports multiple protocols to access the service, including SOAP, JSON, REST, and XML.


URL

REST, XML, JSON, etc.

Use URL
Standard http://reversegeo.melissadata.net/v3/WEB/ReverseGeoCode/DoLookup
Secure https://reversegeo.melissadata.net/v3/WEB/ReverseGeoCode/DoLookup


JSONP

Use URL
Standard http://reversegeo.melissadata.net/v3/jsonp/ReverseGeoCode/DoLookup
Secure https://reversegeo.melissadata.net/v3/jsonp/ReverseGeoCode/DoLookup



Field Names

This is a list of the request field names and their protocol naming conventions.

Field Name Level REST JSON
Transmission Reference Request t TransmissionReference
License Key id CustomerID
Latitude lat Latitude
Longitude long Longitude
MaxDistance dist MaxDistance
MaxRecords recs MaxRecords
Format format


Request Elements

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.
Protocol Syntax
JSON "TransmissionReference":"string"
REST ?t = string
SOAP/XML <TransmissionReference>string</TransmissionReference>


License Key

Required.
This is a string value containing the License Key issued to you for this product.
If this element is absent, the Web Service will return an error. To receive a License Key, please contact your Melissa sales representative at 1-800-MELISSA.
Protocol Syntax
JSON "CustomerID":"string"
REST &id = string
SOAP/XML <CustomerID>string</CustomerID>


Latitude

Required.
The latitude geographic coordinate in decimal format.
Protocol Syntax
JSON "Latitude":"string"
REST &lat = string
SOAP/XML <Latitude>string</Latitude>


Longitude

Required.
The longitude geographic coordinate in decimal format.
Protocol Syntax
JSON "Longitude":"string"
REST &long = string
SOAP/XML <Longitude>string</Longitude>


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.
Protocol Syntax
JSON "MaxDistance":"string"
REST &dist = string
SOAP/XML <MaxDistance>string</MaxDistance>


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.
Protocol Syntax
JSON "MaxRecords":"string"
REST &recs = string
SOAP/XML <MaxRecords>string</MaxRecords>


Format

Optional.
The desired format of the response. Possible values for this option are "json" or "xml".
Protocol Syntax
REST &format = string
Retrieved from "http://wiki.melissadata.com/index.php?title=Reverse_GeoCoder:Request&oldid=16103"