API Description for Parlay X

Terminal Location

The following sections describe the Terminal location API used for retrieving the location of an end user's terminal:

• Terminal location API
• Data Types
• Exceptions

 

---

Terminal location API

getLocation

Get the location of a mobile terminal.

Table 9-1 getLocation(endUser, requester, accuracy)

Parameter Name	Type	Description
Input
endUser	EndUserIdentifier	End user for whom location information is being requested.
requester	EndUserIdentifier	OPTIONAL. The address of the requester.
accuracy	LocationAccuracy	The desired accuracy. Possible values are: [Low | Medium | High] Each operator must assign a "radius of uncertainty" to each value (e.g. < 3km, < 1km, < 100m, respectively)
Returns
	LocationInfo	Location of the mobile terminal.

Possible exceptions
UnknownEndUserException
ServiceException
InvalidArgumentException
PolicyException

 

---

Data Types

Table 9-2 Data types specific for User Location

Data type	Description
LocationInfo	Structure containing the following parameters:
	longitude	Indicates the status of the end user. Datatype: Float
	latitude	Additional information if the userStatusIndicator is `Other'. Datatype: Float
	accuracy	How accurate the Location information is. If the degree of accuracy wanted is available this should be given. If not, the best possible accuracy is returned. Possible values: [Low | Medium | High'].
	dateTime	Date and time the location information was obtained. Datatype: DateTime
LocationAccuracy	Enumeration with the following values:
	Low	Low accuracy. That is, < 3 km radius of uncertainty.
	Medium	Medium accuracy. That is, < 1 km radius of uncertainty.
	High	High accuracy. That is, < 100 m radius of uncertainty.

 

---

Exceptions

No exceptions specific for User Location.