Reverse GeoCoder:JSON: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
Created page with "{{ ReverseGeoCoderNav |RequestCollapse= }} {{CustomTOC}} ==JSON Request== <pre> { "RequestArray": { "CustomerId":"string", "Latitude":"string", "Longitude":"string", ..."
 
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{ ReverseGeoCoderNav
{{ReverseGeoCoderNav
|RequestCollapse=
|ExampleCollapse=
}}
}}


Line 6: Line 6:
{{CustomTOC}}
{{CustomTOC}}


==JSON Request==
==doLookup==
===JSON Request===
====Request Header====
The HTTP header requires the following values:
<pre>Content-Type: application/json
Accept: application/json
</pre>
 
====Request Body====
<pre>
<pre>
{
{
"RequestArray": {
   "CustomerId":"string",
   "CustomerId":"string",
   "Latitude":"string",
   "Latitude":"string",
Line 15: Line 22:
   "MaxDistance":"string",
   "MaxDistance":"string",
   "MaxRecords":"string",
   "MaxRecords":"string",
  "Options":"string",
   "TransmissionReference":"string"
   "TransmissionReference":"string"
  }
}
}
</pre>
</pre>


 
===JSON Response===
==JSON==
<pre>
<pre>
{  
{  
Line 37: Line 43:
     "PostalCode":"string",
     "PostalCode":"string",
     "AddressKey":"string",
     "AddressKey":"string",
    "Latitude":"string",
    "Longitude":"string",
    "Distance":"string",
    "MelissaAddressKey":"string",
    "MelissaAddressKeyBase":"string"
  }]
}
</pre>
==doLookupPostalCodes==
===JSON Request===
====Request Header====
The HTTP header requires the following values:
<pre>Content-Type: application/json
Accept: application/json
</pre>
====Request Body====
<pre>
{
  "CustomerId":"string",
  "Latitude":"string",
  "Longitude":"string",
  "MaxDistance":"string",
  "MaxRecords":"string",
  "Options":"string",
  "TransmissionReference":"string"
}
</pre>
===JSON Response===
<pre>
{
  "Version":"string",
  "TransmissionReference":"string",
  "TransmissionResults":"string",
  "Results":"string",
  "TotalRecords":"string",
  "Records":[
  {
    "City":"string",
    "State":"string",
    "PostalCode":"string",
     "Latitude":"string",
     "Latitude":"string",
     "Longitude":"string",
     "Longitude":"string",
     "Distance":"string"
     "Distance":"string"
  },
  {
    "City":"string",
    "State":"string",
    "PostalCode":"string",
    "Latitude":"string",
    "Longitude":"string",
    "Distance":"string"
  }]
}
</pre>
==doLookupFromList==
===JSON Request===
====Request Header====
The HTTP header requires the following values:
<pre>Content-Type: application/json
Accept: application/json
</pre>
====Request Body====
<pre>
{
  "CustomerId":"string",
  "Latitude":"string",
  "Longitude":"string",
  "MaxDistance":"string",
  "MaxRecords":"string",
  "Options":"string",
  "TransmissionReference":"string",
  "Records": [
    {"RecordID":"string", "MelissaAddressKey":"string"},
    {"RecordID":"string", "MelissaAddressKey":"string"},
    {"RecordID":"string", "MelissaAddressKey":"string"}
  ]
}
</pre>
===JSON Response===
<pre>
{
  "Version":"string",
  "TransmissionReference":"string",
  "TransmissionResults":"string",
  "Results":"string",
  "TotalRecords":"string",
  "Records":[
  {
    "AddressLine1":"string",
    "SuiteName":"string",
    "SuiteCount":"string",
    "City":"string",
    "State":"string",
    "PostalCode":"string",
    "AddressKey":"string",
    "Latitude":"string",
    "Longitude":"string",
    "Distance":"string",
    "MelissaAddressKey":"string",
    "MelissaAddressKeyBase":"string",
    "RecordID":"string"
   }]
   }]
}
}

Latest revision as of 22:08, 6 December 2021

← 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



doLookup

JSON Request

Request Header

The HTTP header requires the following values: 

Content-Type: application/json
Accept: application/json

Request Body

{
  "CustomerId":"string",
  "Latitude":"string",
  "Longitude":"string",
  "MaxDistance":"string",
  "MaxRecords":"string",
  "Options":"string",
  "TransmissionReference":"string"
}

JSON Response

{ 
  "Version":"string",
  "TransmissionReference":"string",
  "TransmissionResults":"string",
  "Results":"string",
  "TotalRecords":"string",
  "Records":[{
    "AddressLine1":"string",
    "SuiteName":"string",
    "SuiteCount":"string",
    "City":"string",
    "State":"string",
    "PostalCode":"string",
    "AddressKey":"string",
    "Latitude":"string",
    "Longitude":"string",
    "Distance":"string",
    "MelissaAddressKey":"string",
    "MelissaAddressKeyBase":"string"
  }]
}


doLookupPostalCodes

JSON Request

Request Header

The HTTP header requires the following values: 

Content-Type: application/json
Accept: application/json

Request Body

{
  "CustomerId":"string",
  "Latitude":"string",
  "Longitude":"string",
  "MaxDistance":"string",
  "MaxRecords":"string",
  "Options":"string",
  "TransmissionReference":"string"
}

JSON Response

{ 
  "Version":"string",
  "TransmissionReference":"string",
  "TransmissionResults":"string",
  "Results":"string",
  "TotalRecords":"string",
  "Records":[
  {
    "City":"string",
    "State":"string",
    "PostalCode":"string",
    "Latitude":"string",
    "Longitude":"string",
    "Distance":"string"
  },
  {
    "City":"string",
    "State":"string",
    "PostalCode":"string",
    "Latitude":"string",
    "Longitude":"string",
    "Distance":"string"
  }]
}


doLookupFromList

JSON Request

Request Header

The HTTP header requires the following values: 

Content-Type: application/json
Accept: application/json

Request Body

{
  "CustomerId":"string",
  "Latitude":"string",
  "Longitude":"string",
  "MaxDistance":"string",
  "MaxRecords":"string",
  "Options":"string",
  "TransmissionReference":"string",
  "Records": [
    {"RecordID":"string", "MelissaAddressKey":"string"},
    {"RecordID":"string", "MelissaAddressKey":"string"},
    {"RecordID":"string", "MelissaAddressKey":"string"}
  ]
}

JSON Response

{ 
  "Version":"string",
  "TransmissionReference":"string",
  "TransmissionResults":"string",
  "Results":"string",
  "TotalRecords":"string",
  "Records":[
  {
    "AddressLine1":"string",
    "SuiteName":"string",
    "SuiteCount":"string",
    "City":"string",
    "State":"string",
    "PostalCode":"string",
    "AddressKey":"string",
    "Latitude":"string",
    "Longitude":"string",
    "Distance":"string",
    "MelissaAddressKey":"string",
    "MelissaAddressKeyBase":"string",
    "RecordID":"string"
  }]
}
Retrieved from "http://wiki.melissadata.com/index.php?title=Reverse_GeoCoder:JSON&oldid=18287"