POST User/getipaddress
Get the IP Address of the caller.
Request Information
URI Parameters
None.
Body Parameters
GetIPAddressRequestName | Description | Type | Additional information |
---|---|---|---|
userName |
userName (optional) |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "userName": "sample string 1" }
application/xml, text/xml
Sample:
<GetIPAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.User"> <userName>sample string 1</userName> </GetIPAddressRequest>
Response Information
Resource Description
GetIPAddressResponseName | Description | Type | Additional information |
---|---|---|---|
code |
API result code |
integer |
None. |
error |
API error message |
string |
None. |
IPAddress |
User's IP Address |
string |
None. |
GeoFenceIsEnabled |
GeoFence Is Enabled |
boolean |
None. |
Accuracy |
GeoFence requested accuracy in meters |
integer |
None. |
Timeout |
GeoFence requested timeout in seconds |
integer |
None. |
APIVersion |
API Version |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "IPAddress": "sample string 1", "GeoFenceIsEnabled": true, "Accuracy": 3, "Timeout": 4, "APIVersion": 5, "code": 200, "error": "sample string 1" }
application/xml, text/xml
Sample:
<GetIPAddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.User"> <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">5</APIVersion> <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error> <Accuracy>3</Accuracy> <GeoFenceIsEnabled>true</GeoFenceIsEnabled> <IPAddress>sample string 1</IPAddress> <Timeout>4</Timeout> </GetIPAddressResponse>