API Description for Extended Web Services

User Location

The following sections provide detailed information about the User Location service capability:

• Web Service
• Listener interface
• Location Uncertainty shapes

 

---

Web Service

The user location Web Service provides an application with functions for retrieving the location of a mobile terminal.

getExtendedLocation

Retrieves a mobile terminal's location with extended data. Asynchronous request.

Table 10-1 getExtendedLocation(endpoint, addresses, altitudeRequested, priority, requestedAccuracy, requestedLocationMethod, requestedResponseTime, type, serviceCode, requesterID)

Parameter Name	Type	Description
Input
endpoint	xsd:string	The URL to the Web Service that implements the listener interface. See Listener interface. An example is http://www.acompany.com/axis/services/LocationListener
addresses	impl:ArrayOf_xsd_string	See ArrayOf_xsd_string. The addresses, in URI format (tel:<address>), to request location for.
altitudeRequested	xsd:boolean	Defines if altitude will be supplied in the location data.
priority	tns7:Priority	See Priority.
Priority of the request.
requestedAccuracy	xsd:float	Unit is meters.
requestedLocationMethod	xsd:string	Depends on operator settings.
requestedResponseTime	impl:LocationResponseTime	See LocationResponseTime.
type	impl:LocationType	See LocationType. The type of location requested.
serviceCode	xsd:string	Used for charging purposes. Defined by the operator.
requesterID	xsd:string	The application ID as given by the operator.
Returns
getExtendedLocationReturn	xsd:int	ID of the request. This ID is supplied in setExtendedLocation to keep track of the different request-response pairs.
Exceptions
LocationException		See LocationException.
GeneralException		See GeneralException.

getExtendedLocationWait

Retrieves a mobile terminal's location with extended data and returns the location directly. Synchronous request.

Table 10-2 getExtendedLocationWait(addresses, altitudeRequested, priority, requestedAccuracy, requestedLocationMethod, requestedResponseTime, type, waitTimeoutSeconds, serviceCode, requesterID)

Parameter Name	Type	Description
Input
addresses	impl:ArrayOf_xsd_string	See ArrayOf_xsd_string. The addresses, in URI format (tel:<address>), of the mobile terminals to be positioned.
altitudeRequested	xsd:boolean	Defines if altitude will be supplied in the location data.
priority	tns7:Priority	See Priority. Priority of the request.
requestedAccuracy	xsd:float	Unit is metres.
requestedLocationMethod	xsd:string	Depends on operator settings.
requestedResponseTime	impl:LocationResponseTime	See LocationResponseTime.
type	impl:LocationType	See LocationType. The type of location requested.
waitTimeoutSeconds	xsd:int	The time, in seconds, to wait for a response. If the response is not delivered within this time frame, and exception is thrown.
serviceCode	xsd:string	Used for charging purposes. Defined by the operator.
requesterID	xsd:string	The application ID as given by the operator.
Returns
getExtendedLocationWaitReturn	impl:ArrayOfExtendedLocationResult	See ArrayOfExtendedLocationResult.Array of locations, one for each terminal which location was requested.
Exceptions
LocationException		See LocationException.
GeneralException		See GeneralException.

getGeoLocation

Retrieves a mobile terminal's location with geographical information, such as street address, included. Asynchronous request.

Table 10-3 getGeoLocation(endpoint, addresses, priority, requestedResponseTime, type, serviceCode, requesterID)

Parameter Name	Type	Description
Input
endpoint	xsd:string	The URL to the Web Service that implements the listener interface. See Listener interface. An example is http://www.acompany.com/axis/services/LocationListener
addresses	impl:ArrayOf_xsd_string	See ArrayOf_xsd_string. The addresses, in URI format (tel:<address>), to request location for.
priority	tns7:Priority	See Priority. Priority of the request.
requestedResponseTime	impl:LocationResponseTime	See LocationResponseTime.
type	impl:LocationType	See LocationType. The type of location requested.
serviceCode	xsd:string	Used for charging purposes. Defined by the operator.
requesterID	xsd:string	The application ID as given by the operator.
Returns
getGeoLocationReturn	xsd:int	ID of the request. This ID is supplied in setGeoLocation to keep track of the different request-response pairs.
Exceptions
LocationException		See LocationException.
GeneralException		See GeneralException.

getGeoLocationWait

