ETSI TS 129 198-11-2010 Digital cellular telecommunications system (Phase 2+) Universal Mobile Telecommunications System (UMTS) LTE Open Service Access (OSA) Application Programmin.pdf

1、 ETSI TS 129 198-11 V9.0.0 (2010-01)Technical Specification Digital cellular telecommunications system (Phase 2+);Universal Mobile Telecommunications System (UMTS);LTE;Open Service Access (OSA)Application Programming Interface (API);Part 11: Account management Service Capability Feature (SCF) (3GPP

2、TS 29.198-11 version 9.0.0 Release 9)floppy3ETSI ETSI TS 129 198-11 V9.0.0 (2010-01)13GPP TS 29.198-11 version 9.0.0 Release 9Reference RTS/TSGC-0029198-11v900 Keywords GSM, LTE, UMTS 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 S

3、iret N 348 623 562 00017 - NAF 742 C Association but non lucratif enregistre la Sous-Prfecture 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

4、 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 Secre

5、tariat. 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, please sen

6、d your comment to one of the following services: http:/portal.etsi.org/chaircor/ETSI_support.asp 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 S

7、tandards Institute 2010. All rights reserved. DECTTM, PLUGTESTSTM, UMTSTM, TIPHONTM, the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered for the benefit of its Members. 3GPPTM is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.

8、LTE is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners. GSM and the GSM logo are Trade Marks registered and owned by the GSM Association. ETSI ETSI TS 129 198-11 V9.0.0 (2010-01)23GPP TS 29.198-11 version 9.0.0 Release 9Intellect

