SIST ES 202 504-14 V1.1.1:2008
Open Service Access (OSA) - Parlay X Web Services - Part 14: Presence (Parlay X 3)
Open Service Access (OSA) - Parlay X Web Services - Part 14: Presence (Parlay X 3)
New edition of ParlayX specification based on requirements in EG 201 988-4, corresponding to 3GPP TS 29.199 Rel-7.The present document is part 14 of the Stage 3 Parlay X 3 Web Services 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 Presence Web Service. The following are defined here:
• Name spaces.
• Sequence diagrams.
• Data definitions.
• Interface specification plus detailed method descriptions.
• Fault definitions.
• Service Policies.
• WSDL Description of the interfaces.
Odprti dostop do storitve (OSA) - Spletne storitve Parlay X - 14. del: Navzočnost (Parlay X 3)
General Information
Buy Standard
Standards Content (Sample)
ETSI ES 202 504-14 V1.1.1 (2008-05)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 14: Presence
(Parlay X 3)
�
---------------------- Page: 1 ----------------------
2 ETSI ES 202 504-14 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-14-OSA
Keywords
API, OSA, service
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, 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 to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
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
---------------------- Page: 2 ----------------------
3 ETSI ES 202 504-14 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.6
Foreword.6
1 Scope.8
2 References.8
2.1 Normative references.8
3 Definitions and abbreviations.9
3.1 Definitions.9
3.2 Abbreviations.10
4 Detailed service description .10
5 Namespaces.11
6 Sequence diagrams.12
6.1 Interface flow overview.12
7 XML Schema data type definition .13
7.1 PresenceAttributeType enumeration.13
7.2 ActivityValue enumeration.13
7.3 PlaceTypeValue enumeration.14
7.4 PrivacyType enumeration.15
7.5 SphereValue enumeration.15
7.6 CommunicationMeansType enumeration.15
7.7 CommunicationMeans structure.15
7.8 CommunicationValue structure.16
7.9 OtherValue structure.16
7.10 PresenceAttribute structure.16
7.10a AttributeTypeAndValue union.16
7.11 SubscriptionRequest structure.16
7.12 PresencePermission structure.17
7.13 CommunicationStatusType enumeration.17
7.14 PrivacyValue structure.17
7.15 MoodValue enumeration.17
7.16 PlaceIsValue structure.18
7.17 PlaceIsAudioValue enumeration.19
7.18 PlaceIsVideoValue enumeration.19
7.19 PlaceIsTextValue enumeration.19
7.20 RelationshipValue enumeration.19
7.21 TimeOffsetValue structure.20
7.22 StatusIconValue structure.20
7.23 Watcher structure.20
7.24 WatcherSubscriptionStatus enumeration.20
8 Web Service interface definition.20
8.1 Interface: PresenceConsumer.20
8.1.1 Operation: subscribePresence.21
8.1.1.1 Input message: subscribePresenceRequest.21
8.1.1.2 Output message: subscribePresenceResponse.21
8.1.1.3 Referenced faults.21
8.1.2 Operation: getUserPresence.22
8.1.2.1 Input message: getUserPresenceRequest .22
8.1.2.2 Output message: getUserPresenceResponse.22
8.1.2.3 Referenced faults.22
8.1.3 Operation: startPresenceNotification.22
8.1.3.1 Input message: startPresenceNotificationRequest.23
8.1.3.2 Output message: startPresenceNotificationResponse.23
ETSI
---------------------- Page: 3 ----------------------
4 ETSI ES 202 504-14 V1.1.1 (2008-05)
8.1.3.3 Referenced faults.23
8.1.4 Operation: endPresenceNotification.24
8.1.4.1 Input message: endPresenceNotificationRequest.24
8.1.4.2 Output message: endPresenceNotificationResponse.24
8.1.4.3 Referenced faults.24
8.2 Interface: PresenceNotification.24
8.2.1 Operation: statusChanged.24
8.2.1.1 Input message: statusChangedRequest.24
8.2.1.2 Output message: statusChangedResponse.25
8.2.1.3 Referenced faults.25
8.2.2 Operation: statusEnd.25
8.2.2.1 Input message: statusEndRequest .25
8.2.2.2 Output message: statusEndResponse.25
8.2.2.3 Referenced faults.25
8.2.3 Operation: notifySubscription.25
8.2.3.1 Input message: notifySubscriptionRequest .25
8.2.3.2 Output message: notifySubscriptionResponse .25
8.2.3.3 Referenced faults.25
8.2.4 Operation: subscriptionEnded.26
8.2.4.1 Input message: subscriptionEndedRequest .26
8.2.4.2 Output message: subscriptionEndedResponse.26
8.2.4.3 Referenced faults.26
8.3 Interface: PresenceSupplier.26
8.3.1 Operation: publish.26
8.3.1.1 Input message: publishRequest.26
8.3.1.2 Output message: publishResponse.26
8.3.1.3 Referenced faults.27
8.3.2 Operation: getOpenSubscriptions.27
8.3.2.1 Input message: getOpenSubscriptionsRequest.27
8.3.2.2 Output message: getOpenSubscriptionsResponse.27
8.3.2.3 Referenced faults.27
8.3.3 Operation: updateSubscriptionAuthorization.27
8.3.3.1 Input message: updateSubscriptionAuthorizationRequest .28
8.3.3.2 Output message: updateSubscriptionAuthorizationResponse .28
8.3.3.3 Referenced faults.28
8.3.4 Operation: getMyWatchers.28
8.3.4.1 Input message: getMyWatchersRequest .29
8.3.4.2 Output message: getMyWatchersResponse.29
8.3.4.3 Referenced faults.29
8.3.5 Operation: getSubscribedAttributes.29
8.3.5.1 Input message: getSubscribedAttributesRequest .29
8.3.5.2 Output message: getSubscribedAttributesResponse .29
8.3.5.3 Referenced faults.29
8.3.6 Operation: blockSubscription.30
8.3.6.1 Input message: blockSubscriptionRequest.30
8.3.6.2 Output message: blockSubscriptionResponse.30
8.3.6.3 Referenced faults.30
8.4 Interface: PresenceSupplierNotificationManager.30
8.4.1 Operation: startSubscriptionNotification .30
8.4.1.1 Input message: startSubscriptionNotificationRequest.31
8.4.1.2 Output message: startSubscriptionNotificationResponse.31
8.4.1.3 Referenced Faults.31
8.4.2 Operation: endNotification.31
8.4.2.1 Input message: endNotificationRequest.31
8.4.2.2 Output message: endNotificationResponse.32
8.4.2.3 Referenced Faults.32
8.5 Interface: PresenceSupplierNotification.32
8.5.1 Operation: notifyOpenSubscription.32
8.5.1.1 Input message: notifyOpenSubscriptionRequest.32
8.5.1.2 Output message: notifyOpenSubscriptionResponse.32
8.5.1.3 Referenced faults.32
8.5.2 Operation: notifyError.32
ETSI
---------------------- Page: 4 ----------------------
5 ETSI ES 202 504-14 V1.1.1 (2008-05)
8.5.2.1 Input message: notifyErrorRequest.32
8.5.2.2 Output message: notifyErrorResponse.33
8.5.2.3 Referenced faults.33
8.5.3 Operation: notifyEnd.33
8.5.3.1 Input message: notifyEndRequest.33
8.5.3.2 Output message: notifyEndResponse.33
8.5.3.3 Referenced faults.33
9 Fault definitions.33
9.1 ServiceException.33
9.1.1 SVC0220: No subscription request.33
9.1.2 SVC0221: Not a watcher .33
10 Service policies .34
Annex A (normative): WSDL for Presence .35
Annex B (informative): Bibliography.36
History .37
ETSI
---------------------- Page: 5 ----------------------
6 ETSI ES 202 504-14 V1.1.1 (2008-05)
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 Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN).
The present document is part 14 of a multi-part deliverable covering Open Service Access (OSA); Parlay X 3 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";
Part 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-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
---------------------- Page: 6 ----------------------
7 ETSI ES 202 504-14 V1.1.1 (2008-05)
The present document has been defined jointly between ETSI, The Parlay Group (http://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-14 V7.4.0 (Release 7).
ETSI
---------------------- Page: 7 ----------------------
8 ETSI ES 202 504-14 V1.1.1 (2008-05)
1 Scope
The present document is part 14 of the Stage 3 Parlay X 3 Web Services 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 Presence Web Service. The following 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 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 referenced 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 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 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 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] ETSI TR 121 905: "Digital cellular telecommunications system (Phase 2+); Universal Mobile
Telecommunications System (UMTS); Vocabulary for 3GPP Specifications (3GPP TR 21.905)".
ETSI
---------------------- Page: 8 ----------------------
9 ETSI ES 202 504-14 V1.1.1 (2008-05)
[2] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".
NOTE: Available at http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/.
[3] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
[4] ETSI ES 202 915-14: "Open Service Access (OSA); Application Programming Interface (API);
Part 14: Presence and Availability Management SCF (Parlay 4)".
[5] IETF RFC 3856: "A Presence Event Package for the Session Initiation Protocol (SIP)".
http://www.ietf.org/rfc/rfc3856.txt.
[6] Void.
[7] ETSI ES 202 504-13: "Open Service Access (OSA); Parlay X Web Services; Part 13: Address List
Management (Parlay X 3)".
[8] IETF RFC 3265: "Session Initiation Protocol (SIP)-Specific Event Notification".
[9] Void.
[10] ETSI ES 202 504-8: "Open Service Access (OSA); Parlay X Web Services; Part 8: Terminal
Status (Parlay X 3)".
[11] ETSI ES 202 504-9: "Open Service Access (OSA); Parlay X Web Services; Part 9: Terminal
Location (Parlay X 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 504-1 [3] and the following apply:
applications: For Instant Messaging, Push to Talk, or call control and other purposes may become clients of the
presence Web Service. We assume that these applications belong to a watcher and authenticate to the services in the
name of the watcher.
identity: represents a user in the real world
NOTE: See Parlay/OSA PAM identities [4], clause 4.4.1.
presence attributes: Contain information about a presentity. An attribute has a name and a value and can be supplied
by any device, application or network module that can be associated to the presentity's identity. A watcher can obtains
attributes only after he has successfully subscribed to them. Examples for attributes are activity, location type,
communication means, etc.
presence information: Consists of a set of attributes that characterize the presentity such as current activity,
environment, communication means and contact addresses. Only the system and the presentity have direct access to this
information, which may be collected and aggregated from several devices associated to the presentity.
subscription: Before a watcher can access presence data, he has to subscribe to it. One possibility the API provides is
an end-to-end subscription concept, in which only identities that have accepted a subscription to their presence can be
addressed. Subscriptions can be also automatically handled by server policies edited by the presentity or other
authorized users. The service/protocol to manage those policies is out of the scope of the present document.
NOTE: This definition is not related to the term "subscription" in TR 121 905 [1].
watcher and presentity: We use these names to denote the role of the client connected to the presence services.
As in Parlay/OSA PAM [4] the watcher and the presentity have to be associated to identities registered to the system,
i.e. users, groups of users or organizations.
ETSI
---------------------- Page: 9 ----------------------
10 ETSI ES 202 504-14 V1.1.1 (2008-05)
3.2 Abbreviations
For the purposes of the present document, the abbreviations
...
Final draft ETSI ES 202 504-14 V1.1.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 14: Presence
(Parlay X 3)
�
---------------------- Page: 1 ----------------------
2 Final draft ETSI ES 202 504-14 V1.1.1 (2008-02)
Reference
DES/TISPAN-01034-14-OSA
Keywords
API, OSA, service
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, 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 to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
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
---------------------- Page: 2 ----------------------
3 Final draft ETSI ES 202 504-14 V1.1.1 (2008-02)
Contents
Intellectual Property Rights.6
Foreword.6
1 Scope.8
2 References.8
2.1 Normative references.8
3 Definitions and abbreviations.9
3.1 Definitions.9
3.2 Abbreviations.10
4 Detailed service description .10
5 Namespaces.11
6 Sequence diagrams.12
6.1 Interface flow overview.12
7 XML Schema data type definition .13
7.1 PresenceAttributeType enumeration.13
7.2 ActivityValue enumeration.13
7.3 PlaceTypeValue enumeration.14
7.4 PrivacyType enumeration.15
7.5 SphereValue enumeration.15
7.6 CommunicationMeansType enumeration.15
7.7 CommunicationMeans structure.15
7.8 CommunicationValue structure.16
7.9 OtherValue structure.16
7.10 PresenceAttribute structure.16
7.10a AttributeTypeAndValue union.16
7.11 SubscriptionRequest structure.16
7.12 PresencePermission structure.17
7.13 CommunicationStatusType enumeration.17
7.14 PrivacyValue structure.17
7.15 MoodValue enumeration.17
7.16 PlaceIsValue structure.18
7.17 PlaceIsAudioValue enumeration.19
7.18 PlaceIsVideoValue enumeration.19
7.19 PlaceIsTextValue enumeration.19
7.20 RelationshipValue enumeration.19
7.21 TimeOffsetValue structure.20
7.22 StatusIconValue structure.20
7.23 Watcher structure.20
7.24 WatcherSubscriptionStatus enumeration.20
8 Web Service interface definition.20
8.1 Interface: PresenceConsumer.20
8.1.1 Operation: subscribePresence.21
8.1.1.1 Input message: subscribePresenceRequest.21
8.1.1.2 Output message: subscribePresenceResponse.21
8.1.1.3 Referenced faults.21
8.1.2 Operation: getUserPresence.22
8.1.2.1 Input message: getUserPresenceRequest .22
8.1.2.2 Output message: getUserPresenceResponse.22
8.1.2.3 Referenced faults.22
8.1.3 Operation: startPresenceNotification.22
8.1.3.1 Input message: startPresenceNotificationRequest.23
8.1.3.2 Output message: startPresenceNotificationResponse.23
ETSI
---------------------- Page: 3 ----------------------
4 Final draft ETSI ES 202 504-14 V1.1.1 (2008-02)
8.1.3.3 Referenced faults.23
8.1.4 Operation: endPresenceNotification.24
8.1.4.1 Input message: endPresenceNotificationRequest.24
8.1.4.2 Output message: endPresenceNotificationResponse.24
8.1.4.3 Referenced faults.24
8.2 Interface: PresenceNotification.24
8.2.1 Operation: statusChanged.24
8.2.1.1 Input message: statusChangedRequest.24
8.2.1.2 Output message: statusChangedResponse.25
8.2.1.3 Referenced faults.25
8.2.2 Operation: statusEnd.25
8.2.2.1 Input message: statusEndRequest .25
8.2.2.2 Output message: statusEndResponse.25
8.2.2.3 Referenced faults.25
8.2.3 Operation: notifySubscription.25
8.2.3.1 Input message: notifySubscriptionRequest .25
8.2.3.2 Output message: notifySubscriptionResponse .25
8.2.3.3 Referenced faults.25
8.2.4 Operation: subscriptionEnded.26
8.2.4.1 Input message: subscriptionEndedRequest .26
8.2.4.2 Output message: subscriptionEndedResponse.26
8.2.4.3 Referenced faults.26
8.3 Interface: PresenceSupplier.26
8.3.1 Operation: publish.26
8.3.1.1 Input message: publishRequest.26
8.3.1.2 Output message: publishResponse.26
8.3.1.3 Referenced faults.27
8.3.2 Operation: getOpenSubscriptions.27
8.3.2.1 Input message: getOpenSubscriptionsRequest.27
8.3.2.2 Output message: getOpenSubscriptionsResponse.27
8.3.2.3 Referenced faults.27
8.3.3 Operation: updateSubscriptionAuthorization.27
8.3.3.1 Input message: updateSubscriptionAuthorizationRequest .28
8.3.3.2 Output message: updateSubscriptionAuthorizationResponse .28
8.3.3.3 Referenced faults.28
8.3.4 Operation: getMyWatchers.28
8.3.4.1 Input message: getMyWatchersRequest .29
8.3.4.2 Output message: getMyWatchersResponse.29
8.3.4.3 Referenced faults.29
8.3.5 Operation: getSubscribedAttributes.29
8.3.5.1 Input message: getSubscribedAttributesRequest .29
8.3.5.2 Output message: getSubscribedAttributesResponse .29
8.3.5.3 Referenced faults.29
8.3.6 Operation: blockSubscription.30
8.3.6.1 Input message: blockSubscriptionRequest.30
8.3.6.2 Output message: blockSubscriptionResponse.30
8.3.6.3 Referenced faults.30
8.4 Interface: PresenceSupplierNotificationManager.30
8.4.1 Operation: startSubscriptionNotification .30
8.4.1.1 Input message: startSubscriptionNotificationRequest.31
8.4.1.2 Output message: startSubscriptionNotificationResponse.31
8.4.1.3 Referenced Faults.31
8.4.2 Operation: endNotification.31
8.4.2.1 Input message: endNotificationRequest.31
8.4.2.2 Output message: endNotificationResponse.32
8.4.2.3 Referenced Faults.32
8.5 Interface: PresenceSupplierNotification.32
8.5.1 Operation: notifyOpenSubscription.32
8.5.1.1 Input message: notifyOpenSubscriptionRequest.32
8.5.1.2 Output message: notifyOpenSubscriptionResponse.32
8.5.1.3 Referenced faults.32
8.5.2 Operation: notifyError.32
ETSI
---------------------- Page: 4 ----------------------
5 Final draft ETSI ES 202 504-14 V1.1.1 (2008-02)
8.5.2.1 Input message: notifyErrorRequest.32
8.5.2.2 Output message: notifyErrorResponse.33
8.5.2.3 Referenced faults.33
8.5.3 Operation: notifyEnd.33
8.5.3.1 Input message: notifyEndRequest.33
8.5.3.2 Output message: notifyEndResponse.33
8.5.3.3 Referenced faults.33
9 Fault definitions.33
9.1 ServiceException.33
9.1.1 SVC0220: No subscription request.33
9.1.2 SVC0221: Not a watcher .33
10 Service policies .34
Annex A (normative): WSDL for Presence .35
Annex B (informative): Bibliography.36
History .37
ETSI
---------------------- Page: 5 ----------------------
6 Final draft ETSI ES 202 504-14 V1.1.1 (2008-02)
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 Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN), and is now submitted for the ETSI standards
Membership Approval Procedure.
The present document is part 14 of a multi-part deliverable covering Open Service Access (OSA); Parlay X 3 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";
Part 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-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
---------------------- Page: 6 ----------------------
7 Final draft ETSI ES 202 504-14 V1.1.1 (2008-02)
The present document has been defined jointly between ETSI, The Parlay Group (http://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-14 V7.4.0 (Release 7).
ETSI
---------------------- Page: 7 ----------------------
8 Final draft ETSI ES 202 504-14 V1.1.1 (2008-02)
1 Scope
The present document is part 14 of the Stage 3 Parlay X 3 Web Services 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 Presence Web Service. The following 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 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 referenced 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 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 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 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] ETSI TR 121 905: "Digital cellular telecommunications system (Phase 2+); Universal Mobile
Telecommunications System (UMTS); Vocabulary for 3GPP Specifications (3GPP TR 21.905)".
ETSI
---------------------- Page: 8 ----------------------
9 Final draft ETSI ES 202 504-14 V1.1.1 (2008-02)
[2] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".
NOTE: Available at http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/.
[3] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
[4] ETSI ES 202 915-14: "Open Service Access (OSA); Application Programming Interface (API);
Part 14: Presence and Availability Management SCF (Parlay 4)".
[5] IETF RFC 3856: "A Presence Event Package for the Session Initiation Protocol (SIP)".
http://www.ietf.org/rfc/rfc3856.txt.
[6] Void.
[7] ETSI ES 202 504-13: "Open Service Access (OSA); Parlay X Web Services; Part 13: Address List
Management (Parlay X 3)".
[8] IETF RFC 3265: "Session Initiation Protocol (SIP)-Specific Event Notification".
[9] Void.
[10] ETSI ES 202 504-8: "Open Service Access (OSA); Parlay X Web Services; Part 8: Terminal
Status (Parlay X 3)".
[11] ETSI ES 202 504-9: "Open Service Access (OSA); Parlay X Web Services; Part 9: Terminal
Location (Parlay X 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 504-1 [3] and the following apply:
applications: For Instant Messaging, Push to Talk, or call control and other purposes may become clients of the
presence Web Service. We assume that these applications belong to a watcher and authenticate to the services in the
name of the watcher.
identity: represents a user in the real world
NOTE: See Parlay/OSA PAM identities [4], clause 4.4.1.
presence attributes: Contain information about a presentity. An attribute has a name and a value and can be supplied
by any device, application or network module that can be associated to the presentity's identity. A watcher can obtains
attributes only after he has successfully subscribed to them. Examples for attributes are activity, location type,
communication means, etc.
presence information: Consists of a set of attributes that characterize the presentity such as current activity,
environment, communication means and contact addresses. Only the system and the presentity have direct access to this
information, which may be collected and aggregated from several devices associated to the presentity.
subscription: Before a watcher can access presence data, he has to subscribe to it. One possibility the API provides is
an end-to-end subscription concept, in which only identities that have accepted a subscription to their presence can be
addressed. Subscriptions can be also automatically handled by server policies edited by the presentity or other
authorized users. The service/protocol to manage those policies is out of the scope of the present document.
NOTE: This definition is not related to the term "subscription" in TR 121 905 [1].
watcher and presentity: We use these names to denote the role of the client connected to the presence services.
As in Parlay/OSA PAM [4] the watcher and the presentity have to be associated to identities registered to the system,
i.e. users, groups of users or organizations
...
SLOVENSKI STANDARD
SIST ES 202 504-14 V1.1.1:2008
01-september-2008
2GSUWLGRVWRSGRVWRULWYH 26$ 6SOHWQHVWRULWYH3DUOD\;GHO 1DY]RþQRVW
3DUOD\;
Open Service Access (OSA) - Parlay X Web Services - Part 14: Presence (Parlay X 3)
Ta slovenski standard je istoveten z: ES 202 504-14 Version 1.1.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
SIST ES 202 504-14 V1.1.1:2008 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
---------------------- Page: 1 ----------------------
SIST ES 202 504-14 V1.1.1:2008
---------------------- Page: 2 ----------------------
SIST ES 202 504-14 V1.1.1:2008
ETSI ES 202 504-14 V1.1.1 (2008-05)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 14: Presence
(Parlay X 3)
�
---------------------- Page: 3 ----------------------
SIST ES 202 504-14 V1.1.1:2008
2 ETSI ES 202 504-14 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-14-OSA
Keywords
API, OSA, service
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, 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 to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
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
---------------------- Page: 4 ----------------------
SIST ES 202 504-14 V1.1.1:2008
3 ETSI ES 202 504-14 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.6
Foreword.6
1 Scope.8
2 References.8
2.1 Normative references.8
3 Definitions and abbreviations.9
3.1 Definitions.9
3.2 Abbreviations.10
4 Detailed service description .10
5 Namespaces.11
6 Sequence diagrams.12
6.1 Interface flow overview.12
7 XML Schema data type definition .13
7.1 PresenceAttributeType enumeration.13
7.2 ActivityValue enumeration.13
7.3 PlaceTypeValue enumeration.14
7.4 PrivacyType enumeration.15
7.5 SphereValue enumeration.15
7.6 CommunicationMeansType enumeration.15
7.7 CommunicationMeans structure.15
7.8 CommunicationValue structure.16
7.9 OtherValue structure.16
7.10 PresenceAttribute structure.16
7.10a AttributeTypeAndValue union.16
7.11 SubscriptionRequest structure.16
7.12 PresencePermission structure.17
7.13 CommunicationStatusType enumeration.17
7.14 PrivacyValue structure.17
7.15 MoodValue enumeration.17
7.16 PlaceIsValue structure.18
7.17 PlaceIsAudioValue enumeration.19
7.18 PlaceIsVideoValue enumeration.19
7.19 PlaceIsTextValue enumeration.19
7.20 RelationshipValue enumeration.19
7.21 TimeOffsetValue structure.20
7.22 StatusIconValue structure.20
7.23 Watcher structure.20
7.24 WatcherSubscriptionStatus enumeration.20
8 Web Service interface definition.20
8.1 Interface: PresenceConsumer.20
8.1.1 Operation: subscribePresence.21
8.1.1.1 Input message: subscribePresenceRequest.21
8.1.1.2 Output message: subscribePresenceResponse.21
8.1.1.3 Referenced faults.21
8.1.2 Operation: getUserPresence.22
8.1.2.1 Input message: getUserPresenceRequest .22
8.1.2.2 Output message: getUserPresenceResponse.22
8.1.2.3 Referenced faults.22
8.1.3 Operation: startPresenceNotification.22
8.1.3.1 Input message: startPresenceNotificationRequest.23
8.1.3.2 Output message: startPresenceNotificationResponse.23
ETSI
---------------------- Page: 5 ----------------------
SIST ES 202 504-14 V1.1.1:2008
4 ETSI ES 202 504-14 V1.1.1 (2008-05)
8.1.3.3 Referenced faults.23
8.1.4 Operation: endPresenceNotification.24
8.1.4.1 Input message: endPresenceNotificationRequest.24
8.1.4.2 Output message: endPresenceNotificationResponse.24
8.1.4.3 Referenced faults.24
8.2 Interface: PresenceNotification.24
8.2.1 Operation: statusChanged.24
8.2.1.1 Input message: statusChangedRequest.24
8.2.1.2 Output message: statusChangedResponse.25
8.2.1.3 Referenced faults.25
8.2.2 Operation: statusEnd.25
8.2.2.1 Input message: statusEndRequest .25
8.2.2.2 Output message: statusEndResponse.25
8.2.2.3 Referenced faults.25
8.2.3 Operation: notifySubscription.25
8.2.3.1 Input message: notifySubscriptionRequest .25
8.2.3.2 Output message: notifySubscriptionResponse .25
8.2.3.3 Referenced faults.25
8.2.4 Operation: subscriptionEnded.26
8.2.4.1 Input message: subscriptionEndedRequest .26
8.2.4.2 Output message: subscriptionEndedResponse.26
8.2.4.3 Referenced faults.26
8.3 Interface: PresenceSupplier.26
8.3.1 Operation: publish.26
8.3.1.1 Input message: publishRequest.26
8.3.1.2 Output message: publishResponse.26
8.3.1.3 Referenced faults.27
8.3.2 Operation: getOpenSubscriptions.27
8.3.2.1 Input message: getOpenSubscriptionsRequest.27
8.3.2.2 Output message: getOpenSubscriptionsResponse.27
8.3.2.3 Referenced faults.27
8.3.3 Operation: updateSubscriptionAuthorization.27
8.3.3.1 Input message: updateSubscriptionAuthorizationRequest .28
8.3.3.2 Output message: updateSubscriptionAuthorizationResponse .28
8.3.3.3 Referenced faults.28
8.3.4 Operation: getMyWatchers.28
8.3.4.1 Input message: getMyWatchersRequest .29
8.3.4.2 Output message: getMyWatchersResponse.29
8.3.4.3 Referenced faults.29
8.3.5 Operation: getSubscribedAttributes.29
8.3.5.1 Input message: getSubscribedAttributesRequest .29
8.3.5.2 Output message: getSubscribedAttributesResponse .29
8.3.5.3 Referenced faults.29
8.3.6 Operation: blockSubscription.30
8.3.6.1 Input message: blockSubscriptionRequest.30
8.3.6.2 Output message: blockSubscriptionResponse.30
8.3.6.3 Referenced faults.30
8.4 Interface: PresenceSupplierNotificationManager.30
8.4.1 Operation: startSubscriptionNotification .30
8.4.1.1 Input message: startSubscriptionNotificationRequest.31
8.4.1.2 Output message: startSubscriptionNotificationResponse.31
8.4.1.3 Referenced Faults.31
8.4.2 Operation: endNotification.31
8.4.2.1 Input message: endNotificationRequest.31
8.4.2.2 Output message: endNotificationResponse.32
8.4.2.3 Referenced Faults.32
8.5 Interface: PresenceSupplierNotification.32
8.5.1 Operation: notifyOpenSubscription.32
8.5.1.1 Input message: notifyOpenSubscriptionRequest.32
8.5.1.2 Output message: notifyOpenSubscriptionResponse.32
8.5.1.3 Referenced faults.32
8.5.2 Operation: notifyError.32
ETSI
---------------------- Page: 6 ----------------------
SIST ES 202 504-14 V1.1.1:2008
5 ETSI ES 202 504-14 V1.1.1 (2008-05)
8.5.2.1 Input message: notifyErrorRequest.32
8.5.2.2 Output message: notifyErrorResponse.33
8.5.2.3 Referenced faults.33
8.5.3 Operation: notifyEnd.33
8.5.3.1 Input message: notifyEndRequest.33
8.5.3.2 Output message: notifyEndResponse.33
8.5.3.3 Referenced faults.33
9 Fault definitions.33
9.1 ServiceException.33
9.1.1 SVC0220: No subscription request.33
9.1.2 SVC0221: Not a watcher .33
10 Service policies .34
Annex A (normative): WSDL for Presence .35
Annex B (informative): Bibliography.36
History .37
ETSI
---------------------- Page: 7 ----------------------
SIST ES 202 504-14 V1.1.1:2008
6 ETSI ES 202 504-14 V1.1.1 (2008-05)
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 Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN).
The present document is part 14 of a multi-part deliverable covering Open Service Access (OSA); Parlay X 3 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";
Part 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-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
---------------------- Page: 8 ----------------------
SIST ES 202 504-14 V1.1.1:2008
7 ETSI ES 202 504-14 V1.1.1 (2008-05)
The present document has been defined jointly between ETSI, The Parlay Group (http://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-14 V7.4.0 (Release 7).
ETSI
---------------------- Page: 9 ----------------------
SIST ES 202 504-14 V1.1.1:2008
8 ETSI ES 202 504-14 V1.1.1 (2008-05)
1 Scope
The present document is part 14 of the Stage 3 Parlay X 3 Web Services 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 Presence Web Service. The following 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 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 referenced 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 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 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 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] ETSI TR 121 905: "Digital cellular telecommunications system (Phase 2+); Universal Mobile
Telecommunications System (UMTS); Vocabulary for 3GPP Specifications (3GPP TR 21.905)".
ETSI
---------------------- Page: 10 ----------------------
SIST ES 202 504-14 V1.1.1:2008
9 ETSI ES 202 504-14 V1.1.1 (2008-05)
[2] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".
NOTE: Available at http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/.
[3] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
[4] ETSI ES 202 915-14: "Open Service Access (OSA); Application Programming Interface (API);
Part 14: Presence and Availability Management SCF (Parlay 4)".
[5] IETF RFC 3856: "A Presence Event Package for the Session Initiation Protocol (SIP)".
http://www.ietf.org/rfc/rfc3856.txt.
[6] Void.
[7] ETSI ES 202 504-13: "Open Service Access (OSA); Parlay X Web Services; Part 13: Address List
Management (Parlay X 3)".
[8] IETF RFC 3265: "Session Initiation Protocol (SIP)-Specific Event Notification".
[9] Void.
[10] ETSI ES 202 504-8: "Open Service Access (OSA); Parlay X Web Services; Part 8: Terminal
Status (Parlay X 3)".
[11] ETSI ES 202 504-9: "Open Service Access (OSA); Parlay X Web Services; Part 9: Terminal
Location (Parlay X 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 504-1 [3] and the following apply:
applications: For Instant Messaging, Push to Talk, or call control and other purposes may become clients of the
presence Web Service. We assume that these applications belong to a watcher and authenticate to the services in the
name of the watcher.
identity: represents a user in the real world
NOTE: See Parlay/OSA PAM identities [4], clause 4.4.1.
presence attributes: Contain information about a presentity. An attribute has a name and a value and can be supplied
by any device, application or network module that can be associated to the presentity's identity. A watcher can obtains
attributes only after he has successfully subscribed to them. Examples for attributes are activity, location type,
communication means, etc.
presence information: Consists of a set of attributes that characterize the presentity such as current activity,
environment, communication means and contact addresses. Only the system and the presentity have direct access to this
information, which may be collected and aggregated from several devices associated to t
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.