Retrieves a mobile terminal's location with geographical information, such as street address, included and returns the location directly. Synchronous request.

Table 10-4 getGeoLocationWait(addresses, priority, requestedResponseTime, type, waitTimeoutSeconds, serviceCode, requesterID)

Parameter Name	Type	Description
Input
addresses	impl:ArrayOf_xsd_string	See ArrayOf_xsd_string. The addresses, in URI format (tel:<address>), of the terminals to be positioned.
priority	tns7:Priority	See Priority.Priority of the request.
requestedAccuracy	xsd:float	Unit is meters.
requestedResponseTime	impl:LocationResponseTime	See LocationResponseTime.
type	impl:LocationType	See LocationType. The type of location requested.
waitTimeoutSeconds	xsd:int	The time, in seconds, to wait for a response. If the response is not delivered within this time frame, and exception is thrown.
serviceCode	xsd:string	Used for charging purposes. Defined by the operator.
requesterID	xsd:string	The application ID as given by the operator.
Returns
getGeoLocationWaitReturn	impl:ArrayOfGeoLocationResult	See ArrayOfGeoLocationResult. Array of locations, one for each terminal which location was requested.
Exceptions
LocationException		See LocationException.
GeneralException		See GeneralException.

getLocation

Retrieves a mobile terminal's location. Asynchronous request.

Table 10-5 getLocation(endpoint, addresses, serviceCode, requesterID)

Parameter Name	Type	Description
Input
endpoint	xsd:string	The URL to the Web Service that implements the listener interface. See Listener interface. An example is http://www.acompany.com/axis/services/LocationListener
addresses	impl:ArrayOf_xsd_string	See ArrayOf_xsd_string. The addresses, in URI format (tel:<address>), of the mobile terminals to be positioned.
serviceCode	xsd:string	Used for charging purposes. Defined by the operator.
requesterID	xsd:string	The application ID as given by the operator.
Returns
getLocationReturn	xsd:int	ID of the request. This ID is supplied in setGeoLocation to keep track of the different request-response pairs.
Exceptions
LocationException		See LocationException.
GeneralException		See GeneralException.

getLocationWait

Retrieves a mobile terminal's location and return the location directly. Synchronous request.

Table 10-6 getLocationWait(addresses, requestedResponseTime, waitTimeoutSeconds, serviceCode, requesterID)

Parameter Name	Type	Description
Input
addresses	impl:ArrayOf_xsd_string	See ArrayOf_xsd_string. The addresses, in URI format (tel:<address>), of the mobile terminals to be positioned.
requestedResponseTime	impl:LocationResponseTime	See LocationResponseTime.
waitTimeoutSeconds	xsd:int	The time, in seconds, to wait for a response. If the response is not delivered within this time frame, and exception is thrown.
serviceCode	xsd:string	Used for charging purposes. Defined by the operator.
requesterID	xsd:string	The application ID as given by the operator.
Returns
getLocationWaitReturn	impl:ArrayOfLocationResult	See ArrayOfLocationResult. Array of locations, one for each terminal which location was requested.
Exceptions
LocationException		See LocationException.
GeneralException		See GeneralException.

startPeriodicGeoLocation

Starts to retrieve mobile user's locations with geographical information, such as street address, included periodically. Asynchronous request.

Table 10-7 startPeriodicGeoLocation(endpoint, addresses, altitudeRequested, priority, requestedAccuracy, requestedLocationMethod, requestedLocationResponseTime, type, reportingInterval, serviceCode, requesterID)

Parameter Name	Type	Description
Input
endpoint	xsd:string	The URL to the Web Service that implements the listener interface. See Listener interface. An example is http://www.acompany.com/axis/services/LocationListener
addresses	impl:ArrayOf_xsd_string	See ArrayOf_xsd_string. The addresses, in URI format (tel:<address>), of the mobile terminals to be positioned.
altitudeRequested	xsd:boolean	Defines if altitude will be supplied in the location data.
Priority	tns7:Priority	See Priority. Priority of the request.
requestedAccuracy	xsd:float	Requested accuracy given in metres.
requestedLocationMethod	xsd:string	Depends on operator settings.
LocationResponseTime	impl:LocationResponseTime	See LocationResponseTime.
wespaLocationtype	impl:LocationType	See LocationType. The type of location requested.
reportingInterval	xsd:long	The reporting interval in milliseconds.
serviceCode	xsd:string	Used for charging purposes. Defined by the operator.
requesterID	xsd:string	The application ID as given by the operator.
Returns
startPeriodicGeoLocationReturn	xsd:int	ID of the session. This ID is supplied in setPeriodicGeoLocation to keep track of the request and the associated responses. The ID is also used when stopping the session.
Exceptions
LocationException		See LocationException.
GeneralException		See GeneralException.