9、ual 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 (

10、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 se

11、arches, 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 Technical Specification (TS) has been prod

12、uced by ETSI 3rd Generation Partnership Project (3GPP). The present document may refer to technical specifications or reports using their 3GPP identities, UMTS identities or GSM identities. These should be interpreted as being references to the corresponding ETSI deliverables. The cross reference be

13、tween GSM, UMTS, 3GPP and ETSI identities can be found under http:/webapp.etsi.org/key/queryform.asp. ETSI ETSI TS 129 198-11 V9.0.0 (2010-01)33GPP TS 29.198-11 version 9.0.0 Release 9Contents Intellectual Property Rights 2g3Foreword . 2g3Foreword . 6g3Introduction 6g31 Scope 8g32 References 8g33 De

14、finitions and abbreviations . 9g33.1 Definitions 9g33.2 Abbreviations . 9g34 Account Management SCF 9g34.1 General requirements on support of methods . 9g35 Sequence Diagrams 10g35.1 Standard Voucher Handling . 10g35.2 Standard Transaction History Retrieval . 11g35.3 Standard Query Handling . 12g35.

15、4 Standard Notification handling. 13g35.5 Network Controlled Notifications 14g36 Class Diagrams . 15g37 The Service Interface Specifications 17g37.1 Interface Specification Format . 17g37.1.1 Interface Class 18g37.1.2 Method descriptions 18g37.1.3 Parameter descriptions 18g37.1.4 State Model . 18g37

16、.2 Base Interface . 18g37.2.1 Interface Class IpInterface 18g37.3 Service Interfaces . 18g37.3.1 Overview 18g37.4 Generic Service Interface . 19g37.4.1 Interface Class IpService 19g37.4.1.1 Method setCallback() 19g37.4.1.2 Method setCallbackWithSessionID() 19g38 Account Management Interface Classes

17、20g38.1 Interface Class IpAccountManager 20g38.1.1 Method createNotification() 20g38.1.2 Method destroyNotification() . 21g38.1.3 Method queryBalanceReq() 21g38.1.4 Method changeNotification() 22g38.1.5 Method getNotification() 22g38.1.6 Method retrieveTransactionHistoryReq() . 23g38.1.7 Method enab

18、leNotifications() . 23g38.1.8 Method disableNotifications() 24g38.1.9 Method queryBalanceExpiryDateReq() 24g38.1.10 Method updateBalanceReq() 24g38.1.11 Method createVoucherReq() . 25g38.1.12 Method destroyVoucherReq() 25g38.1.13 Method queryVoucherReq() . 26g38.1.14 Method queryUserVouchersReq() 26

19、g38.2 Interface Class IpAppAccountManager . 26g38.2.1 Method reportNotification() 27g3ETSI ETSI TS 129 198-11 V9.0.0 (2010-01)43GPP TS 29.198-11 version 9.0.0 Release 98.2.2 Method queryBalanceRes() 27g38.2.3 Method queryBalanceErr() . 28g38.2.4 Method retrieveTransactionHistoryRes() . 28g38.2.5 Met

20、hod retrieveTransactionHistoryErr() 28g38.2.6 Method queryBalanceExpiryDateRes() 28g38.2.7 Method queryBalanceExpiryDateErr(). 29g38.2.8 Method updateBalanceRes() . 29g38.2.9 Method updateBalanceErr() 29g38.2.10 Method createVoucherRes() . 29g38.2.11 Method createVoucherErr() 30g38.2.12 Method destr

21、oyVoucherRes() . 30g38.2.13 Method destroyVoucherErr() 30g38.2.14 Method queryVoucherRes() 30g38.2.15 Method queryVoucherErr() 31g38.2.16 Method queryUserVouchersRes() 31g38.2.17 Method queryUserVouchersErr() . 31g39 State Transition Diagrams 31g39.1 State Transition Diagrams for IpAccountManager .

22、31g39.1.1 Active State . 32g39.1.2 Notifications created State 32g310 Account Management Service Properties 32g311 Data Definitions . 34g311.1 Account Management Data Definitions . 34g311.1.1 IpAppAccountManager 34g311.1.2 IpAppAccountManagerRef . 34g311.1.3 IpAccountManager . 34g311.1.4 IpAccountMa

23、nagerRef 34g311.1.5 TpBalanceQueryError . 34g311.1.6 TpChargingEventName 35g311.1.7 TpBalanceInfo 35g311.1.8 TpChargingEventInfo . 36g311.1.9 TpChargingEventCriteria 36g311.1.10 TpChargingEventNameSet . 36g311.1.11 TpChargingEventCriteriaResult . 36g311.1.12 TpChargingEventCriteriaResultSet 36g311.1

24、.13 TpBalance . 36g311.1.14 TpBalanceSet 36g311.1.15 TpTransactionHistory . 37g311.1.16 TpTransactionHistorySet 37g311.1.17 TpTransactionHistoryStatus . 37g311.1.18 TpBalanceExpiryDate . 37g311.1.19 TpBalanceExpiryDateSet 37g311.1.20 TpVoucherError 37g311.1.21 TpVoucher 38g311.1.22 TpVoucherSet . 38

25、g312 Exception Classes . 38g3Annex A (normative): OMG IDL Description of Account Management SCF . 39g3Annex B (informative): W3C WSDL Description of Account Management SCF 40g3Annex C (informative): Java API Description of the Account Management SCF . 41g3Annex D (informative): Description of Accoun

26、t Management for 3GPP2 cdma2000 networks . 42g3D.1 General Exceptions. 42g3D.2 Specific Exceptions 42g3D.2.1 Clause 1: Scope 42g3D.2.2 Clause 2: References 42g3ETSI ETSI TS 129 198-11 V9.0.0 (2010-01)53GPP TS 29.198-11 version 9.0.0 Release 9D.2.3 Clause 3: Definitions and abbreviations . 42g3D.2.4

27、Clause 4: Account Management SCF . 42g3D.2.5 Clause 5: Sequence Diagrams 42g3D.2.6 Clause 6: Class Diagrams . 43g3D.2.7 Clause 7: The Service Interface Specifications 43g3D.2.8 Clause 8: Account Management Interface Classes . 43g3D.2.9 Clause 9: State Transition Diagrams 43g3D.2.10 Clause 10: Accoun

28、t Management Service Properties . 43g3D.2.11 Clause 11: Data Definitions 43g3D.2.12 Clause 12: Exception Classes . 43g3D.2.13 Annex A (normative): OMG IDL Description of Account Management SCF . 43g3D.2.14 Annex B (informative): W3C WSDL Description of Account Management SCF . 43g3Annex E (informati

29、ve): Change history . 44g3History 45g3ETSI ETSI TS 129 198-11 V9.0.0 (2010-01)63GPP TS 29.198-11 version 9.0.0 Release 9Foreword This Technical Specification has been produced by the 3rdGeneration Partnership Project (3GPP). The contents of the present document are subject to continuing work within

30、the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: Version x.y.z where: x the first digit: 1 presented to TSG for

31、information; 2 presented to TSG for approval; 3 or greater indicates TSG approved document under change control. y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. z the third digit is incremented when editorial only changes have b

32、een incorporated in the document. Introduction The present document is part 11 of a multi-part TS covering the 3rdGeneration Partnership Project: Technical Specification Group Core Network; Open Service Access (OSA); Application Programming Interface (API), as identified below. The API specification

33、 (3GPP TS 29.198) is structured in the following Parts: Part 1: “Overview“; Part 2: “Common Data Definitions“; Part 3: “Framework“; Part 4: “Call Control“; Sub-part 1: “Call Control Common Definitions“; Sub-part 2: “Generic Call Control SCF“; Sub-part 3: “Multi-Party Call Control SCF“; Sub-part 4: “

34、Multi-Media Call Control SCF“; Sub-part 5: “Conference 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“; (not part of 3GPP Release 8) Part 10: “Connectivity Manager SCF“

35、; (new in Release 8) Part 11: “Account Management SCF“; Part 12: “Charging SCF“. Part 13: “Policy Management SCF“; Part 14: “Presence and Availability Management SCF“; Part 15: “Multi Media Messaging SCF“; Part 16: “Service Broker SCF“. The Mapping specification of the OSA APIs and network protocols

36、 (3GPP TR 29.998) is also structured as above. A mapping to network protocols is however not applicable for all Parts, but the numbering of Parts is kept. Also in case a Part is not supported in a Release, the numbering of the parts is maintained. ETSI ETSI TS 129 198-11 V9.0.0 (2010-01)73GPP TS 29.

37、198-11 version 9.0.0 Release 9Table: Overview of the OSA APIs Application Programming Interface; Part 1: Overview“. 2 3GPP TS 22.127: “Service Requirement for the Open Services Access (OSA); Stage 1“. 3 3GPP TS 23.198: “Open Service Access (OSA); Stage 2“. 4 ISO 4217: “Codes for the representation o

38、f currencies and funds“. ETSI ETSI TS 129 198-11 V9.0.0 (2010-01)93GPP TS 29.198-11 version 9.0.0 Release 93 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in TS 29.198-1 1 apply. 3.2 Abbreviations For the purposes of the prese

39、nt document, the abbreviations given in TS 29.198-1 1 apply. 4 Account Management SCF The following clauses describe each aspect of the Account Management 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 impl

40、emented. The Class relationships clause shows 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 progression of interna

41、l processes either in the application, or Gateway. The Data definitions section shows 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

42、part of this specification. 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 param

43、eters 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 possi

44、ble, and no exception shall be returned. ETSI ETSI TS 129 198-11 V9.0.0 (2010-01)103GPP TS 29.198-11 version 9.0.0 Release 95 Sequence Diagrams 5.1 Standard Voucher Handling : IpAccountManager: IpAppAccountManager1: queryVoucherReq( )2: queryVoucherRes( )The application queries the voucher amountThe

45、 application updates the balance of the account3: updateBalanceReq( )4: updateBalanceRes( )5: destroyVoucherReq( )6: destroyVoucherRes( )1: This message is used to get a voucher for an amount. ETSI ETSI TS 129 198-11 V9.0.0 (2010-01)113GPP TS 29.198-11 version 9.0.0 Release 92: This message used to

46、return the amount requested. 3: This message is used to update the balance of the account. 4: This message is used to return the confirmation of the update. 5: This message is used to remove the voucher. 6: This message is used to confirm that the voucher is removed. 5.2 Standard Transaction History

47、 Retrieval : IpAppAccountManager: IpAccountManager1: retrieveTransactionHistoryReq( )2: retrieveTransactionHistoryRes( )1: This message is used by the application to retrieve a transaction history for a certain subscribers account. 2: This method passes the result of the transaction history retrieva

48、l request for a specific user to its callback object. ETSI ETSI TS 129 198-11 V9.0.0 (2010-01)123GPP TS 29.198-11 version 9.0.0 Release 95.3 Standard Query Handling : IpAppAccountManager : IpAccountManagerApplication is requesting to query the balance1: queryBalanceReq( )2: queryBalanceRes( )3: quer

49、yBalanceReq( )Application is requesting to query the balance, but there is at least one error in the p arameters that is de tected by the IpAccountManager service.4: queryBalanceReq( )Application is requesting to query the balance, but a network error occurs5: queryBalanceErr( )1: This message is used to query the balance of the account of one or several users. 2: This message passes the result of the balance query for one or several users to its callback object. 3: This scenario shows the case where at least one error in the parameters of the message