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.
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.
The gateway expects the following parameters:
| Parameter Name | Presence | Values |
|---|---|---|
| username | mandatory | Your aql username |
| password | mandatory | Your aql password |
| address | mandatory | The 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 |
| requestedaccuracy | optional | Not yet supported by Three |
| acceptableaccuracy | optional | Not yet supported by Three |
| tolerance | optional | Not yet supported by Three |
| maximumage | optional | Not yet supported by Three |
| responsetime | optional | Not yet supported by Three |
| timemetric | optional | Not yet supported by Three |
| requester | optional | Not yet supported by Three |
| return-mode | optional | Either 'url' or 'plain'. Indicates the type of response the gateway will return to you. Default value is 'plain' (See below) |
| return-format | optional | Allows you to set a custom return string if the call was successful. The parameter 'return-mode' must be set to 'plain'. (See below) |
On success, the gateway will return the following parameters
| Parameter Name | Value description |
|---|---|
| status | 200 (success) |
| desc | A string with a short description |
| longitude | A decimal number |
| latitude | A decimal number |
| altitude | Currently always 0. Reserved for future use by Three |
| accuracy | Currently always 0. Reserved for future use by Three |
| timestamp | String 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 Name | Value description |
|---|---|
| status | Status code for the type of error (see Below) |
| desc | A 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 Code | Description |
|---|---|
| 200 | OK |
| 300 | Missing Parameter(s) |
| 400 | Bad request |
| 402 | Not enough credits to perform lookup |
| 500 | Internal System Error |
| 6100 | Invalid address parameter |
| 6101 | Invalid requestedaccuracy parameter |
| 6102 | Invalid acceptableaccuracy parameter |
| 6103 | Invalid tolerance parameter |
| 6104 | Invalid maximumage parameter |
| 6105 | Invalid responsetime parameter |
| 6106 | Invalid timemetric parameter |
| 6107 | Invalid requester parameter |
| 6108 | Accuracy of location is not within acceptable limit |
| 6109 | Request denied by operator |
| 6110 | Request denied by operator |
| 6112 | The requested accuracy is not supported |
| 6113 | Unable to locate the address |
| 6114 | Not authorised to use this service |
You can view the return-mode and return-format descriptions here.