startPeriodicLocation

Starts to retrieve mobile user's locations with extended location data included periodically. Asynchronous request.

Table 10-8 startPeriodicLocation(endpoint, addresses, altitudeRequested, priority, requestedAccuracy, requestedLocationMethod, requestedResponseTime, type, reportingInterval, serviceCode, requesterID)

Parameter Name	Type	Description
Input
endpoint	xsd:string	The URL to the Web Service that implements the listener interface. See Listener interface. An example is http://www.acompany.com/axis/services/LocationListener
addresses	impl:ArrayOf_xsd_string	See ArrayOf_xsd_string. The addresses, in URI format (tel:<address>), of the mobile terminals to be positioned.
altitudeRequested	xsd:boolean	Defines if altitude will be supplied in the location data.
priority	tns7:Priority	See Priority. Priority of the request.
requestedAccuracy	xsd:float	Requested accuracy given in meters.
requestedLocationMethod	xsd:string	Depends on operator settings.
requestedResponseTime	impl:LocationResponseTime	See LocationResponseTime.
type	impl:LocationType	See LocationType. The type of location requested.
reportingInterval	xsd:long	The reporting interval in milliseconds.
serviceCode	xsd:string	Used for charging purposes. Defined by the operator.
requesterID	xsd:string	The application ID as given by the operator.
Returns
startPeriodicLocation	xsd:int	ID of the request. This ID is supplied in setPeriodicLocation to keep track of the request and the associated responses.
Exceptions
LocationException		See LocationException.
GeneralException		See GeneralException.

startTriggeredLocationReporting

Starts a triggered location tracking reporting session. When a mobile terminal enters a certain area, a report is sent to the application. Asynchronous request.

Table 10-9 startTriggeredLocationReporting(endpoint, addresses, trigger, serviceCode, requesterID)

Parameter Name	Type	Description
Input
endpoint	xsd:string	The URL to the Web Service that implements the listener interface. See Listener interface. An example is http://www.acompany.com/axis/services/LocationListener
addresses	impl:ArrayOf_xsd_string	See ArrayOf_xsd_string. The addresses, in URI format (tel:<address>) of the mobile terminals to be positioned.
trigger	impl:LocationTrigger	See LocationTrigger. Definition of the area or geographical location for which a location report shall be sent to the application.
serviceCode	xsd:string	Used for charging purposes. Defined by the operator.
requesterID	xsd:string	The application ID as given by the operator.
Returns
startPeriodicLocation	xsd:int	ID of the request. This ID is supplied in setPeriodicLocation to keep track of the request and the associated responses.
Exceptions
LocationException		See LocationException.
GeneralException		See GeneralException.

stopPeriodicGeoLocation

Stops a periodic geographical location tracking session. Synchronous request.

Table 10-10 stopPeriodicGeoLocation(id)

Parameter Name	Type	Description
Input
id	xsd:int	Identifier for the session. See startPeriodicGeoLocation for information on how to start the session.
Returns
Void.
Exceptions
LocationException		See LocationException.
GeneralException		See GeneralException.

stopPeriodicLocation

Stops a periodic location tracking session. Synchronous request.

Table 10-11 stopPeriodicLocation(id)

Parameter Name	Type	Description
Input
id	xsd:int	Identifier for the session. See startPeriodicLocation for information on how to start the session.
Returns
Void.
Exceptions
LocationException		See LocationException.
GeneralException		See GeneralException.

stopTriggeredLocationReporting

Stops a location triggered location tracking session. Synchronous request.

Table 10-12 stopTriggeredLocationReporting(id)

Parameter Name	Type	Description
Input
id	xsd:int	Identifier for the session. See startTriggeredLocationReporting for information on how to start the session.
Returns
Void.
Exceptions
LocationException		See LocationException.
GeneralException		See GeneralException.

Exceptions

LocationException

