IP Locator:Request

From Melissa Data Wiki
Revision as of 16:14, 27 June 2019 by Admin (talk | contribs)
Jump to navigation Jump to search

← Global IP

Global IP Navigation
Request Fields
Response Fields
Batch JSON
Result Codes
Result Code Use
Global IP 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

Request Elements

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

Transmission Reference

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

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.


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"


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