IP Locator:Response
Global IP Navigation | |||
---|---|---|---|
| |||
| |||
| |||
| |||
Sample Code |
A response is the result of a request. This consists of returned results codes, IP address details, and appended geographic information.
Depending on the protocol used to make the request, the response will be in a certain protocol. IP Locator supports the following possible response protocols: JSON and REST.
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. |
RecordID
- 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
- 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”
PostalCode
Protocol Syntax JSON “PostalCode”:”string”