POST /index/locatemast

Interrogates the network for the latitude, longitude, country name, country code, operator name and time zone of a specific cell tower. If the tower is unavailable, returns the last recorded values for that tower.

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.

 

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

Example

Copy
Body raw JSON
{
    "request_id" : "1" ,
    "username" : "ExampleUsername" ,
    "password" : "ExamplePassword " ,
    "mast" : {
        "mcc" : "234" ,
        "mnc" : "30" ,
        "lai" : "47A" ,
        "ci" : "c0f6",
        "lac" : "1234" ,
        "cellid" : "4567"
    }
}

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.

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.
lai Location Area Identity of the cell tower, in hexadecimal format. Tracks the physical location of the SIM within the network.
ci The Cell Identification, in hexadecimal format. Identifies the cell tower in a location area.
lat

Cell tower latitude value.

lon

Cell tower longitude value.

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.
operatorname The name of the network operator using the cell tower.
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": "23"
    "mast": {
    "mcc": "234",
    "mnc": "30",
    "lai": "47A"
    "ci": "c0f6cf","
    "lat": 51.245,
    "lon": -0.6067,
    "countryname": "United Kingdom",
    "countrycode": "GB",
    "operatorname": "EE UK",
    "timezone": "Europe/London",
    }
}