Admin at 00:00, 7 December 2021

2021-12-07T00:00:23Z

← Older revision		Revision as of 00:00, 7 December 2021
Line 5:		Line 5:

	{{CustomTOC}}		{{CustomTOC}}
	The ~~doLooupFromList~~ endpoint takes in a '''target''' address (lookup) and one or more '''satellite''' addresses (list) to perform a distance comparison and return the closest satellite addresses to the target address.		The doLookupFromList endpoint takes in a '''target''' address (lookup) and one or more '''satellite''' addresses (list) to perform a distance comparison and return the closest satellite addresses to the target address.

	=Request=		=Request=

Admin at 16:45, 8 October 2021

2021-10-08T16:45:52Z

Show changes

Admin: Created page with "{{ReverseGeoCoderNav |InputOutputCollapse= }} {{CustomTOC}} =Request= A request consists of a protocol to make a call to the service, detailing desired elements. The minimum..."

2021-10-07T19:01:55Z

Created page with "{{ReverseGeoCoderNav |InputOutputCollapse= }} {{CustomTOC}} =Request= A request consists of a protocol to make a call to the service, detailing desired elements. The minimum..."

New page

{{ReverseGeoCoderNav
|InputOutputCollapse=
}}

{{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.

==URL==
{{URL-ReverseGeoCoder-doLookupFromList}}
==Header==
HTTP headers need to match the protocols and formats being used.

Reverse GeoCoder requires the values of <code>Content-Type</code> and <code>Accept</code>.

===Example JSON Request Header===
<pre>{
"Content-Type": "application/json; charset=utf-8",
"Accept": "application/json"
}</pre>

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

{| class="alternate01 sortable"
!Field Name !! Level !! JSON
|-
|Transmission Reference||rowspan="11" valign="center"|Request||TransmissionReference
|-
|License Key||CustomerID
|-
|Latitude||Latitude
|-
|Longitude||Longitude
|-
|Melissa Address Key||MelissaAddressKey
|-
|MaxDistance||MaxDistance
|-
|MaxRecords||MaxRecords
|-
|Options||Options
|-
|Records||Records
|-
|Record ID||RecordID
|-
|Melissa AddressKey||MelissaAddressKey
|}

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

<h3 class="h3grey">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>
|}

<h3 class="h3grey">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>
|}

<h3 class="h3grey">Latitude</h3>
:''Required.''

:The latitude geographic coordinate in decimal format.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Latitude":"'''''string'''''"</code>
|}

<h3 class="h3grey">Longitude</h3>
:''Required.''

:The longitude geographic coordinate in decimal format.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Longitude":"'''''string'''''"</code>
|}

<h3 class="h3grey">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>
|}

<h3 class="h3grey">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>
|}

<h3 style="background-color:rgb(240,240,240);">Options</h3>
:''Optional.''

:This is a string value containing the options set by the user.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Options":"'''''string'''''"</code>
|}

:List options in the following format, with multiple options delimited with a ";".

:{| class="alternate01"
!Syntax
|-
|<code>''OptionName'':''Parameter'';''OptionName'':''Parameter''</code>
|}

:<h4 style="border-bottom:1px solid black;">TEST</h4>
::This options is a test.

::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
|-
|rowspan="2"|'''TEST'''||<code>Off</code>||'''''Default.''''' Test.
|-
|<code>On</code>||
|}

<h3 class="h3grey">Records</h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Records":"'''''string'''''"</code>
|}

<h3 class="h3grey">RecordID</h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"RecordID":"'''''string'''''"</code>
|}

<h3 class="h3grey">MelissaAddressKey</h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MelissaAddressKey":"'''''string'''''"</code>
|}

=Response=
A response is the result of a request. This consists of returned results codes and returned addresses, depending on the input provided.

Depending on the protocol used to make the request, the response will be in a certain protocol. Reverse GeoCoder supports these response protocols: XML, and JSON.

==Field Names==
This is a list of the response field names and their protocol naming conventions.

{| class="alternate01 sortable"
!Field Name !! Level !! JSON/XML
|-
|Version||rowspan="5" valign="center"|Response (Base)||Version
|-
|Transmission Reference||TransmissionReference
|-
|Transmission Results||TransmissionResults
|-
|Results||Results
|-
|Total Records||TotalRecords
|-
|Records||rowspan="14" valign="center"|Record||Records
|-
|Address Line 1||AddressLine1
|-
|Suite Name||SuiteName
|-
|Suite Count||SuiteCount
|-
|City||City
|-
|State||State
|-
|Postal Code||PostalCode
|-
|AddressKey||AddressKey
|-
|Latitude||Latitude
|-
|Longitude||Longitude
|-
|Distance||Distance
|-
|Melissa AddressKey||MelissaAddressKey
|-
|Melissa AddressKey Base||MelissaAddressKeyBase
|-
|Record ID||RecordID
|}

