Reverse GeoCoder:JSON: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older edit
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
{{CustomTOC}}
{{CustomTOC}}


==JSON Request==
==doLookup==
A maximum of up to 100 records per request can be sent.
===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>


===Request Header===
===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"
  }]
}
</pre>
 
 
==doLookupPostalCodes==
===JSON Request===
====Request Header====
The HTTP header requires the following values:
The HTTP header requires the following values:
<pre>Content-Type: application/json
<pre>Content-Type: application/json
Line 15: Line 61:
</pre>
</pre>


===Request Body===
====Request Body====
<pre>
<pre>
{
{
"RequestArray": {
   "CustomerId":"string",
   "CustomerId":"string",
   "Latitude":"string",
   "Latitude":"string",
Line 26: Line 71:
   "Options":"string",
   "Options":"string",
   "TransmissionReference":"string"
   "TransmissionReference":"string"
  }
}
}
</pre>
</pre>


===JSON Response===
<pre>
{
  "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"
  }]
}
</pre>
==doLookupFromList==
===JSON Request===
====Request Header====
The HTTP header requires the following values:
<pre>Content-Type: application/json
Accept: application/json
</pre>


==JSON Response==
====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>
<pre>
{  
{  
Line 39: Line 137:
   "Results":"string",
   "Results":"string",
   "TotalRecords":"string",
   "TotalRecords":"string",
   "Records":[{
   "Records":[
  {
     "AddressLine1":"string",
     "AddressLine1":"string",
     "SuiteName":"string",
     "SuiteName":"string",
Line 51: Line 150:
     "Distance":"string",
     "Distance":"string",
     "MelissaAddressKey":"string",
     "MelissaAddressKey":"string",
     “MelissaAddressKeyBase":"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"