Difference between revisions of "IP Locator:Request"
Jump to navigation
Jump to search
m (Admin moved page Global IP Locator:Request to IP Locator:Request without leaving a redirect) |
|||
| Line 8: | Line 8: | ||
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 and at least one input IP address. | ||
| − | IP Locator supports | + | IP Locator supports JSON and REST protocols. |
| Line 15: | Line 15: | ||
{| class="alternate01 sortable" | {| class="alternate01 sortable" | ||
| − | !Field Name !! Level !! REST | + | !Field Name !! Level !! REST !! JSON |
| − | |||
| − | |||
|- | |- | ||
| − | | | + | |Transmission Reference||rowspan="2" valign="center"|Request||t||TransmissionReference |
|- | |- | ||
| − | | | + | |Customer ID||id||CustomerID |
|- | |- | ||
| − | | | + | |Record ID||rowspan="2" valign="center"|Record|| ||RecordID |
| + | |- | ||
| + | |IP Address||ip||IPAddress | ||
|} | |} | ||
| Line 38: | Line 38: | ||
!Protocol !! Syntax | !Protocol !! Syntax | ||
|- | |- | ||
| − | |JSON|| | + | |JSON||<code>"TransmissionReference":"'''''string'''''"</code> |
|- | |- | ||
| − | |REST||?t = | + | |REST||<code>?t = '''''string'''''</code> |
|} | |} | ||
| Line 54: | Line 54: | ||
!Protocol !! Syntax | !Protocol !! Syntax | ||
|- | |- | ||
| − | |JSON||" | + | |JSON||<code>"CustomerID":"'''''string'''''"</code> |
|- | |- | ||
| − | |REST||&id = | + | |REST||<code>&id = '''''string'''''</code> |
|} | |} | ||
| Line 80: | Line 80: | ||
!Protocol !! Syntax | !Protocol !! Syntax | ||
|- | |- | ||
| − | |JSON|| | + | |JSON||<code>"RecordID":"'''''string'''''"</code> |
|} | |} | ||
| Line 92: | Line 92: | ||
!Protocol !! Syntax | !Protocol !! Syntax | ||
|- | |- | ||
| − | |JSON|| | + | |JSON||<code>"IPAddress":"'''''string'''''"</code> |
|- | |- | ||
| − | |REST||&ip = | + | |REST||<code>&ip = '''''string'''''</code> |
|} | |} | ||
Revision as of 22:13, 7 October 2016
| IP Locator 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 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
- 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