IP Locator:Request: Difference between revisions
Jump to navigation
Jump to search
Created page with "{{IPLocatorNav |RequestCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements ..." |
No edit summary |
||
Line 98: | Line 98: | ||
[[Category:IP Locator | [[Category:IP Locator]] | ||
[[Category:Reference]] | [[Category:Reference]] |
Revision as of 19:22, 22 December 2015
Global IP Navigation | |||
---|---|---|---|
| |||
| |||
| |||
| |||
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 and at least one input IP address.
IP Locator supports multiple protocols to access the service, including JSON and REST.
Field Names
This is a list of the request field names and their protocol naming conventions.
Field Name | Level | REST Abbreviation | JSON |
---|---|---|---|
Transmission Reference | Request | t | TransmissionReference |
Customer ID | Request | id | CustomerID |
Record ID | Record | RecordID | |
IP Address | Record | 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
- 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 identification number 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.
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.
Protocol Syntax JSON “IPAddress”:”string” REST &ip = {string}