Exceptions of this type are raised when there are error conditions related to the location Web Service. Other error conditions are reported using the exception GeneralException.

GeneralException

This exception is raised when the applications session has expired or there are communication problems with the underlying platform.

Complex data types

LocationType

Type of location requested. Enumeration (xsd:string) with one of the following values.

Table 10-13

Value	Description
CURRENT	Current location of the mobile terminal.
CURRENT_OR_LAST_KNOWN	Current location of the mobile terminal, or last known if current is not available.
INITIAL	Initial location of the mobile terminal. For future use.

LocationResponseTime

Table 10-14

Name	Value	Description
responseTimeIndicator	intf:LocationResponseTimeIndicator	See LocationResponseTimeIndicator.
timerValue	xsd:int	Application-defined response time. Valid only in combination when responseTimeIndicator is set to use user-defined value. See LocationResponseTimeIndicator. Depends on the network.

LocationResponseTimeIndicator

Indicates the accepted response times (QoS). Enumeration (xsd:string) with one of the following values.

Table 10-15

Value	Description
DELAY_TOLERANT	Used for priority handling and queuing in the network.
LOW_DELAY	Used for priority handling and queuing in the network.
NO_DELAY	Used for priority handling and queuing in the network.
USE_TIMER_VALUE	Sets the timer to the time indicated in LocationResponseTime used.

Priority

Indicates the desired priority of the request (QoS). Enumeration (xsd:string) with one of the following values.

Table 10-16

Value	Description
LOW	-
HIGH	-
NORMAL	-

LocationTrigger

Defines the geographical area and the event type that shall trigger a location report. Event type is either when the terminal enters or exits the area.

Table 10-17

Name	Type	Description
location	intf:LocationTriggerLocation	See LocationTriggerLocation.
criteria	intf:LocationTriggerCriteria	See LocationTriggerCriteria.

LocationTriggerLocation

Defines the type of area and the data related to that area.

Table 10-18

Name	Type	Description
triggerLocationTypes	intf:TriggerLocationTypes	See TriggerLocationTypes.
value	xsd:anyType	Either LocationTriggerLongLat or GeoLocation depending on type defined in triggerLocationTypes.

LocationTriggerCriteria

Defines when the location report shall be distributed to the application. Enumeration (xsd:string) with the following values.

Table 10-19

Value	Description
ENTERING_AREA	Used to trigger the response when the mobile terminal enters the area defined in LocationTrigger.
LEAVING_AREA	Used to trigger the response when the mobile terminal leaves the area defined in LocationTrigger.

ArrayOfExtendedLocationResult

Array of locations. See ExtendedLocationResult for information on the individual elements in the array.

ExtendedLocationResult

Table 10-20

Name	Type	Description
address	xsd:string	The address, in URI format (tel:<address>), of the located mobile terminal.
status	intf:LocationStatusCode	See LocationStatusCodes.
theLocation	intf:ExtendedLocation	See ExtendedLocation.

LocationStatusCodes

Information about the outcome of a location request. Enumeration (xsd:string) with one of the following values.

Table 10-21

Value	Description
OK	The location request was successful.
SYSTEM_FAILURE	The location request failed due to failure in the network.
UNAUTHORIZED_NETWORK	The location request failed due to that the network did not accept a location request to be performed.
UNAUTHORIZED_APPLICATION	The location request failed due to that the application was unauthorized to perform the request.
UNKNOWN_SUBSCRIBER	The location request failed due to that the address of the mobile terminal was unknown.
ABSENT_SUBSCRIBER	The location request failed due to that the position of the mobile terminal is unknown.
POSITION_METHOD_FAILURE	The location request failed due to that the requested positioning method is inaccessible or not supported by the network.

ExtendedLocation

Location data, extended with information in altitude and terminal type.

Table 10-22

Name	Type	Description
theLocation	intf:Location	See Location.
altitudePresent	xsd:boolean	True if altitude is present in the data.
altitude	xsd:float	Altitude given in metres.
uncertaintyAltitude	xsd:float	Uncertainty indicator of the altitude given in meeteres.
theTerminalType	tns7:TerminalType	See TerminalType.
timeStamp	xsd:string	Time when the terminal was positioned. Format is YYYY-MM-DD HH:MM:SS.mmm.
locationMethod	xsd:string	Method used when the mobile terminal was positioned if supported by the network.

