APIs and documentation

Location API

This API is used to locate any mobile on the Three network. If the mobile you wish to lookup is not with Three or you are unsure, please use this aql LBS lookup API.

Connection Details

The Three LBS API is available via our HTTP POST interface: 

https://gw.aql.com/three/lbs.php (or http) 

Although we do offer the standard HTTP gateway, we do prefer that your application uses the HTTPS gateway as it prevents sensitive details being “sniffed” across the internet.

Gateway Parameters

The gateway expects the following parameters:

VariableRequiredDescription
usernameYesYour aql username
passwordYesYour aql password
addressYesThe mobile number you wish to locate. The mobile number must be in international format without the leading + and any leading zeros. e.g 07766404142 would be 447766404142
requestedaccuracyNoNot yet supported by Three
acceptableaccuracyNoNot yet supported by Three
toleranceNoNot yet supported by Three
maximumageNoNot yet supported by Three
responsetimeNoNot yet supported by Three
timemetricNoNot yet supported by Three
requesterNoNot yet supported by Three
return-modeNoEither 'url' or 'plain'. Indicates the type of response the gateway will return to you. Default value is 'plain' (See below)
return-formatNoAllows you to set a custom return string if the call was successful. The parameter 'return-mode' must be set to 'plain'. (See below)

Gateway Return Values

On success, the gateway will return the following parameters

Parameter NameDescription
status200 (success)
descA string with a short description
longitudeA decimal number
latitudeA decimal number
altitudeCurrently always 0. Reserved for future use by Three
accuracyCurrently always 0. Reserved for future use by Three
timestampString of the format: YYYY-MM-DDTHH:MM:SS.mmmZ

The format of the returned data is: 

<status>: <description>
latitude: <latitude>
longitude: <longitude>
altitude: <altitude>
accuracy: <accuracy>
timestamp: <timestamp>

where the items in brackets will be replaced with their actual values. 

If the return-mode or return-format parameters are set in the original request, the returned string will be different depending on the format you choose. 

If the call was not successful, the gateway will return the following parameters

Parameter NameDescription
statusStatus code for the type of error (see Below)
descA string with a short description of the error

The format of the retuned data is:

<status>: <desc>

where the items in brackets will be replaced with their actual values. 

If the return-mode parameter is set to 'url', the format of the returned data will be different. See below for details.

Status Codes

StatusDescription
200OK
300Missing Parameter(s)
400Bad request
402Not enough credits to perform lookup
500Internal System Error
6100Invalid address parameter
6101Invalid requestedaccuracy parameter
6102Invalid acceptableaccuracy parameter
6103Invalid tolerance parameter
6104Invalid maximumage parameter
6105Invalid responsetime parameter
6106Invalid timemetric parameter
6107Invalid requester parameter
6108Accuracy of location is not within acceptable limit
6109Request denied by operator
6110Request denied by operator
6112The requested accuracy is not supported
6113Unable to locate the address
6114Not authorised to use this service

You can view the return-mode and return-format descriptions here.


Back to Documentation and APIs

Follow us on Twitter

Like us on Facebook

Connect to us on LinkedIn

Where we are

aql
13-15 Hunslet Road
Leeds
LS10 1JQ
Telephone 01133 20 30 40