POST /index/locatecalculate

Returns an estimated device location radius, based upon information from three or more cell towers.

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
mast

The array, containing details about the specific cell tower.

 
mcc The Mobile Country Code – identifies the country where the cell tower exists, in three-digit numeric format. For more information, see Mobile country codes.
mnc The Mobile Network Code – identifies the network operator of the network that uses the cell tower, in two-digit numeric format. For more information, see: Mobile network codes listed by country.
lac The Location Area Code of the cell tower, in decimal format. Tracks the physical location of the SIM within the network. Use either this parameter or LAI to identify the cell tower. or LAI
lai The Location Area Identity of the cell tower, in hexadecimal format. Tracks the physical location of the SIM within the network. Use either this parameter or LAC to identify the cell tower. or LAC
cellid Cell Identification, in hexadecimal format. Identifies the cell tower in a location area. Use either this parameter, or CI. or CI
ci The Cell Identification, in hexadecimal format. Identifies the cell tower in a location area. Use either this parameter, or cellid. or cellid
ta The timing advance value returned by the modem.  
power The Received Signal Strength Indicator (RSSI) value, which represents the power of a received signal on a device. The higher the RSSI value, the stronger the signal.  

Example

Copy
Body raw JSON
{
    "request_id" : "1",
    "ICCID" : "8944122650264416971",
    "username" : "ExampleUsername" ,
    "password" : "ExamplePassword" ,
    "mast":[
        {
            "mcc":"234",
            "mnc":"10",
            "lac":"13182",
            "cellid":"30151",
            "ta":"2",
            "power":"79"
        },
        {
            "mcc":"234",
            "mnc":"15",
            "lac":"179",
            "cellid":"25009",
            "ta":"5",
            "power":"93"
        },
        {
            "mcc":"234",
            "mnc":"33",
            "lac":"638",
            "cellid":"1769",
            "ta":"2",
            "power":"88"
        }
        ]
}

Responses application/json

Schema

JSON key Description
status

The array, containing details about the request status.

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.

status

"OK" – the request processed successfully

"ERR" – the request failed

request_id The returned request identifier, for tracking responses.
mast

The array, containing details about the cell tower.

lat

Cell tower latitude value.

lon

Cell tower longitude value.

radius The estimated device location area radius, in kilometres.
confidence

The certainty that a device is in the given radius. Measured on a scale from 0 to 1, where 1 is certain.

countryname The name of the country the cell tower is in.
countrycode The country ISO 3166 Alpha-2 code. For more information, see the ISO Online Browsing Platform (ODP) Country Codes.
timezone The TZ database name of the timezone where the cell tower exists. For more information, see the List of TZ database time zones.

Example

Copy
JSON
{
    "status": {
        "status": "OK",
        "errorCode": "",
        "errorMessage": ""
    },
    "request_id": "1",
    "mast": {
        "lat": 51.2275,
        "lon": -0.639,
        "radius": 3.23,
        "confidence": 0.32,
        "countryname": "United Kingdom",
        "countrycode": "GB",
        "timezone": "Europe/London"
    }
}