TerminalType

Information on the terminal with the given address. Enumeration (xsd:string) with one of the following values.

Table 10-23

Value	Description
TT_FIXED	Fixed terminal.
TT_IP	IP terminal.
TT_MOBILE	Mobile terminal.
TT_UNKNOWN	Unknown terminal type.

ArrayOfLocationResult

Array of locations. See LocationResult for information on the individual elements in the array.

LocationResult

Table 10-24

Name	Type	Description
address	xsd:string	The MSISDN, in URI format (tel:<address>), of the located mobile terminal.
status	intf:LocationStatusCode	See LocationStatusCodes.
theLocation	intf:Location	See Location.

Location

Location data with longitude, latitude, and indicator of the uncertainty shape.

Table 10-25

Name	Type	Description
latitude	xsd:float	-
longitude	xsd:float	-
shape	intf:LocationUncertaintyShape	See LocationUncertaintyShape.

LocationUncertaintyShape

Defines a location uncertainty shape.

Table 10-26

Name	Type	Value
locationUncertaintyShapeType	intf:LocationUncertaintyShapeTypes	See LocationUncertaintyShapeTypes.
value	xsd:anyType	Depends on what is specified in locationUncertaintyShapeType. See LocationUncertaintyShapeTypes for mapping between data type and locationUncertaintyShapeType.

LocationUncertaintyShapeTypes

For a description of the uncertainty shapes see Location Uncertainty shapes.

Enumeration (xsd:string) within of the following values.

Table 10-27

Value	Description
CIRCLE	See Circle uncertainty shapes.
CIRCLE_SECTOR	See Circle uncertainty shapes.
CIRCLE_ARC_STRIPE	See Circle uncertainty shapes.
ELLIPSE	See Ellipse uncertainty shapes.
ELLIPSE_SECTOR	See Ellipse uncertainty shapes.
ELLIPSE_ARC_STRIPE	See Ellipse uncertainty shapes.
UNDEFINED	Allows to use thee default location method of the network.

LocationUncertaintyShapeCircle

Defines the circle uncertainty shape. See Figure 10-1, Circle uncertainty shape definitions, on page 10-38.

Table 10-28

Name	Type	Value
radius	xsd:float	Radius of the circle given in meters.

LocationUncertaintyShapeCircleArcStripe

Defines the circle arc stripe uncertainty shape. See Figure 10-1, Circle uncertainty shape definitions, on page 10-38.

Table 10-29

Name	Type	Description
circleSector	intf:LocationUncertaintyShapeCircleSector	The circle sector. See LocationUncertaintyShapeCircleSector.
innerRadius	xsd:float	Radius of the inner circle given in metres.

LocationUncertaintyShapeCircleSector

Defines the circle sector uncertainty shape. See Figure 10-1, Circle uncertainty shape definitions, on page 10-38.

Table 10-30

Name	Type	Description
circle	intf:LocationUncertaintyShapeCircle	Radius of the circle. See LocationUncertaintyShapeCircle.
segmentEndAngle	xsd:float	End angle of the circle sector given in degrees.
segmentStartAngle	xsd:float	Start angle of the circle sector given in degrees.

LocationUncertaintyShapeEllipse

Defines the ellipse uncertainty shape. See Figure 10-1, Circle uncertainty shape definitions, on page 10-38.

Table 10-31

Name	Type	Description
angle	xsd:float	Angle of the semi major axis given in degrees.
semiMajor	xsd:float	Size of the semi major axis given in meters.
semiMinor	xsd:float	Size of the semi minor axis given in meters.

LocationUncertaintyShapeEllipseArcStripe

Defines the ellipse arc stripe uncertainty shape. See Figure 10-1, Circle uncertainty shape definitions, on page 10-38.

Table 10-32

Name	Type	Description
ellipseSector	intf:LocationUncertaintyShapeEllipseSector	Definition of the ellipse. See LocationUncertaintyShapeEllipseSector.
innerSemiMajor	xsd:float	Size of semi major axis of the inner ellipse defining the stripe. Given in meters.
innerSemiMinor	xsd:float	Size of semi minor axis of the inner ellipse defining the stripe. Given in meters.

LocationUncertaintyShapeEllipseSector

Defines the ellipse sector uncertainty shape. See Figure 10-2, Ellipse uncertainty shape definitions, on page 10-39.

