ETSI ES 201 915-6 V1.4.1 (2003-07)
Open Service Access (OSA); Application Programming Interface (API); Part 6: Mobility SCF (Parlay 3)
Open Service Access (OSA); Application Programming Interface (API); Part 6: Mobility SCF (Parlay 3)
RES/SPAN-120095-6
Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 6. del: Mobilnost SCF
General Information
Standards Content (Sample)
SLOVENSKI STANDARD
01-januar-2005
Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 6.
del: Mobilnost SCF
Open Service Access (OSA); Application Programming Interface (API); Part 6: Mobility
SCF (Parlay 3)
Ta slovenski standard je istoveten z: ES 201 915-6 Version 1.4.1
ICS:
33.040.01 Telekomunikacijski sistemi Telecommunication systems
na splošno in general
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 6: Mobility SCF
(Parlay 3)
�
2 ETSI ES 201 915-6 V1.4.1 (2003-07)
Reference
RES/SPAN-120095-6
Keywords
API, OSA, IDL, UML
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, send your comment to:
editor@etsi.org
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2003.
© The Parlay Group 2003.
All rights reserved.
TM TM TM
DECT , PLUGTESTS and UMTS are Trade Marks of ETSI registered for the benefit of its Members.
TM
TIPHON and the TIPHON logo are Trade Marks currently being registered by ETSI for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
3 ETSI ES 201 915-6 V1.4.1 (2003-07)
Contents
Intellectual Property Rights.7
Foreword.7
1 Scope.8
2 References.8
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Mobility SCF.9
4.1 General requirements on support of methods.9
5 Sequence Diagrams.9
5.1 User Location Sequence Diagrams.9
5.1.1 User Location Interrogation - Triggered Request .9
5.1.2 User Location Interrogation - Periodic Request.11
5.1.3 User Location Interrogation - Parameter Error .12
5.1.4 User Location Interrogation - Network Error .12
5.1.5 User Location Interrogation - Interactive Request.13
5.2 User Location Camel Sequence Diagrams .14
5.2.1 User Location Camel Interrogation - Triggered Request.14
5.2.2 User Location Camel Interrogation - Periodic Request .15
5.2.3 User Location Camel Interrogation - Parameter Error.15
5.2.4 User Location Camel Interrogation - Network Error.16
5.2.5 User Location Camel Interrogation - Interactive Request .17
5.3 User Location Emergency Sequence Diagrams .18
5.3.1 Subscription and Network Induced Location Reports .18
5.3.2 Network Induced Location Reports .19
5.3.3 Interactive Request Parameter Error.19
5.3.4 Interactive Request Network Error .20
5.3.5 Interactive Location Request .20
5.4 User Status Sequence Diagrams.21
5.4.1 Triggered Reporting.21
5.4.2 Interactive Request Parameter Error.22
5.4.3 Interactive Request Network Error .22
5.4.4 Interactive Request.23
6 Class Diagrams.24
6.1 User Location Class Diagrams .24
6.2 User Location Camel Class Diagrams.25
6.3 User Location Emergency Class Diagrams .26
6.4 User Status Class Diagrams.27
7 The Service Interface Specifications.27
7.1 Interface Specification Format .27
7.1.1 Interface Class.27
7.1.2 Method descriptions.28
7.1.3 Parameter descriptions.28
7.1.4 State Model.28
7.2 Base Interface.28
7.2.1 Interface Class IpInterface .28
7.3 Service Interfaces.28
7.3.1 Overview.28
7.4 Generic Service Interface .28
7.4.1 Interface Class IpService .28
8 Mobility Interface Classes.30
ETSI
4 ETSI ES 201 915-6 V1.4.1 (2003-07)
8.1 User Location Interface Classes .30
8.1.1 Interface Class IpUserLocation.30
8.1.2 Interface Class IpAppUserLocation.33
8.1.3 Interface Class IpTriggeredUserLocation.36
8.1.4 Interface Class IpAppTriggeredUserLocation .37
8.2 User Location Camel Interface Classes.38
8.2.1 Interface Class IpUserLocationCamel .38
8.2.2 Interface Class IpAppUserLocationCamel .42
8.3 User Location Emergency Interface Classes .45
8.3.1 Interface Class IpUserLocationEmergency .45
8.3.2 Interface Class IpAppUserLocationEmergency.47
8.4 User Status Interface Classes.48
8.4.1 Interface Class IpAppUserStatus .48
8.4.2 Interface Class IpUserStatus.50
9 State Transition Diagrams.52
9.1 User Location.52
9.2 User Location Camel.52
9.2.1 State Transition Diagrams for IpUserLocationCamel.52
9.2.1.1 Active State.53
9.3 User Location Emergency .53
9.4 User Status.54
9.4.1 State Transition Diagrams for IpUserStatus .54
9.4.1.1 Active State.54
10 Service Properties.54
10.1 Mobility Properties.54
10.1.1 Emergency Application Subtypes.54
10.1.2 Value Added Application Subtypes.55
10.1.3 PLMN Operator Application Subtypes.55
10.1.4 Lawful Intercept Application Subtypes .55
10.1.5 Altitude Obtainable.55
10.1.6 Location Methods.55
10.1.7 Priorities.56
10.1.8 Max Interactive Requests.56
10.1.9 Max Triggered Users .56
10.1.10 Max Periodic Users.56
10.1.11 Min Periodic Interval Duration.56
10.2 User Location Service Properties .56
10.3 User Location Camel Service Properties.57
10.4 User Location Emergency Service Properties .57
10.5 User Status Service Properties.58
11 Data Definitions.58
11.1 Common Mobility Data Definitions.58
11.1.1 TpGeographicalPosition.58
11.1.2 TpLocationPriority.59
11.1.3 TpLocationRequest.60
11.1.4 TpLocationResponseIndicator.60
11.1.5 TpLocationResponseTime.60
11.1.6 TpLocationType.60
11.1.7 TpLocationUncertaintyShape.61
11.1.8 TpMobilityDiagnostic.61
11.1.9 TpMobilityError.61
11.1.10 TpMobilityStopAssignmentData.62
11.1.11 TpMobilityStopScope.62
11.1.12 TpTerminalType.62
11.2 User Location Data Definitions.62
11.2.1 IpUserLocation.62
11.2.2 IpUserLocationRef.62
11.2.3 IpAppUserLocation.62
11.2.4 IpAppUserLocationRef.62
11.2.5 IpTriggeredUserLocation.62
ETSI
5 ETSI ES 201 915-6 V1.4.1 (2003-07)
11.2.6 IpTriggeredUserLocationRef.63
11.2.7 IpAppTriggeredUserLocation.63
11.2.8 IpAppTriggeredUserLocationRef.63
11.2.9 TpUlExtendedData.63
11.2.10 TpUlExtendedDataSet.63
11.2.11 TpUserLocationExtended.63
11.2.12 TpUserLocationExtendedSet.63
11.2.13 TpLocationTrigger.64
11.2.14 TpLocationTriggerSet.64
11.2.15 TpLocationTriggerCriteria.64
11.2.16 TpUserLocation.64
11.2.17 TpUserLocationSet.64
11.3 User Location Camel Data Definitions .64
11.3.1 IpUserLocationCamel.64
11.3.2 IpUserLocationCamelRef.64
11.3.3 IpAppUserLocationCamel.64
11.3.4 IpAppUserLocationCamelRef.65
11.3.5 TpLocationCellIDOrLAI.65
11.3.6 TpLocationTriggerCamel.65
11.3.7 TpUserLocationCamel.65
11.3.8 TpUserLocationCamelSet.66
11.4 User Location Emergency Data Definitions.66
11.4.1 IpUserLocationEmergency.66
11.4.2 IpUserLocationEmergencyRef.66
11.4.3 IpAppUserLocationEmergency.66
11.4.4 IpAppUserLocationEmergencyRef.66
11.4.5 TpIMEI.66
11.4.6 TpNaESRD.66
11.4.7 TpNaESRK.66
11.4.8 TpUserLocationEmergencyRequest.67
11.4.9 TpUserLocationEmergency.67
11.4.10 TpUserLocationEmergencyTrigger.67
11.5 User Status Data Definitions .68
11.5.1 IpUserStatus.68
11.5.2 IpUserStatusRef.68
11.5.3 IpAppUserStatus.68
11.5.4 IpAppUserStatusRef.68
11.5.5 TpUserStatus.68
11.5.6 TpUserStatusSet.68
11.5.7 TpUserStatusIndicator.68
11.6 Units and Validations of Parameters .68
12 Exception Classes.69
Annex A (normative): OMG IDL Description of Mobility SCF .70
Annex B (informative): Contents of 3GPP OSA R4 Mobility .71
Annex C (informative): Record of changes .72
C.1 Interfaces.72
C.1.1 New.72
C.1.2 Deprecated.72
C.1.3 Removed.72
C.2 Methods.72
C.2.1 New.72
C.2.2 Deprecated.72
C.2.3 Modified.73
C.2.4 Removed.73
C.3 Data Definitions.73
C.3.1 New.73
ETSI
6 ETSI ES 201 915-6 V1.4.1 (2003-07)
C.3.2 Modified.73
C.3.3 Removed.73
C.4 Service Properties.73
C.4.1 New.73
C.4.2 Deprecated.74
C.4.3 Modified.74
C.4.4 Removed.74
C.5 Exceptions.74
C.5.1 New.74
C.5.2 Modified.74
C.5.3 Removed.74
C.6 Others.74
History .75
ETSI
7 ETSI ES 201 915-6 V1.4.1 (2003-07)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Services and Protocols for Advanced
Networks (SPAN).
The present document is part 6 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 201 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control SCF";
Part 5: "User Interaction SCF";
Part 6: "Mobility SCF";
Part 7: "Terminal Capabilities SCF";
Part 8: "Data Session Control SCF";
Part 9: "Generic Messaging SCF";
Part 10: "Connectivity Manager SCF";
Part 11: "Account Management SCF";
Part 12: "Charging SCF".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP,
in co-operation with a number of JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 3.3 set of specifications.
A subset of the present document is in 3GPP TS 29.198-6 V4.5.0 (Release 4).
ETSI
8 ETSI ES 201 915-6 V1.4.1 (2003-07)
1 Scope
The present document is part 6 of the Stage 3 specification for an Application Programming Interface (API) for Open
Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardised interface, i.e. the OSA APIs.
The present document specifies the Mobility Service Capability Feature (SCF) aspects of the interface. All aspects of
the Mobility SCF are defined here, these being:
• Sequence Diagrams
• Class Diagrams
• Interface specification plus detailed method descriptions
• State Transition diagrams
• Data Definitions
• IDL Description of the interfaces
The process by which this task is accomplished is through the use of object modelling techniques described by the
Unified Modelling Language (UML).
2 References
The references listed in clause 2 of ES 201 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 201 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 201 915-1 apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations defined in ES 201 915-1 apply.
ETSI
9 ETSI ES 201 915-6 V1.4.1 (2003-07)
4 Mobility SCF
The following clauses describe each aspect of the Mobility Service Capability Feature (SCF).
The order is as follows:
• The Sequence diagrams give the reader a practical idea of how each of the SCFs is implemented.
• The Class relationships clause show how each of the interfaces applicable to the SCF, relate to one another.
• The Interface specification clause describes in detail each of the interfaces shown within the Class diagram
part.
• The State Transition Diagrams (STD) show the transition between states in the SCF. The states and transitions
are well-defined; either methods specified in the Interface specification or events occurring in the underlying
networks cause state transitions.
• The Data Definitions clause show a detailed expansion of each of the data types associated with the methods
within the classes. Note that some data types are used in other methods and classes and are therefore defined
within the Common Data types part of the present document.
4.1 General requirements on support of methods
An implementation of this API which supports or implements a method described in the present document, shall
support or implement the functionality described for that method, for at least one valid set of values for the parameters
of that method.
Where a method is not supported by an implementation of a Service interface, the exception
P_METHOD_NOT_SUPPORTED shall be returned to any call of that method.
Where a method is not supported by an implementation of an Application interface, a call to that method shall be
possible, and no exception shall be returned.
5 Sequence Diagrams
5.1 User Location Sequence Diagrams
5.1.1 User Location Interrogation - Triggered Request
The following sequence diagram shows how an application requests triggered location reports from the User Location
service. When users location changes, the service reports this to the application.
ETSI
10 ETSI ES 201 915-6 V1.4.1 (2003-07)
: IpAppTriggeredUserLocation : IpTriggeredUserLocation
1: triggeredLocationReportingStartReq( )
2: triggeredLocationReport( )
3: triggeredLocationReport( )
New reports are sent until the
triggered reporting is stopped
4: triggeredLocationReportingStop( )
1: This message is used to start triggered location reporting for one or several users.
2: When the trigger condition is fulfilled then this message passes the location of the affected user to its callback
object.
3: This is repeated until the application stops triggered location reporting (see next message).
4: This message is used to stop triggered location reporting.
ETSI
11 ETSI ES 201 915-6 V1.4.1 (2003-07)
5.1.2 User Location Interrogation - Periodic Request
The following sequence diagram shows how an application requests periodic location reports from the User Location
service.
: IpAppUserLocation : IpUserLocation
1: periodicLocationReportingStartReq( )
2: periodicLocationReport( )
3: periodicLocationReport( )
New reports are sent until the
periodic reporting is stopped
4: periodicLocationReportingStop( )
1: This message is used to start periodic location reporting for one or several users.
2: This message passes the location of one or several users to its callback object.
3: This message passes the location of one or several users to its callback object.
This is repeated at regular intervals until the application stops periodic location reporting (see next message).
4: This message is used to stop periodic location reporting.
ETSI
12 ETSI ES 201 915-6 V1.4.1 (2003-07)
5.1.3 User Location Interrogation - Parameter Error
The following sequence diagram show a scenario where the application is requesting a location report from the User
Location service but there is at least one error in the parameters that is detected by the service. The scenarios for:
• extendedLocationReportReq
• periodicLocationReportingStartReq
are similar and therefore not shown.
: IpAppUserLocation : IpUserLocation
1: locationReportReq( )
The scenarios for:
· extendedLocationReport_Req
· periodicLocationReportingStart_Req
are similar and therefore not shown.
1: This message is used to request the location of one or several users, but the service returns an error and the
execution of the request is aborted.
5.1.4 User Location Interrogation - Network Error
The following sequence diagram shows a scenario where the application is requesting a location report from the User
Location service, but a network error occurs. The scenarios for:
• extendedLocationReportReq
• periodicLocationReportingStartReq
are similar and therefore not shown.
ETSI
13 ETSI ES 201 915-6 V1.4.1 (2003-07)
: IpAppUserLocation : IpUserLocation
1: locationReportReq( )
2: locationReportErr( )
The scenarios for:
· extendedLocationReport_Req
· periodicLocationReportingStart_Req
are similar and therefore not shown.
1: This message is used to request the location of one or several users.
2: This message passes information about the error in the location request from the network to the callback
object.
5.1.5 User Location Interrogation - Interactive Request
The following sequence diagram shows how an application requests a location report from the User Location service.
: IpAppUserLocation : IpUserLocation
1: locationReportReq( )
2: locationReportRes( )
1: This message is used to request the location of one or several users.
2: This message passes the result of the location request for one or several users to its callback object.
ETSI
14 ETSI ES 201 915-6 V1.4.1 (2003-07)
5.2 User Location Camel Sequence Diagrams
5.2.1 User Location Camel Interrogation - Triggered Request
The following sequence diagram shows how an application requests triggered location reports from the User Location
Camel service. When users location changes, the service reports this to the application.
: IpAppUserLocationCamel : IpUserLocationCamel
1: triggeredLocationReportingStartReq( )
2: triggeredLocationReport( )
3: triggeredLocationReport( )
New reports are sent until the
triggered reporting is stopped
4: triggeredLocationReportingStop( )
1: This message is used to start triggered location reporting for one or several users.
2: When the trigger condition is fulfilled then this message passes the location of the affected user to its callback
object.
3: This is repeated until the application stops triggered location reporting (see next message).
4: This message is used to stop triggered location reporting.
ETSI
15 ETSI ES 201 915-6 V1.4.1 (2003-07)
5.2.2 User Location Camel Interrogation - Periodic Request
The following sequence diagram shows how an application requests periodic location reports from the User Location
Camel service.
: IpAppUserLocationCamel : IpUserLocationCamel
1: periodicLocationReportingStartReq( )
2: periodicLocationReport( )
3: periodicLocationReport( )
New reports are sent until the
periodic reporting is stopped
4: periodicLocationReportingStop( )
1: This message is used to start periodic location reporting for one or several users.
2: This message passes the location of one or several users to its callback object.
3: This message passes the location of one or several users to its callback object.
This is repeated at regular intervals until the application stops periodic location reporting (see next message).
4: This message is used to stop periodic location reporting.
5.2.3 User Location Camel Interrogation - Parameter Error
The following sequence diagram show a scenario where the application is requesting a location report from the User
Location Camel service but there is at least one error in the parameters that is detected by the service. The scenarios for:
• periodicLocationReportingStartReq
are similar and therefore not shown.
ETSI
16 ETSI ES 201 915-6 V1.4.1 (2003-07)
: IpAppUserLocationCamel : IpUserLocationCamel
1: locationReportReq( )
The scenarios for:
· periodicLocationReportingStart_Req
are similar and therefore not shown.
1: This message is used to request the location of one or several users, but the service returns an error and the
execution of the request is aborted.
5.2.4 User Location Camel Interrogation - Network Error
The following sequence diagram shows a scenario where the application is requesting a location report from the User
Location Camel service, but a network error occurs. The scenarios for:
• periodicLocationReportingStartReq
are similar and therefore not shown.
: IpAppUserLocationCamel : IpUserLocationCamel
1: locationReportReq( )
2: locationReportErr( )
The scenarios for:
· extendedLocationReport_Req
· periodicLocationReportingStart_Req
are similar and therefore not shown.
1: This message is used to request the location of one or several user
...








Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.
Loading comments...