IP Locator:Response

From Melissa Data Wiki
Revision as of 01:07, 12 March 2016 by Admin (talk | contribs)
Jump to navigation Jump to search

← 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 response is the result of a request. This consists of returned results codes, IP address details, and appended geographic information.

IP Locator supports the JSON response protocol.


Field Names

This is a list of the response field names and their protocol naming conventions.

Field Name Level JSON
Version Response Version
Transmission Reference Response TransmissionReference
Transmission Results Response TransmissionResults
Records Response Records
Record ID Record RecordID
IP Address Record IPAddress
Latitude Record Latitude
Longitude Record Longitude
Postal Code Record PostalCode
Region Record Region
ISP Name Record ISPName
Domain Name Record DomainName
City Record City
Country Name Record CountryName
Country Abbreviation Record CountryAbbreviation
Connection Speed Record ConnectionSpeed
Connection Type Record ConnectionType
UTC Record UTC
Continent Record Continent
Result Record Result


Response Elements

The following elements return the details for each request. These apply to the entire request, not the individual records.

Version

The version number of the service.
Protocol Syntax
JSON “Version”:”string"


Transmission Reference

This is a string value that serves as a unique identifier for this set of records. This is the same value as the corresponding request and can be used to match requests to responses.
Protocol Syntax
JSON “TransmissionReference”:”string"


Records

This is the returned array of records.
Protocol Syntax
JSON "Records”:[{array}]


Response Record Elements

Protocol Definition
JSON Each IP address will be contained within [{}] under the Records element.


Record ID

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”


IP Address

The IP address being looked up.
Protocol Syntax
JSON “IPAddress”:”string”


Latitude

The latitude for the IP address. This usually points to the postal code.
Protocol Syntax
JSON “Latitude”:”string”


Longitude

The longitude for the IP address. This usually points to the postal code.
Protocol Syntax
JSON “Longitude”:”string”


Postal Code

The postal code where the IP address is located.
Protocol Syntax
JSON “PostalCode”:”string”


Region

The region where the IP address is located, specific meaning varies from country to country. For IPs in the US this field returns the state that the IP is located within.
Protocol Syntax
JSON “Region”:”string”


ISP Name

The name of the Internet Service Provider.
Protocol Syntax
JSON “ISPName”:”string”


Domain Name

The domain name associated with this IP address.
Protocol Syntax
JSON “DomainName”:”string”


City

The city that the IP address is located.
Protocol Syntax
JSON “City”:”string”


Country Name

The full name of the country where the IP address is located.
Protocol Syntax
JSON “CountryName”:”string”


Country Abbreviation

The ISO 3166-1 alpha-2 country code of the country where the IP address is located.
Protocol Syntax
JSON “CountryAbbreviation”:”string”


Connection Speed

The connection speed associated with this IP address. Possible values are: dialup, broadband, and ultra broadband.
Protocol Syntax
JSON “ConnectionSpeed”:”string”


Connection Type

The type of connection used by this IP address. Possible values are: dialup, wired, wifi, mobile, and satellite.
Protocol Syntax
JSON “ConnectionType”:”string”


UTC

The GMT offset for the area the IP address is located.
Protocol Syntax
JSON “UTC”:”string”


Continent

The continent where the IP address is located.
Protocol Syntax
JSON “Continent”:”string”


Result

Returns a comma delimited list of result codes that provide more information from the service.
Protocol Syntax
JSON “Result”:”string”