POST /index/locatedevice

Interrogates the network for current location information. If the device is offline or the current location is not available, returns the last recorded value.

Authentication

  • User required to login

Headers

For information about headers, see Configuring headers.

Request Body application/json

Schema

Use null without quotes as the input if you do not wish to use these objects. The value will remain as previously set. If you want to change the object value to a new value, replace null with "<value>" within quotes, where <value> is the required value. To remove an existing value, type an empty string. For example: "friendlyName" : "" ,

JSON key Description Required?
request_id

A request identifier for tracking responses.

 
iccid The unique Integrated Circuit Card Identifier of the SIM you want to locate. Use either this parameter or msisdn to identify the SIM. or msisdn
msisdn The unique primary SIM phone number (Mobile Station International ISDN Number) of the SIM you want to locate. Use either this parameter or iccid to identify the SIM. or iccid

username

The Eseye-assigned Location API username
password The Eseye-assigned Location API password

Example

Copy
Body raw JSON
{
    "request_id" : "42",
    "iccid" : "8944538523007980017" ,
    "username" : "ExampleUsername" ,
    "password" : "ExamplePassword" ,
}

Responses application/json

Schema

JSON key Description
iccid

The unique Integrated Circuit Card Identifier for the located SIM.

msisdn The unique primary SIM phone number (Mobile Station International ISDN Number).
lat Latitude value of the last cell mast that the SIM used.
lon Longitude value of the last cell mast that the SIM used.
countryname The last recorded country the SIM was in.
countrycode The ISO 3166 Alpha-2 code of the last recorded country the SIM was in. For more information, see the ISO Online Browsing Platform (ODP) Country Codes.
timezone The TZ database name of the last recorded timezone the SIM was in. For more information, see the List of TZ database time zones.
status

The array, containing details about the request status.

status

"OK" – the request processed successfully

"ERR" – the request failed

errorCode

"" – the request processed successfully

"<ErrorCodeNumber>" – the request failed because of this specific error.

For more information, see Troubleshooting errors: Location API.

errorMessage

"" – the request processed successfully

"<ErrorCodeMessage>" – displays an explanation of the error if the request failed.

For more information, see Troubleshooting errors: Location API.

request_id The returned request identifier, for tracking responses.

Example

Copy
JSON
{
    "iccid": "8944538523007980017",
    "msisdn": "447924167590",
    "lat": 51.2394,
    "lon": -0.6036,
    "countryname": "United Kingdom",
    "countrycode": "GB",
    "timezone": "Europe/London",
    "status": {
        "status": "OK",
        "errorCode": "",
        "errorMessage": ""
    },
    "request_id": "42"
}