1、 ETSI ES 202 504-8 V1.1.1 (2008-05)ETSI Standard Open Service Access (OSA);Parlay X Web Services;Part 8: Terminal Status(Parlay X 3)floppy3 ETSI ETSI ES 202 504-8 V1.1.1 (2008-05) 2 Reference DES/TISPAN-01034-8-OSA Keywords API, OSA, service ETSI 650 Route des Lucioles F-06921 Sophia Antipolis Cedex
2、 - 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 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
3、 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
4、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.
5、asp If you find errors in the present document, please send 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 t
6、o reproduction in all media. European Telecommunications Standards Institute 2008. The Parlay Group 2008. 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 re
7、gistered for the benefit of its Members and of the 3GPP Organizational Partners. ETSI ETSI ES 202 504-8 V1.1.1 (2008-05) 3 Contents Intellectual Property Rights5 Foreword.5 1 Scope 7 2 References 7 2.1 Normative references .7 3 Definitions and abbreviations.8 3.1 Definitions8 3.2 Abbreviations .8 4
8、Detailed service description .8 5 Namespaces8 6 Sequence diagrams.9 6.1 Terminal status query .9 6.2 Terminal status group query.10 6.3 Terminal status notification11 6.4 Terminal Status Notification with Check Immediate .12 7 XML Schema data type definition .13 7.1 Status enumeration .13 7.2 Retrie
9、valStatus enumeration.13 7.3 StatusData structure14 7.4 StatusInformation structure 14 8 Web Service interface definition14 8.1 Interface: TerminalStatus .14 8.1.1 Operation: getStatus14 8.1.1.1 Input message: getStatusRequest 14 8.1.1.2 Output message: getStatusResponse .14 8.1.1.3 Referenced fault
10、s.14 8.1.2 Operation: getStatusForGroup15 8.1.2.1 Input message: getStatusForGroupRequest.15 8.1.2.2 Output message: getStatusForGroupResponse15 8.1.2.3 Referenced faults.15 8.2 Interface: TerminalStatusNotificationManager 15 8.2.1 Operation: startNotification 16 8.2.1.1 Input message: startNotifica
11、tionRequest.16 8.2.1.2 Output message: startNotificationResponse16 8.2.1.3 Referenced faults.16 8.2.2 Operation: endNotification .17 8.2.2.1 Input message: endNotificationRequest17 8.2.2.2 Output message: endNotificationResponse.17 8.2.2.3 Referenced faults.17 8.3 Interface: TerminalNotification17 8
12、.3.1 Operation: statusNotification17 8.3.1.1 Input message: statusNotificationRequest.18 8.3.1.2 Output message: statusNotificationResponse .18 8.3.1.3 Referenced faults.18 8.3.2 Operation: statusError.18 8.3.2.1 Input message: statusErrorRequest .18 8.3.2.2 Output message: statusErrorResponse 18 8.
13、3.2.3 Referenced faults.18 8.3.3 Operation: statusEnd.18 8.3.3.1 Input message: statusEndRequest .18 8.3.3.2 Output message: statusEndResponse 18 ETSI ETSI ES 202 504-8 V1.1.1 (2008-05) 4 8.3.3.3 Referenced faults.19 9 Fault definitions19 9.1 PolicyException .19 9.1.1 POL0200: Busy criteria not supp
14、orted .19 10 Service policies 19 Annex A (normative): WSDL for Terminal Status.20 Annex B (informative): Bibliography.21 History 22 ETSI ETSI ES 202 504-8 V1.1.1 (2008-05) 5 Intellectual Property Rights IPRs essential or potentially essential to the present document may have been declared to ETSI. T
15、he 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 f
16、rom 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 E
17、TSI 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 Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISP
18、AN). The present document is part 8 of a multi-part deliverable covering Open Service Access (OSA); Parlay X Web Services, as identified below: Part 1: “Common“; Part 2: “Third Party Call“; Part 3: “Call Notification“; Part 4: “Short Messaging“; Part 5: “Multimedia Messaging“; Part 6: “Payment“; Par
19、t 7: “Account Management“; Part 8: “Terminal Status“; Part 9: “Terminal Location“; Part 10: “Call Handling“; Part 11: “Audio Call“; Part 12: “Multimedia Conference“; Part 13: “Address List Management“; Part 14: “Presence“; Part 15: “Message Broadcast“; Part 16: “Geocoding“; Part 17: “Application-dri
20、ven Quality of Service (QoS)“; Part 18: “Device Capabilities and Configuration“; Part 19: “Multimedia Streaming Control“; Part 20: “Multimedia Multicast Session Management“. ETSI ETSI ES 202 504-8 V1.1.1 (2008-05) 6 The present document has been defined jointly between ETSI, The Parlay Group (http:/
21、www.parlay.org) and the 3GPP. The present document forms part of the Parlay X 3.0 set of specifications. The present document is equivalent to 3GPP TS 29.199-08 V7.0.2 (Release 7). ETSI ETSI ES 202 504-8 V1.1.1 (2008-05) 7 1 Scope The present document is part 8 of the Stage 3 Parlay X 3 Web Services
22、 specification for Open Service Access (OSA). The OSA specifications define an architecture that enables application developers to make use of network functionality through an open standardized interface, i.e. the OSA APIs. The present document specifies the Terminal Status Web Service. The followin
23、g are defined here: Name spaces. Sequence diagrams. Data definitions. Interface specification plus detailed method descriptions. Fault definitions. Service Policies. WSDL Description of the interfaces. 2 References References are either specific (identified by date of publication and/or edition numb
24、er or version number) or non-specific. For a specific reference, subsequent revisions do not apply. Non-specific reference may be made only to a complete document or a part thereof and only in the following cases: - if it is accepted that it will be possible to use all future changes of the referenc
25、ed document for the purposes of the referring document; - for informative references. Referenced documents which are not found to be publicly available in the expected location might be found at http:/docbox.etsi.org/Reference. For online referenced documents, information sufficient to identify and
26、locate the source shall be provided. Preferably, the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the method of access
27、 to the referenced document and the full network address, with the same punctuation and use of upper case and lower case letters. NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee their long term validity. 2.1 Normative references The foll
28、owing referenced documents are indispensable for the application of the present document. For dated references, only the edition cited applies. For non-specific references, the latest edition of the referenced document (including any amendments) applies. 1 W3C Recommendation (2 May 2001): “XML Schem
29、a Part 2: Datatypes“. NOTE: Available at http:/www.w3.org/TR/2001/REC-xmlschema-2-20010502/. ETSI ETSI ES 202 504-8 V1.1.1 (2008-05) 8 2 ETSI ES 202 504-1: “ Open Service Access (OSA); Parlay X Web Services; Part 1: Common (Parlay X 3)“. 3 Definitions and abbreviations 3.1 Definitions For the purpos
30、es of the present document, the terms and definitions given in ES 202 504-1 2 apply. 3.2 Abbreviations For the purposes of the present document, the abbreviations given in ES 202 504-1 2 apply. 4 Detailed service description Terminal Status provides access to the status of a terminal through: Reques
31、t for the status of a terminal. Request for the status of a group of terminals. Notification of a change in the status of a terminal. The status of a terminal can be expressed as reachable, unreachable or busy - however not all terminals distinguish a busy status, so applications should be able to a
32、dapt to what information is available (using the service properties to determine available information). When a request for a group of terminals is made, the response may contain a full or partial set of results. This allows the service to provide results based on a number of criteria including numb
33、er of terminals for which the request is made and amount of time required to retrieve the information. This allows the requester to initiate additional requests for those terminals for which information was not provided. 5 Namespaces The TerminalStatus interface uses the namespace: http:/www.csapi.o
34、rg/wsdl/parlayx/terminal_status/v3_0 The TerminalStatusNotificationManager interface uses the namespace: http:/www.csapi.org/wsdl/parlayx/terminal_status/notification_manager/v3_0 The TerminalStatusNotification interface uses the namespace: http:/www.csapi.org/wsdl/parlayx/terminal_status/notificati
35、on/v3_0 The data types are defined in the namespace: http:/www.csapi.org/schema/parlayx/terminal_status/v3_0 The “xsd“ namespace is used in the present document to refer to the XML Schema data types defined in XML Schema 1. The use of the name “xsd“ is not semantically significant. ETSI ETSI ES 202
36、504-8 V1.1.1 (2008-05) 9 6 Sequence diagrams 6.1 Terminal status query Pattern: Request / Response. When an application is interested in determining the status of a terminal device, it may provide a terminal device address, and receive the status for the device requested. : Application : Terminal St
37、atusgetStatusRetrieve terminal statusStatusFigure 1 ETSI ETSI ES 202 504-8 V1.1.1 (2008-05) 106.2 Terminal status group query Pattern: Request / Response. When an application is interested in determining the status of a set of terminal devices, it may provide an array of terminal device addresses, i
38、ncluding network managed group addresses, and receive the status for the set of devices requested. : Application : Terminal StatusgetStatusForGroupRetrieve terminal statusStatus listProcess groupsFigure 2 ETSI ETSI ES 202 504-8 V1.1.1 (2008-05) 116.3 Terminal status notification Pattern: Application
39、 Correlated Multiple Notification. An application can be notified of a change in the status of terminal devices. When the status of a terminal device changes, a notification message will be sent to the application. : Application : Notification Application: Notification Web Service: Terminal Status N
40、otificationAt some later time, an event occurs to trigger the notificationAt some later time, the notification may be cancelledCreate correlation idstatusNotificationstartNotificationendNotificationFigure 3 ETSI ETSI ES 202 504-8 V1.1.1 (2008-05) 126.4 Terminal Status Notification with Check Immedia
41、te In some applications, the terminal status notification will be used to watch for a specific status change. An example is a “call when available“ service, where the terminal status is checked and determined to be not reachable or busy, and a notification is set up to notify the application when th
42、e terminal becomes reachable. Between the time that the original status determination and the time the notification is set up, the terminal status could change to reachable, thus the notification on change to reachable would not be sent. Using the check immediate flag, after the notification is esta
43、blished, the value of the terminal status will be determined, and if the criteria is matched then a notification will be sent immediately. The following sequence diagram shows this scenario. : Application : Terminal Status: Notification Application: Notification Web Service: Terminal Status Notifica
44、tionCreate correlation idstatusNotificationgetStatusStatusstartNotification with Check Immediate = trueSet up notificationCheck terminal statusvoidApply count to notificationstatusEndFigure 4 ETSI ETSI ES 202 504-8 V1.1.1 (2008-05) 13This sequence shows: The Enterprise Application checks the status
45、of a terminal, and receives its status (in this scenario receiving Unreachable or Busy). The Enterprise Application generates a correlator, and starts a notification with criteria defined to notify the Enterprise Web Service when the terminal state becomes Reachable and the check immediate flag set
46、to true. Sets up the notification to monitor terminal status changes. Check the current status of the terminal, and determine if the status matches the criteria. In this case, the criteria matches, and a notification is delivered to the Enterprise Web Service. The count of notifications is increment
47、ed and compared to the notification count limit. In this case, a single notification was requested, and the end notification message is sent. The startNotification operation completes. This scenario includes the full set of interactions in one sequence, which also shows that the notifications can be
48、 received concurrent with the creation of the notification. 7 XML Schema data type definition 7.1 Status enumeration List of possible status values. Enumeration value Description Reachable Terminal is reachable Unreachable Terminal is not reachable Busy Terminal is busy 7.2 RetrievalStatus enumerati
49、on Enumeration of the status items that are related to an individual retrieval in a set. Enumeration value Description Retrieved Status retrieved, with result in currentStatus element NotRetrieved Status not retrieved, currentStatus is not provided (does not indicate an error, no attempt may have been made) Error Error retrieving status ETSI ETSI ES 202 504-8 V1.1.1 (2008-05) 147.3 StatusData structure Data structure containing device identifier and its status. As this can be related to a query of a group of terminal dev