Table 10-33

Name	Type	Description
ellipse	intf:LocationUncertaintyShapeEllipse	Defines the ellipse. See LocationUncertaintyShapeEllipse.
segmentEndAngle	xsd:float	Defines the end angle of the sector, given in degrees.
segmentStartAngle	xsd:float	Defines the start angle of the sector given in degrees.

TriggerLocationTypes

Definition of which geographical area definition method to use for triggered user location.

Enumeration (xsd:string) with the following values.

Table 10-34

Value	Description
LONG_LAT	Area definition method is based on longitude and latitude. See LocationTriggerLongLat.
GEO_DATA	Area definition method is based on abstract geographical definitions such as street address, ZIP-code and so on. See GeoLocation.

LocationTriggerLongLat

Definition of a geographical area. See Ellipse uncertainty shapes. The area is defined by an ellipse.

Table 10-35

Name	Type	Description
Longitude	xsd:float	Longitude of the base point.
Latitude	xsd:float	Latitude of the base point.
AreaSemiMajor	xsd:float	Size of semi major axis ellipse given in meters.
AreaSemiMinor	xsd:float	Size of semi minor axis ellipse given in meters.
AngleOfSemiMajor	xsd:float	Angel of semi major axis given in degrees.

GeoLocation

Definition of a geographical area. Defined by names representing a geographical location.

Table 10-36

Value	Type	Decription
streetAddress	xsd:string	Street address.
county	xsd:string	County.
zipCode	xsd:string	ZIP code.
city	xsd:string	City.
state	xsd:string	State.
country	xsd:string	Country.
area	xsd:string	Operator-defined.
network	xsd:string	Operator-defined.

ArrayOfGeoLocationResult

Array of geographical locations. See GeoLocationResult for information on the individual records in the array.

GeoLocationResult

Table 10-37

Name	Type	Description
address	xsd:string	The address, in URI format (tel:<address>), of the located terminal.
status	intf:LocationStatusCode	See LocationStatusCodes.
theLocation	intf:GeoLocation	See GeoLocation.

ArrayOf_xsd_string

Array of strings.

 

---

Listener interface

The location listener interface defines the methods that the underlying platform invokes on a Web Service that is implemented by an application. When an application performs asynchronous requests from the location Web Service, the responses are delivered according to this interface.

deactivate

Used by the underlying system to inform the application that a session is no longer valid. The application can not use the session no more.

Table 10-38 deactivate(id)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the session to be deactivated. The ID was returned when getExtendedLocation, getGeoLocation, or getLocation was invoked.
Returns
Void.
Exceptions
-

setExtendedLocation

Responses to requests invoked by getExtendedLocation are reported using this method.

Table 10-39 setExtendedLocation(id, result)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when getExtendedLocation was invoked.
result	impl:ArrayOfExtendedLocationResult	See ArrayOfExtendedLocationResult. The requested location data.
Returns
Void.
Exceptions
-

setExtendedLocationError

Errors related to requests invoked by getExtendedLocation are reported using this method.

Table 10-40 setExtendedLocationError(id, errorCode, errorMsg)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when getExtendedLocation was invoked.
errorCode	xsd:int	Code representing the error.
errorMsg	xsd:string	Error description.
Returns
Void.
Exceptions
-

setGeoLocation

Responses to requests invoked by getGeoLocation are reported using this method.

Table 10-41 setGeoLocation(id, result)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when getGeoLocation was invoked.
result	impl:ArrayOfGeoLocationResult	See ArrayOfExtendedLocationResult. The requested location data.
Returns
Void.
Exceptions
-

setGeoLocationError

Errors related to requests invoked by getGeoLocation are reported using this method.

Table 10-42 setGeoLocationError(id, errorCode, errorMsg)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when getGeoLocation was invoked.
errorCode	xsd:int	Code representing the error.
errorMsg	xsd:string	Error description.
Returns
Void.
Exceptions
-

setLocation

Responses to requests invoked by getLocation are reported using this method.

Table 10-43 setLocation(id, result)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when getLocation was invoked.
result	impl:ArrayOfLocationResult	See ArrayOfExtendedLocationResult. The requested location data.
Returns
Void.
Exceptions
-

setLocationError

Errors related to requests invoked by getLocation are reported using this method.

