Locate a Mobile User

API Interface: HTTPS
Resource: Location
URI: /20100101/sms/locate/
Methods: POST
Response Schemas: XML


An application programming interface for connecting external applications, systems, and devices with the Aerialink Service Gateway for the purpose of obtaining location coordinates for mobile devices on supported carrier networks. This specific API covers locations transactions only.

Note: Reference URI (Uniform Resource Identifier) defaults to a XML response schema.

Method [POST] : Locate a mobile user/device

This method is used to locate a user/device physical geographic location. The request is initiated by your application.


The following request parameters are available for this resource and method

Required Parameters

  • destination [varchar(15)]
    The destination mobile number that you wish to geo locate. This should be provided in international format excluding the plus sign. For example: 1xxxyyyzzzz for a US or Canada mobile number.

  • requestMethod [smallint(1)]
    The location request type must be a value of 1, 2, 3, or 4.

    1 = “Assisted GPS ONLY”
    2 = “Cell ID ONLY”
    3 = “Assisted GPS 1st, then Cell ID”
    4 = “Cell ID 1st, then Assisted GPS”

Response (Synchronous)

Response Properties

The parameters or elements returned in the response to an API request.

  • status [string] : The requested version of the resource
  • userData [string] : The requested resource name
  • coordinateX [string] : The method for the request. This will always be one of the following; GET, POST, UPDATE, DELETE
  • coordinateY [string] : The request type; Syncronous or Asyncronous
  • requestMethod [string] : The globally unique transaction ID for the LBS ping
  • responseMethod [string] : The destination mobile number that the location query was performed against
  • circularAreaRadius [string] : The result of the location query. Consists of three attributes; ‘coordinateX’ [string], ‘coordinateY’ [string], and ‘circularAreaRadius’

Response Schema

XML Format

<?xml version="1.0" ?>  
<aerialink version="20100101" method="locate">  

Status & Error Codes

For status codes related to Availability, Access, Security and Authentication, see HTTP Status Codes. HTTP Status Codes are consistent for all API resources.

Once your application has received an HTTP Status Code of 200 or 202 it signifies that you were able to successfully reach the Aerialink network and pass the preliminary security checks. At this point, you should expect to receive one of the following two API responses strings:

  • API Success Reponse “XML Packet”
    This XML response will be formated as described above.

  • API Negotiation Error “Simple String”
    This “Simple String” response will include a system error code. For a complete list of API Error Codes that relate to this API resource, see API Error Codes.
    An error has occurred with your request. Please try again or contact support. Error Code: XXXX,1234567890123


If you are having trouble authenticating with the Aerialink API, verify that you have constructed the request URL properly and have prepared your authentication properly. See Base URL and Authentication for details.

You can view the API Authentication Error Log under Reports in the APi section of the Platform portal. This will confirm whether your authentication requests are being rejected or not.


If you require any additional assistance, please use one of these methods to contact the Aerialink Support Team.

This page was last updated 1515185923000