Difference between revisions of "IP Locator:Request"

From Melissa Data Wiki
Jump to navigation Jump to search
m (Admin moved page Global IP Locator:Request to IP Locator:Request without leaving a redirect)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{IPLocatorNav
 
{{IPLocatorNav
|RequestCollapse=
+
|InputOutputCollapse=
 
}}
 
}}
  
Line 6: Line 6:
 
{{CustomTOC}}
 
{{CustomTOC}}
  
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 Customer ID and at least one input IP address.
+
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 Customer ID (License Key) and at least one input IP address.
  
IP Locator supports multiple protocols to access the service, including JSON and REST.
+
IP Locator supports JSON and REST protocols.
  
  
Line 15: Line 15:
  
 
{| class="alternate01 sortable"
 
{| class="alternate01 sortable"
!Field Name !! Level !! REST Abbreviation !! JSON
+
!Field Name !! Level !! REST !! JSON
|- style="vertical-align:top;"
 
|Transmission Reference||Request||t||TransmissionReference
 
 
|-
 
|-
|Customer ID||Request||id||CustomerID
+
|Transmission Reference||rowspan="2" valign="center"|Request||t||TransmissionReference
 
|-
 
|-
|Record ID||Record|| ||RecordID
+
|Customer ID||id||CustomerID
 
|-
 
|-
|IP Address||Record||ip||IPAddress
+
|Record ID||rowspan="3" valign="center"|Record|| ||RecordID
 +
|-
 +
|IP Address||ip||IPAddress
 +
|-
 +
|Output Columns||cols||Cols
 
|}
 
|}
  
Line 30: Line 32:
 
The following elements set the basic options for each request. These apply to the entire request, not the individual records.
 
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>
+
<h3 class="h3grey">Transmission Reference</h3>
 
:''Optional.''
 
:''Optional.''
  
Line 38: Line 40:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“TransmissionReference”:”string"
+
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
 
|-
 
|-
|REST||?t = {string}
+
|REST||<code>?t = '''''string'''''</code>
 
|}
 
|}
  
  
<h3 style="background-color:rgb(240,240,240);">Customer ID</h3>
+
<h3 class="h3grey">Customer ID</h3>
 
:''Required.''
 
:''Required.''
  
:This is a string value containing the identification number issued to the customer by Melissa Data for IP Locator.
+
:This is a string value containing the License Key issued to the customer by Melissa Data for IP Locator.
  
: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 Web Service will return an error. To receive a License Key, please contact your Melissa Data sales representative at 1-800-MELISSA.
  
 
:{| class="alternate01"
 
:{| class="alternate01"
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||"CustomerID”:”string”
+
|JSON||<code>"CustomerID":"'''''string'''''"</code>
 
|-
 
|-
|REST||&id = {string}
+
|REST||<code>&id = '''''string'''''</code>
 
|}
 
|}
  
Line 72: Line 74:
  
  
<h3 style="background-color:rgb(240,240,240);">RecordID</h3>
+
<h3 class="h3grey">RecordID</h3>
 
:''Optional.''
 
:''Optional.''
  
Line 80: Line 82:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“RecordID”:”string”
+
|JSON||<code>"RecordID":"'''''string'''''"</code>
 
|}
 
|}
  
  
<h3 style="background-color:rgb(240,240,240);">IPAddress</h3>
+
<h3 class="h3grey">IPAddress</h3>
 
:''Required.''
 
:''Required.''
  
 
:The IP address to be verified.
 
:The IP address to be verified.
 +
 +
:Both IPv4 and IPv6 Input Formats are supported. For example:
 +
<pre>IPv4: 127.0.0.1
 +
IPv6: 2001:db8:85a3:0:0:8a2e:370:7334</pre>
 +
 +
:{| class="alternate01"
 +
!Protocol !! Syntax
 +
|-
 +
|JSON||<code>"IPAddress":"'''''string'''''"</code>
 +
|-
 +
|REST||<code>&ip = '''''string'''''</code>
 +
|}
 +
 +
 +
<h3 class="h3grey">Output Columns</h3>
 +
:''Optional.''
 +
 +
:Return full or partial domain information.
 +
 +
:For example:
 +
:*<code>&cols=grpdomaininfo</code> will return the full domain information.
 +
:*While <code>&cols=DomainCountry,DomainAgeEstimated,DomainAddress1,DomainAdministrativeArea</code> will only return the selected domain output columns.
  
 
:{| class="alternate01"
 
:{| class="alternate01"
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“IPAddress”:”string”
+
|JSON||<code>"Cols":"'''''string'''''"</code>
 
|-
 
|-
|REST||&ip = {string}
+
|REST||<code>&cols = '''''string'''''</code>
 
|}
 
|}
  

Latest revision as of 20:53, 20 July 2021

← IP Locator

IP Locator Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
Batch JSON
Result Codes
Result Code Use
IP Locator 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 Customer ID (License Key) and at least one input IP address.

IP Locator supports JSON and REST protocols.


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
Customer ID id CustomerID
Record ID Record RecordID
IP Address ip IPAddress
Output Columns cols Cols


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


Customer ID

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


Request Record Elements

JSON will contain the Records element.

Protocol Definition
JSON Each IP address will be contained within [{}] under the Records element.
REST The REST interface only allows a single record per request.


RecordID

Optional.
This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted.
Protocol Syntax
JSON "RecordID":"string"


IPAddress

Required.
The IP address to be verified.
Both IPv4 and IPv6 Input Formats are supported. For example:
IPv4: 127.0.0.1
IPv6: 2001:db8:85a3:0:0:8a2e:370:7334
Protocol Syntax
JSON "IPAddress":"string"
REST &ip = string


Output Columns

Optional.
Return full or partial domain information.
For example:
  • &cols=grpdomaininfo will return the full domain information.
  • While &cols=DomainCountry,DomainAgeEstimated,DomainAddress1,DomainAdministrativeArea will only return the selected domain output columns.
Protocol Syntax
JSON "Cols":"string"
REST &cols = string