Table 10-44 setLocationError(id, errorCode, errorMsg)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when getLocation was invoked.
errorCode	xsd:int	Code representing the error.
errorMsg	xsd:string	Error description.
Returns
Void.
Exceptions
-

setPeriodicGeoLocation

Responses to requests invoked by startPeriodicGeoLocation are reported using this method.

Table 10-45 setLocationError(id, errorCode, errorMsg)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when startPeriodicGeoLocation was invoked.
result	impl:ArrayOfGeoLocationResult	See ArrayOfExtendedLocationResult. The requested location data.
Returns
Void.
Exceptions
-

setPeriodicGeoLocationError

Errors related to requests invoked by startPeriodicGeoLocation are reported using this method.

Table 10-46 setPeriodicGeoLocationError(id, errorCode, errorMsg)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when startPeriodicGeoLocation was invoked.
errorCode	xsd:int	Code representing the error.
errorMsg	xsd:string	Error description.
Returns
Void.
Exceptions
-

setPeriodicLocation

Responses to requests invoked by startPeriodicLocation are reported using this method.

Table 10-47 setPeriodicLocation(id, result)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when startPeriodicLocation was invoked.
result	impl:ArrayOfLocationResult	See ArrayOfExtendedLocationResult. The requested location data.
Returns
Void.
Exceptions
-

setPeriodicLocationError

Errors related to requests invoked by startPeriodicLocation are reported using this method.

Table 10-48 setPeriodicLocationError(id, errorCode, errorMsg)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when startPeriodicLocation was invoked.
errorCode	xsd:int	Code representing the error.
errorMsg	xsd:string	Error description.
Returns
Void.
Exceptions
-

setTriggeredLocation

Responses to requests invoked by startTriggeredLocationReporting are reported using this method.

Table 10-49 setTriggeredLocation(id, result)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when startTriggeredLocationReporting was invoked.
result	impl:ArrayOfTriggeredLocationResult	See ArrayOfTriggeredLocationResult. The requested location data.
Returns
Void.
Exceptions
-

setTriggeredLocationError

Errors related to requests invoked by startTriggeredLocationReporting are reported using this method.

Table 10-50 setTriggeredLocationError(id, errorCode, errorMsg)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when startTriggeredLocationReporting was invoked.
errorCode	xsd:int	Code representing the error.
errorMsg	xsd:string	Error description.
Returns
Void.
Exceptions
-

Exceptions

-

Complex data types

Below are the complex data types defined. Only the ones specific for the listener interface are defined below, the WSDL file contains additional data definitions, but they are the same as for location Web Service and are described in section Complex data types.

ArrayOfTriggeredLocationResult

Array of locations. See TriggeredLocationResult for information on the individual elements in the array.

TriggeredLocationResult

Table 10-51

Name	Type	Description
address	xsd:string	The MSISDN, in URI format (tel:<address>), of the located mobile terminal.
status	intf:LocationStatusCode	See LocationStatusCodes.
theLocation	intf:Location	See Location.
criteria	intf:TriggerCriteria	See TriggerCriteria.

TriggerCriteria

Defines when a a triggered location report shall be distributed to the application. Enumeration (xsd:string) with one of the following values.

Table 10-52

Value	Description
UL_ENTERING_AREA	Used when the mobile terminal enters a defined area.
UL_LEAVING_AREA	Used when ten mobile terminal leaves a defined area.

 

---

Location Uncertainty shapes

Circle uncertainty shapes

The circle uncertainty shapes are:

• Circle
• Circle sector
• Circle arc

The circle sector is an extended case of the circle, and the circle arc is a extended case of the circle sector, see Figure 10-1, Circle uncertainty shape definitions, on page 10-38.

Ellipse uncertainty shapes

The ellipse uncertainty shapes are:

• Ellipse
• Ellipse sector
• Ellipse arc

The ellipse sector is an extended case of the ellipse, and the ellipse arc is a extended case of the ellipse sector, see Figure 10-2, Ellipse uncertainty shape definitions, on page 10-39.

Terminal altitude

If the terminal's altitude is provided, the actual terminal altitude is somewhere within a span defined by the provided altitude value and two times the altitude uncertainty, see Figure 10-3, Terminal altitude definition, on page 10-40.

A positive altitude value means above sea level, whereas a negative value means below sea level.