1、 ETSI ES 202 391-8 V1.3.1 (2008-05)ETSI Standard Open Service Access (OSA);Parlay X Web Services;Part 8: Terminal Status(Parlay X 2)floppy3 ETSI ETSI ES 202 391-8 V1.3.1 (2008-05) 2 Reference RES/TISPAN-01056-08-OSA Keywords API, OSA, service ETSI 650 Route des Lucioles F-06921 Sophia Antipolis Cede
2、x - 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 documen
3、t 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
6、to 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 r
7、egistered for the benefit of its Members and of the 3GPP Organizational Partners. ETSI ETSI ES 202 391-8 V1.3.1 (2008-05) 3 Contents Intellectual Property Rights5 Foreword.5 1 Scope 6 2 References 6 2.1 Normative references .6 3 Definitions and abbreviations.7 3.1 Definitions7 3.2 Abbreviations .7 4
8、 Detailed service description .7 5 Namespaces7 6 Sequence diagrams.8 6.1 Terminal status query .8 6.2 Terminal status group query.9 6.3 Terminal status notification10 6.4 Terminal Status Notification with Check Immediate .11 7 XML Schema data type definition .12 7.1 Status enumeration .12 7.2 Retrie
9、valStatus enumeration.12 7.3 StatusData structure13 7.4 StatusInformation structure 13 8 Web Service interface definition13 8.1 Interface: TerminalStatus .13 8.1.1 Operation: getStatus13 8.1.1.1 Input message: getStatusRequest 13 8.1.1.2 Output message: getStatusResponse .13 8.1.1.3 Referenced fault
10、s.13 8.1.2 Operation: getStatusForGroup14 8.1.2.1 Input message: getStatusForGroupRequest.14 8.1.2.2 Output message: getStatusForGroupResponse14 8.1.2.3 Referenced faults.14 8.2 Interface: TerminalStatusNotificationManager 14 8.2.1 Operation: startNotification 15 8.2.1.1 Input message: startNotifica
11、tionRequest.15 8.2.1.2 Output message: startNotificationResponse15 8.2.1.3 Referenced faults.15 8.2.2 Operation: endNotification .16 8.2.2.1 Input message: endNotificationRequest16 8.2.2.2 Output message: endNotificationResponse.16 8.2.2.3 Referenced faults.16 8.3 Interface: TerminalNotification16 8
12、.3.1 Operation: statusNotification16 8.3.1.1 Input message: statusNotificationRequest.17 8.3.1.2 Output message: statusNotificationResponse .17 8.3.1.3 Referenced faults.17 8.3.2 Operation: statusError.17 8.3.2.1 Input message: statusErrorRequest .17 8.3.2.2 Output message: statusErrorResponse 17 8.
13、3.2.3 Referenced faults.17 8.3.3 Operation: statusEnd.17 8.3.3.1 Input message: statusEndRequest .17 8.3.3.2 Output message: statusEndResponse 17 ETSI ETSI ES 202 391-8 V1.3.1 (2008-05) 4 8.3.3.3 Referenced faults.18 9 Fault definitions18 9.1 PolicyException .18 9.1.1 POL0200: Busy criteria not supp
14、orted .18 10 Service policies 18 Annex A (normative): WSDL for Terminal Status.19 Annex B (informative): Bibliography.20 History 21 ETSI ETSI ES 202 391-8 V1.3.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“. The present document has been defined jointly between ETSI, The Parlay Group
20、(http:/www.parlay.org) and the 3GPP. The present document forms part of the Parlay X 2.2 set of specifications. The present document is equivalent to 3GPP TS 29.199-08 V6.5.0 (Release 6). ETSI ETSI ES 202 391-8 V1.3.1 (2008-05) 6 1 Scope The present document is part 8 of the Stage 3 Parlay X 2 Web S
21、ervices 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 f
22、ollowing 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 editi
23、on number 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 r
24、eferenced 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 identi
25、fy and 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
26、 access 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 T
27、he following 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): “XM
28、L Schema Part 2: Datatypes“. NOTE: Available at http:/www.w3.org/TR/2001/REC-xmlschema-2-20010502/. ETSI ETSI ES 202 391-8 V1.3.1 (2008-05) 7 2 ETSI ES 202 391-1: “ Open Service Access (OSA); Parlay X Web Services; Part 1: Common (Parlay X 2)“. 3 Definitions and abbreviations 3.1 Definitions For the
29、 purposes of the present document, the terms and definitions given in ES 202 391-1 2 apply. 3.2 Abbreviations For the purposes of the present document, the abbreviations given in ES 202 391-1 2 apply. 4 Detailed service description Terminal Status provides access to the status of a terminal through:
30、 Request 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 ab
31、le to adapt 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 includi
32、ng number 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.
33、csapi.org/wsdl/parlayx/terminal_status/v2_3 The TerminalStatusNotificationManager interface uses the namespace: http:/www.csapi.org/wsdl/parlayx/terminal_status/notification_manager/v2_3 The TerminalStatusNotification interface uses the namespace: http:/www.csapi.org/wsdl/parlayx/terminal_status/not
34、ification/v2_2 The data types are defined in the namespace: http:/www.csapi.org/schema/parlayx/terminal_status/v2_2 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
35、ES 202 391-8 V1.3.1 (2008-05) 8 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 : Term
36、inal StatusgetStatusRetrieve terminal statusStatusFigure 1 ETSI ETSI ES 202 391-8 V1.3.1 (2008-05) 9 6.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 addre
37、sses, including 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 391-8 V1.3.1 (2008-05) 106.3 Terminal status notification Pattern: Appl
38、ication 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 S
39、tatus NotificationAt 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 391-8 V1.3.1 (2008-05) 116.4 Terminal Status Notification with Check
40、Immediate 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
41、when the 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
42、is established, 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 N
43、otificationCreate correlation idstatusNotificationgetStatusStatusstartNotification with Check Immediate = trueSet up notificationCheck terminal statusvoidApply count to notificationstatusEndFigure 4 ETSI ETSI ES 202 391-8 V1.3.1 (2008-05) 12This sequence shows: The Enterprise Application checks the
44、status 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 fl
45、ag set 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 in
46、cremented 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
47、 can be 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 en
48、umeration 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
49、have been made) Error Error retrieving status ETSI ETSI ES 202 391-8 V1.3.1 (2008-05) 137.3 StatusData structure Data structure containing device identifier and its status. As this can be related to a query of a group of terminal devices, the reportStatus element is used to indicate whether the information for the device was retrieved or not, or if an error occurred. Element name Element type Optional Description address xsd:anyURI No Address of the Terminal Device to which the status information applies reportStatus Ret