==Response Elements==
The following elements are the basic options for each request. These apply to the entire response, not the individual records.

<h3 class="h3grey">Version</h3>
:This is a string value that is the current revision number of Reverse GeoCoder.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Version":"'''''string'''''"</code>
|}

<h3 class="h3grey">Transmission Reference</h3>
:This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|}

<h3 class="h3grey">Transmission Results</h3>
:This is a string value that lists error codes from any errors caused by the most recent request as a whole.

:For a complete list of error codes, see [[Result Code Details#Reverse GeoCoder|Reverse GeoCoder Result Codes]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionResults":"'''''string'''''"</code>
|}

<h3 class="h3grey">Results</h3>
:This is a string value with comma delimited status, error codes, and change codes for the record.

:For a complete list of error codes, see [[Result Code Details#Reverse GeoCoder|Reverse GeoCoder Result Codes]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Results":"'''''string'''''"</code>
|}

<h3 class="h3grey">Total Records</h3>
:Displays the total number of records returned.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TotalRecords":"'''''string'''''"</code>
|}

==Response Record Elements==
JSON will only contain the Records element.

:{| class="alternate01"
!Protocol !! Definition
|-
|JSON||Each record will be contained within [{}] under the Records element.
|}

Each of the following elements are returned for each record in the Response Array.

<h3 class="h3grey">AddressLine1</h3>
:Returns the street address (street number and street name) that corresponds to the input geo coordinates.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressLine1":"'''''string'''''"</code>
|}

<h3 class="h3grey">SuiteName</h3>
:Returns the suite name of the address returned. Values that could be returned are: Ste, Apt., etc.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SuiteName":"'''''string'''''"</code>
|}

<h3 class="h3grey">SuiteCount</h3>
:Returns the number of suites in a particular building. Zero will be returned if the address has a no suites (a single delivery point).

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"SuiteCount":"'''''string'''''"</code>
|}

<h3 class="h3grey">City</h3>
:Returns the city of the output address.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"City":"'''''string'''''"</code>
|}

<h3 class="h3grey">State</h3>
:Returns the State of the output address.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"State":"'''''string'''''"</code>
|}

<h3 class="h3grey">PostalCode</h3>
:Returns the Postal Code of the output address.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PostalCode":"'''''string'''''"</code>
|}

<h3 class="h3grey">AddressKey</h3>
:Returns the address's addresskey.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"AddressKey":"'''''string'''''"</code>
|}

<h3 class="h3grey">Latitude</h3>
:Returns the latitude geographic coordinate of the output address.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Latitude":"'''''string'''''"</code>
|}

<h3 class="h3grey">Longitude</h3>
:Returns the longitude geographic coordinate of the output address.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Longitude":"'''''string'''''"</code>
|}

<h3 class="h3grey">Distance</h3>
:Returns the distance in miles between the input coordinates and the output coordinates. A distance of zero indicates that an exact address match was returned for the input geographic coordinates.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Distance":"'''''string'''''"</code>
|}

<h3 class="h3grey">MelissaAddressKey</h3>
:Returns the Melissa Address Key (MAK). This is a globally unique and persistent key for the location, even if parts of the address change. When an address is fully validated this field returns a 10-digit proprietary key for the address.

:With AddressKey (US and Canada only), if an address zip code changes, the AddressKey would also change. Melissa Address Key (MAK) is independent and will not change. This makes MAK a good way to permanently identify and locate addresses. Once you have a MAK it can be used as an input in most Melissa services and thus is a good tool for deduping.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MelissaAddressKey":"'''''string'''''"</code>
|}

<h3 class="h3grey">MelissaAddressKeyBase</h3>
:Returns the Melissa Address Key Base (BaseMAK). Every full address has its own Melissa Address Key (MAK). If that address is a suites or apartment, we will also return a Melissa Address Key Base (BaseMAK) that corresponds to the overall building. This provides a link between all the individual MAK addresses that belong to the same building. This field also returns a 10-digit proprietary key. Note, if we can validate the address to the building but not the suite, we can return just the BaseMAK.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MelissaAddressKeyBase":"'''''string'''''"</code>
|}

<h3 class="h3grey">RecordID</h3>
:

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"RecordID":"'''''string'''''"</code>
|}

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

Reverse GeoCoder:doLookupFromList - Revision history

Admin at 00:00, 7 December 2021

Admin at 16:45, 8 October 2021

Admin: Created page with "{{ReverseGeoCoderNav |InputOutputCollapse= }} {{CustomTOC}} =Request= A request consists of a protocol to make a call to the service, detailing desired elements. The minimum..."