Skip to main content
GSMA Logo

3rd Party Access Project - OneAPI

Go Search
Home
Access API Wiki
LIVE Canada Pilot
LIVE Reference Implementation
FAQ
Contribute to the project
  
3rd Party Access Project - OneAPI > Access API Wiki > Location  

Location

Description
 
The Location API allows you to determine the current physical location of a terminal.
 
Use Cases
¢Mapping and directions
Alice uses her handset browser to read a city restaurant review site, food.example.com. On finding a suitable restaurant, she clicks a link in the Web page to ‘send driving directions’. Food.example.com then queries the mobile operator for the user’s location. The operator sends back geographic coordinates which food.example.com use to create a set of text directions and map specific to Alice’s current location, and this is sent back to her as a Web page.
 
¢Live service finder
Bob is a plumber who has registered with local.example.com, a Website which promotes local services. Charlie needs a plumber but does not want to pay a high call out charge as he lives outside town. Charlie accesses local.example.com and asks for a ‘currently nearby’ plumber. Local.example.com queries the operators of the 10 plumbers it has registered, discovers that Bob is nearby and responds to Charlie with Bob’s phone number.
 
Dependencies
 
To use the API you will need:
  • API authentication according to the GSMA API authentication process.
  • The MSISDN of the device that you wish to locate, or, an Anonymous Customer Reference provided by the operator.

Rules and policies

TBC: as sandbox implemenations of this API become available then we will provide links to the operator policies and terms of use.

Method Summary

getLocation (address, accuracy)

Parameter detail

    Parameter Name   
                               Format and usage                                     
address
Either an MSISDN including international calling code, e.g. 00441234123123;
or an Anonymous Customer Reference provided by the operator. MANDATORY
accuracy
Either 'coarse' or 'fine'. MANDATORY.
'coarse' will prioritise response time over accuracy, i.e. the API will respond as
soon as an approximate location has been determined.
'fine' will return a response as soon as location has been determined to within 10
metres (or as close as the network can achieve)
TODO: agree on approximate location - current town/city?

Response detail

(SECTION TO BE COMPLETED)

Exceptions

(SECTION TO BE COMPLETED)

Web Service binding

(SECTION TO BE COMPLETED)

RESTful binding

This is sent in an HTTP GET so can be entered directly into a browser as follows:
<service_endpoint>?address=<number>&accuracy=<coarse or fine>
For example: http://oneapi.aepona.com/TerminalLocationService/Sandbox/REST/268c3cb90fc42ac7f7ff6c0e5418?address=00447977123456&accuracy=coarse
The result will be similar to the following:

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 118
Server: Jetty(6.1.9)
<response timestamp="2009-01-06T12:31:07.014Z" longitude="-5.932617" latitude="54.601505" altitude="10.0" accuracy="200"/>

 

Questions and feedback

Comments and suggestions are very welcome and may be posted to the Feedback forum.

 

Please note that all information on this page is DRAFT in status and subject to change.

Last modified at 16/01/2009 17:00  by Kevin Smith