Difference between revisions of "IP Locator:Response"

From Melissa Data Wiki
Jump to navigation Jump to search
Line 16: Line 16:
 
{| class="alternate01 sortable"
 
{| class="alternate01 sortable"
 
!Field Name !! Level !! JSON
 
!Field Name !! Level !! JSON
|- style="vertical-align:top;"
 
|Version||Response||Version
 
 
|-
 
|-
|Transmission Reference||Response||TransmissionReference
+
|Version||rowspan="3" valign="center"|Response||Version
 
|-
 
|-
|Transmission Results||Response||TransmissionResults
+
|Transmission Reference||TransmissionReference
 
|-
 
|-
|Records||Response||Records
+
|Transmission Results||TransmissionResults
 
|-
 
|-
|Record ID||Record||RecordID
+
|Record ID||rowspan="16" valign="center"|Record||RecordID
 
|-
 
|-
|IP Address||Record||IPAddress
+
|IP Address||IPAddress
 
|-
 
|-
|Latitude||Record||Latitude
+
|Latitude||Latitude
 
|-
 
|-
|Longitude||Record||Longitude
+
|Longitude||Longitude
 
|-
 
|-
|Postal Code||Record||PostalCode
+
|Postal Code||PostalCode
 
|-
 
|-
|Region||Record||Region
+
|Region||Region
 
|-
 
|-
|ISP Name||Record||ISPName
+
|ISP Name||ISPName
 
|-
 
|-
|Domain Name||Record||DomainName
+
|Domain Name||DomainName
 
|-
 
|-
|City||Record||City
+
|City||City
 
|-
 
|-
|Country Name||Record||CountryName
+
|Country Name||CountryName
 
|-
 
|-
|Country Abbreviation||Record||CountryAbbreviation
+
|Country Abbreviation||CountryAbbreviation
 
|-
 
|-
|Connection Speed||Record||ConnectionSpeed
+
|Connection Speed||ConnectionSpeed
 
|-
 
|-
|Connection Type||Record||ConnectionType
+
|Connection Type||ConnectionType
 
|-
 
|-
|UTC||Record||UTC
+
|UTC||UTC
 
|-
 
|-
|Continent||Record||Continent
+
|Continent||Continent
 
|-
 
|-
|Result||Record||Result
+
|Result||Result
 
|}
 
|}
  
Line 69: Line 67:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“Version”:”string"
+
|JSON||<code>"Version":"'''''string'''''"</code>
 
|}
 
|}
  
Line 80: Line 78:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“TransmissionReference”:”string"
+
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|}
 
 
 
 
 
<h3 style="background-color:rgb(240,240,240);">Records</h3>
 
 
 
:This is the returned array of records.
 
 
 
:{| class="alternate01"
 
!Protocol !! Syntax
 
|-
 
|JSON||"Records”:[{array}]
 
 
|}
 
|}
  
Line 110: Line 97:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“RecordID”:”string”
+
|JSON||<code>"RecordID":"'''''string'''''"</code>
 
|}
 
|}
  
Line 121: Line 108:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“IPAddress”:”string”
+
|JSON||<code>"IPAddress":"'''''string'''''"</code>
 
|}
 
|}
  
Line 132: Line 119:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“Latitude”:”string”
+
|JSON||<code>"Latitude":"'''''string'''''"</code>
 
|}
 
|}
  
Line 143: Line 130:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“Longitude”:”string”
+
|JSON||<code>"Longitude":"'''''string'''''"</code>
 
|}
 
|}
  
Line 154: Line 141:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“PostalCode”:”string”
+
|JSON||<code>"PostalCode":"'''''string'''''"</code>
 
|}
 
|}
  
Line 165: Line 152:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“Region”:”string”
+
|JSON||<code>"Region":"'''''string'''''"</code>
 
|}
 
|}
  
Line 176: Line 163:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“ISPName”:”string”
+
|JSON||<code>"ISPName":"'''''string'''''"</code>
 
|}
 
|}
  
Line 187: Line 174:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“DomainName”:”string”
+
|JSON||<code>"DomainName":"'''''string'''''"</code>
 
|}
 
|}
  
Line 198: Line 185:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“City”:”string”
+
|JSON||<code>"City":"'''''string'''''"</code>
 
|}
 
|}
  
Line 209: Line 196:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“CountryName”:”string”
+
|JSON||<code>"CountryName":"'''''string'''''"</code>
 
|}
 
|}
  
Line 220: Line 207:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“CountryAbbreviation”:”string”
+
|JSON||<code>"CountryAbbreviation":"'''''string'''''"</code>
 
|}
 
|}
  
Line 231: Line 218:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“ConnectionSpeed”:”string”
+
|JSON||<code>"ConnectionSpeed":"'''''string'''''"</code>
 
|}
 
|}
  
Line 242: Line 229:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“ConnectionType”:”string”
+
|JSON||<code>"ConnectionType":"'''''string'''''"</code>
 
|}
 
|}
  
Line 253: Line 240:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“UTC”:”string”
+
|JSON||<code>"UTC":"'''''string'''''"</code>
 
|}
 
|}
  
Line 264: Line 251:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“Continent”:”string”
+
|JSON||<code>"Continent":"'''''string'''''"</code>
 
|}
 
|}
  
Line 275: Line 262:
 
!Protocol !! Syntax
 
!Protocol !! Syntax
 
|-
 
|-
|JSON||“Result”:”string”
+
|JSON||<code>"Result":"'''''string'''''"</code>
 
|}
 
|}
  

Revision as of 22:54, 7 October 2016

← 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 TransmissionReference
Transmission Results TransmissionResults
Record ID Record RecordID
IP Address IPAddress
Latitude Latitude
Longitude Longitude
Postal Code PostalCode
Region Region
ISP Name ISPName
Domain Name DomainName
City City
Country Name CountryName
Country Abbreviation CountryAbbreviation
Connection Speed ConnectionSpeed
Connection Type ConnectionType
UTC UTC
Continent Continent
Result 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"


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 where 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 where 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"