SIST ES 202 391-14 V1.3.1:2008
Open Service Access (OSA) - Parlay X Web Services - Part 14: Presence (Parlay X 2)
- Abstract
Update of ES 202 391 to become Parlay X 2.2, to cover maintenance updates.The present document is part 14 of the Stage 3 Parlay X 2 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.
- Status
- Published
- Publication Date
- 15-Jul-2008
- Technical Committee
- SPN - Services and Protocols for Networks
- Current Stage
- 6060 - National Implementation/Publication (Adopted Project)
- Start Date
- 19-Jun-2008
- Due Date
- 24-Aug-2008
- Completion Date
- 16-Jul-2008
Buy Documents
ETSI ES 202 391-14 V1.3.1 (2008-02) - Open Service Access (OSA); Parlay X Web Services; Part 14: Presence (Parlay X 2)
ETSI ES 202 391-14 V1.3.1 (2008-05) - Open Service Access (OSA); Parlay X Web Services; Part 14: Presence (Parlay X 2)
SIST ES 202 391-14 V1.3.1:2008 is the ETSI standard for Open Service Access (OSA) Parlay X Web Services, Part 14: Presence. It specifies the Presence Web Service so application developers and service implementers can access network presence functions through an open standardized interface.
What does SIST ES 202 391-14 V1.3.1:2008 specify?
SIST ES 202 391-14 V1.3.1:2008 specifies the Presence Web Service for the Parlay X 2 Web Services family in OSA. In practical terms, it defines how a watcher can subscribe to presence data, how a presentity can publish and control that data, and how the web service is described in WSDL and XML Schema.
The document is organized into clauses 1 to 10, followed by Annex A and Annex B. The main body covers scope, references, definitions, service description, namespaces, sequence diagrams, XML Schema data types, interface definitions, faults, and service policies.
| Annex | What it covers |
|---|---|
| Annex A | Normative WSDL for Presence, delivered as document/literal WSDL in accompanying text files |
| Annex B | Informative bibliography |
What are the key requirements of SIST ES 202 391-14 V1.3.1:2008?
SIST ES 202 391-14 V1.3.1:2008 defines a watcher/presentity model with both request-response and notification flows. The main practical point is that a watcher must be authorized before it can see presence data, and the service separates authorization from delivery of the data itself.
Service roles and message flow
- Clause 8 splits the API into three interfaces: PresenceConsumer, PresenceNotification, and PresenceSupplier. This separation matters because one side is used by the watcher and the other by the presentity, with callbacks for asynchronous events.
- Clause 6.1 explains that subscription notification is separate from delivery of presence information. A watcher can then choose polling with
getUserPresence()or event delivery withstartPresenceNotification(), which affects how clients are built and how often they must handle updates. - Clause 8.1.1,
subscribePresence, starts the authorization process for one presentity or a group. The service can contact the presentity for approval, and the watcher is informed later throughnotifySubscription().
Presence data model
- Clause 7 defines the presence attribute families: Activity, Place, Privacy, Sphere, Communication, and Other. This gives implementers a fixed vocabulary for encoding presence state instead of inventing local fields.
- Clause 7.10 defines
PresenceAttributewithlastChange,note,type, andvalue. In practice, this means presence data carries both the current value and the time it last changed, which is useful for client display and filtering. - Clause 7.7 to 7.9 define communication reachability as a set of
CommunicationMeansentries. This lets a presentity publish several contact options with priority and URI, so a client can decide which channel to use first.
Authorization, notifications, and service control
- Clause 8.1.3,
startPresenceNotification, lets a watcher request change notifications withfrequency,duration,count, andcheckImmediate. These controls matter because they limit update rate, duration, and volume, which affects network load and client behavior. - Clause 8.2.3,
notifySubscription, returns the presentity's decision for each requested attribute type. A watcher therefore needs to handle partial approval, not just all-or-nothing access. - Clause 8.3.3,
updateSubscriptionAuthorization, lets the presentity change authorization later, and clause 8.3.6,blockSubscription, lets the presentity stop a watcher completely. This means access control is not fixed at first subscription. - Clause 10 defines service policies such as
MaximumNotificationFrequency,MaximumNotificationDuration,DefaultNotificationDuration,MaximumCount,UnlimitedCountAllowed,GroupSupport, andNestedGroupSupport. These policy values set the runtime limits that an implementation must enforce. - Clause 9 defines service faults such as
SVC0220andSVC0221. Clear fault handling matters because clients need to distinguish invalid subscriptions from invalid watcher identities.
What terms does SIST ES 202 391-14 V1.3.1:2008 define?
SIST ES 202 391-14 V1.3.1:2008 defines the main presence vocabulary used by the service. These terms tell implementers who sends data, who receives it, and what kind of information is being exchanged.
- watcher - The client role that requests or receives presence information on behalf of an identity.
- presentity - The user, group, or organization whose presence information is published or requested.
- presence attributes - Named items of presence data, such as activity, place, or communication means, each with a value.
- presence information - The set of attributes that describe the presentity at a given time.
- subscription - The authorization relationship that must exist before a watcher can access presence data.
- PresenceConsumer - The watcher-side interface used to request presence data and start or end notifications.
- PresenceSupplier - The presentity-side interface used to publish data and manage watcher access.
Who uses SIST ES 202 391-14 V1.3.1:2008?
SIST ES 202 391-14 V1.3.1:2008 is used by telecom and application teams building presence-enabled services. Typical examples named in the standard are instant messaging, push to talk, and call control applications.
It is also relevant to teams integrating OSA/Parlay X with SIP, SIMPLE, XMPP, or IMS-based environments, because the standard is designed to map to those architectures. Network platform engineers, API designers, and test teams use it to implement the web service, validate WSDL compatibility, and verify subscription and notification behavior.
What changed in SIST ES 202 391-14 V1.3.1:2008 from the previous edition?
SIST ES 202 391-14 V1.3.1:2008 updates ES 202 391 to become Parlay X 2.2 and includes maintenance updates. The foreword also states that this part belongs to the Parlay X 2.2 set of specifications and is equivalent to 3GPP TS 29.199-14 V6.7.0 (Release 6).
Which standards are used with SIST ES 202 391-14 V1.3.1:2008?
| Standard | What it contributes |
|---|---|
| ETSI ES 202 391-1 | Common Parlay X framework, shared service constructs, and WSDL conventions |
| W3C Recommendation, XML Schema Part 2: Datatypes | XML Schema datatypes used by the presence schema |
| ETSI ES 202 915-14 | Related Parlay/OSA PAM presence and availability API, including shared concepts |
| IETF RFC 3856 | SIP presence event package background |
| IETF RFC 3265 | SIP-specific event notification background |
| ETSI ES 202 391-13 | Address list and group management used with group presence cases |
| ETSI ES 202 391-8 | Related terminal status presence information |
| ETSI ES 202 391-9 | Related terminal location presence information |
| ETSI TR 121 905 | Shared 3GPP vocabulary used in the document’s definitions |
What does the SIST ES 202 391-14 V1.3.1:2008 document contain?
SIST ES 202 391-14 V1.3.1:2008 contains a service description, sequence diagrams, XML Schema data types, interface definitions, fault definitions, and service policies. The sequence diagram shows how watcher-side and presentity-side clients interact, including polling and notification paths.
It also contains the detailed operation set for subscribePresence, getUserPresence, startPresenceNotification, endPresenceNotification, publish, getOpenSubscriptions, updateSubscriptionAuthorization, getMyWatchers, getSubscribedAttributes, and blockSubscription. For implementers, this is the part that drives message handling, authorization logic, and callback behavior.
Annex A provides the normative WSDL representation in accompanying files, which is the basis for service integration and tool support. Annex B gives the bibliography used to position the standard against SIP, XMPP, and related presence work.
Buy Documents
ETSI ES 202 391-14 V1.3.1 (2008-02) - Open Service Access (OSA); Parlay X Web Services; Part 14: Presence (Parlay X 2)
ETSI ES 202 391-14 V1.3.1 (2008-05) - Open Service Access (OSA); Parlay X Web Services; Part 14: Presence (Parlay X 2)
Get Certified
Connect with accredited certification bodies for this standard

BSI Group
BSI (British Standards Institution) is the business standards company that helps organizations make excellence a habit.

NYCE
Mexican standards and certification body.
Sponsored listings
Frequently Asked Questions
SIST ES 202 391-14 V1.3.1:2008 is a standard published by the Slovenian Institute for Standardization (SIST). Its full title is "Open Service Access (OSA) - Parlay X Web Services - Part 14: Presence (Parlay X 2)". This standard covers: Update of ES 202 391 to become Parlay X 2.2, to cover maintenance updates.The present document is part 14 of the Stage 3 Parlay X 2 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.
Update of ES 202 391 to become Parlay X 2.2, to cover maintenance updates.The present document is part 14 of the Stage 3 Parlay X 2 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.
SIST ES 202 391-14 V1.3.1:2008 is classified under the following ICS (International Classification for Standards) categories: 35.100.01 - Open systems interconnection in general. The ICS classification helps identify the subject area and facilitates finding related standards.
SIST ES 202 391-14 V1.3.1:2008 is available in PDF format for immediate download after purchase. The document can be added to your cart and obtained through the secure checkout process. Digital delivery ensures instant access to the complete standard document.
Standards Content (Sample)
Final draft ETSI ES 202 391-14 V1.3.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 14: Presence
(Parlay X 2)
�
2 Final draft ETSI ES 202 391-14 V1.3.1 (2008-02)
Reference
RES/TISPAN-01056-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
3 Final draft ETSI ES 202 391-14 V1.3.1 (2008-02)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
2.1 Normative references.6
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.8
4 Detailed service description .8
4.1 Relationship to Similar or Supplanted Specifications .9
5 Namespaces.9
6 Sequence diagrams.9
6.1 Interface flow overview.9
7 XML Schema data type definition .11
7.1 PresenceAttributeType enumeration.11
7.2 ActivityValue enumeration.11
7.3 PlaceValue enumeration.12
7.4 PrivacyValue enumeration.12
7.5 SphereValue enumeration.12
7.6 CommunicationMeansType enumeration.13
7.7 CommunicationMeans structure.13
7.8 CommunicationValue structure.13
7.9 OtherValue structure.13
7.10 PresenceAttribute structure.13
7.11 SubscriptionRequest structure.14
7.12 PresencePermission structure.14
8 Web Service interface definition.14
8.1 Interface: PresenceConsumer.14
8.1.1 Operation: subscribePresence.14
8.1.1.1 Input message: subscribePresenceRequest.15
8.1.1.2 Output message: subscribePresenceResponse.15
8.1.1.3 Referenced faults.15
8.1.2 Operation: getUserPresence.15
8.1.2.1 Input message: getUserPresenceRequest .15
8.1.2.2 Output message: getUserPresenceResponse.15
8.1.2.3 Referenced faults.16
8.1.3 Operation: startPresenceNotification.16
8.1.3.1 Input message: startPresenceNotificationRequest.16
8.1.3.2 Output message: startPresenceNotificationResponse.16
8.1.3.3 Referenced faults.17
8.1.4 Operation: endPresenceNotification.17
8.1.4.1 Input message: endPresenceNotificationRequest.17
8.1.4.2 Output message: endPresenceNotificationResponse.17
8.1.4.3 Referenced faults.17
8.2 Interface: PresenceNotification.17
8.2.1 Operation: statusChanged.18
8.2.1.1 Input message: statusChangedRequest.18
8.2.1.2 Output message: statusChangedResponse.18
8.2.1.3 Referenced faults.18
8.2.2 Operation: statusEnd.18
8.2.2.1 Input message: statusEndRequest .18
ETSI
4 Final draft ETSI ES 202 391-14 V1.3.1 (2008-02)
8.2.2.2 Output message: statusEndResponse.18
8.2.2.3 Referenced faults.18
8.2.3 Operation: notifySubscription.18
8.2.3.1 Input message: notifySubscriptionRequest .19
8.2.3.2 Output message: notifySubscriptionResponse .19
8.2.3.3 Referenced faults.19
8.2.4 Operation: subscriptionEnded.19
8.2.4.1 Input message: subscriptionEndedRequest .19
8.2.4.2 Output message: subscriptionEndedResponse.19
8.2.4.3 Referenced faults.19
8.3 Interface: PresenceSupplier.19
8.3.1 Operation: publish.19
8.3.1.1 Input message: publishRequest.20
8.3.1.2 Output message: publishResponse.20
8.3.1.3 Referenced faults.20
8.3.2 Operation: getOpenSubscriptions.20
8.3.2.1 Input message: getOpenSubscriptionsRequest.20
8.3.2.2 Output message: getOpenSubscriptionsResponse.20
8.3.2.3 Referenced faults.20
8.3.3 Operation: updateSubscriptionAuthorization.20
8.3.3.1 Input message: updateSubscriptionAuthorizationRequest .21
8.3.3.2 Output message: updateSubscriptionAuthorizationResponse .21
8.3.3.3 Referenced faults.21
8.3.4 Operation: getMyWatchers.21
8.3.4.1 Input message: getMyWatchersRequest .21
8.3.4.2 Output message: getMyWatchersResponse.21
8.3.4.3 Referenced faults.21
8.3.5 Operation: getSubscribedAttributes.22
8.3.5.1 Input message: getSubscribedAttributesRequest .22
8.3.5.2 Output message: getSubscribedAttributesResponse .22
8.3.5.3 Referenced faults.22
8.3.6 Operation: blockSubscription.22
8.3.6.1 Input message: blockSubscriptionRequest.22
8.3.6.2 Output message: blockSubscriptionResponse.22
8.3.6.3 Referenced faults.22
9 Fault definitions.23
9.1 ServiceException.23
9.1.1 SVC0220: No subscription request.23
9.1.2 SVC0221: Not a watcher .23
10 Service policies .23
Annex A (normative): WSDL for Presence .24
Annex B (informative): Bibliography.25
History .26
ETSI
5 Final draft ETSI ES 202 391-14 V1.3.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 2 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".
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 2.2 set of specifications.
The present document is equivalent to 3GPP TS 29.199-14 V6.7.0 (Release 6).
ETSI
6 Final draft ETSI ES 202 391-14 V1.3.1 (2008-02)
1 Scope
The present document is part 14 of the Stage 3 Parlay X 2 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
version 7.2.0 Release 7)".
ETSI
7 Final draft ETSI ES 202 391-14 V1.3.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 391-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 2)".
[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 391-13: "Open Service Access (OSA); Parlay X Web Services; Part 13: Address List
Management (Parlay X 2)".
[8] IETF RFC 3265: "Session Initiation Protocol (SIP)-Specific Event Notification".
[9] Void.
[10] ETSI ES 202 391-8: "Open Service Access (OSA); Parlay X Web Services; Part 8: Terminal
Status (Parlay X 2)".
[11] ETSI ES 202 391-9: "Open Service Access (OSA); Parlay X Web Services; Part 9: Terminal
Location (Parlay X 2)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 391-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 clause 4.4.1 in ES 202 915-14 [4].
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: 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: names used 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
8 Final draft ETSI ES 202 391-14 V1.3.1 (2008-02)
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 391-1 [3] and the following apply:
IETF Internet Engineering Task Force
IMS IP Multimedia Subsystem
ISC IP multimedia subsystem Service Control interface
MMS Multimedia Message Service
PAM Presence and Availability Management
SCF Service Capability Feature
SIMPLE SIP for Instant Messaging and Presence Leveraging Extensions
SIP Session Initiation Protocol
SMS Short Message Service
XCAP XML Configuration Access Protocol
XML eXtensible Markup Language
XMPP eXtensible Messaging and Presence Protocol
XSD XML Schema Definition
4 Detailed service description
The presence service allows for presence information to be obtained about one or more users and to register presence
for the same. It is assumed that the typical client of these interfaces is either a supplier or a consumer of the presence
information. An Instant Messaging application is a canonical example of such a client of this interface.
Figure 1 shows the architecture of the Presence Web Service and the underlying services. The Parlay/OSA PAM SCF is
the straightforward option and implements the presence server with extended identity, device capability, and presence
agent management. Parlay/OSA PAM allows aggregation of presence information from internet, mobile and enterprise
users, etc. using a presence transport network of SIP or XMPP servers. The Presence Web Service can however
communicate directly for example with IMS presence network elements (presence and resource list servers) using the
ISC (SIP/SIMPLE) protocol interface.
watcher
client
presentity
watcher
client
application
Parlay X API
Parlay X Address List
Management Web Parlay X Presence Web Service
Service
Parlay/OSA API
Policy Parlay/OSA PAM
Network protocols
rules
SCF
(e.g. SIP)
Network elements
(e.g. SIP)
Figure 1: Presence web service environment
ETSI
9 Final draft ETSI ES 202 391-14 V1.3.1 (2008-02)
4.1 Relationship to Similar or Supplanted Specifications
The most important relations are to:
• Parlay X 2 Terminal Status Web Service [10] and Parlay X 2 Terminal Location Web Service [11]: Both
services deal with information that could be considered part of the user's presence information.
Communication abilities can be derived from terminal status information, and the user's placetype can be
derived from his location.
• Parlay/OSA PAM [4]: The Parlay/OSA Presence and Availability specification can be considered the big
brother of the present document. While Parlay X 2 Presence stays behind Parlay/OSA PAM in terms of
flexibility and power - especially concerning attributes and management interfaces - it also extends PAM by
introducing end-to-end authorization. The present document aims to be mappable to Parlay/OSA PAM.
• SIP SIMPLE [5]: The present document aims to be mappable to the SIP/SIMPLE architecture.
• XMPP (Jabber) (see Bibliography): Many principles of XMPP have been adopted, especially the end-to-end
authorization.
• IETF Rich Presence(see Bibliography). The set of attributes the present document specifies is closely aligned
with the IETF's Rich Presence ideas.
• Group Management [7]: Presence of groups is supported by the present document, however their creation and
manipulation has to be done using the Parlay X 2 Address List Management Web Service. In the 3GPP
presence context, contact lists and group manipulation is done with the XCAP protocol(see Bibliography).
5 Namespaces
The PresenceConsumer interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/presence/consumer/v2_5
The PresenceNotification interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/presence/notification/v2_4
The PresenceSupplier interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/presence/supplier/v2_5
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/presence/v2_4
The "xsd" namespace is used in the present document to refer to the XML Schema data types defined in
XML Schema [2]. The use of the name "xsd" is not semantically significant.
6 Sequence diagrams
6.1 Interface flow overview
The sequence diagram shows the interactions in case both watcher application and presentity are Web Service clients.
Compared to the SIP interactions, the subscription notification is separated from the delivery of presence information
itself. Based on the subscription result, the watcher can select the polling or notification mode for presence events.
Changes in the authorization of presence attributes are propagated to the watchers via the notifySubscription()
operation, the blocking of a subscription by the presentity is propagated via a subscriptionEnded operation.
ETSI
10 Final draft ETSI ES 202 391-14 V1.3.1 (2008-02)
The sequence diagram does not show the internal communication within the presence server. It is assumed that the
Presence Consumer and Supplier interfaces are implemented by the same instance. If an implementer of the API find
other solutions preferable, he has to take care of the internal communication himself.
Watcher Application : Presence Web Service : Presence Web Service :
Presentity Application
PresenceConsumerNotifications PresenceConsumer PresenceSupplier
:
subscribePresence
check subscription policies
after a while the
user logs on
...
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 14: Presence
(Parlay X 2)
�
2 ETSI ES 202 391-14 V1.3.1 (2008-05)
Reference
RES/TISPAN-01056-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
3 ETSI ES 202 391-14 V1.3.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
2.1 Normative references.6
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.8
4 Detailed service description .8
4.1 Relationship to Similar or Supplanted Specifications .9
5 Namespaces.9
6 Sequence diagrams.9
6.1 Interface flow overview.9
7 XML Schema data type definition .11
7.1 PresenceAttributeType enumeration.11
7.2 ActivityValue enumeration.11
7.3 PlaceValue enumeration.12
7.4 PrivacyValue enumeration.12
7.5 SphereValue enumeration.12
7.6 CommunicationMeansType enumeration.13
7.7 CommunicationMeans structure.13
7.8 CommunicationValue structure.13
7.9 OtherValue structure.13
7.10 PresenceAttribute structure.13
7.11 SubscriptionRequest structure.14
7.12 PresencePermission structure.14
8 Web Service interface definition.14
8.1 Interface: PresenceConsumer.14
8.1.1 Operation: subscribePresence.14
8.1.1.1 Input message: subscribePresenceRequest.15
8.1.1.2 Output message: subscribePresenceResponse.15
8.1.1.3 Referenced faults.15
8.1.2 Operation: getUserPresence.15
8.1.2.1 Input message: getUserPresenceRequest .15
8.1.2.2 Output message: getUserPresenceResponse.15
8.1.2.3 Referenced faults.16
8.1.3 Operation: startPresenceNotification.16
8.1.3.1 Input message: startPresenceNotificationRequest.16
8.1.3.2 Output message: startPresenceNotificationResponse.16
8.1.3.3 Referenced faults.17
8.1.4 Operation: endPresenceNotification.17
8.1.4.1 Input message: endPresenceNotificationRequest.17
8.1.4.2 Output message: endPresenceNotificationResponse.17
8.1.4.3 Referenced faults.17
8.2 Interface: PresenceNotification.17
8.2.1 Operation: statusChanged.18
8.2.1.1 Input message: statusChangedRequest.18
8.2.1.2 Output message: statusChangedResponse.18
8.2.1.3 Referenced faults.18
8.2.2 Operation: statusEnd.18
8.2.2.1 Input message: statusEndRequest .18
ETSI
4 ETSI ES 202 391-14 V1.3.1 (2008-05)
8.2.2.2 Output message: statusEndResponse.18
8.2.2.3 Referenced faults.18
8.2.3 Operation: notifySubscription.18
8.2.3.1 Input message: notifySubscriptionRequest .19
8.2.3.2 Output message: notifySubscriptionResponse .19
8.2.3.3 Referenced faults.19
8.2.4 Operation: subscriptionEnded.19
8.2.4.1 Input message: subscriptionEndedRequest .19
8.2.4.2 Output message: subscriptionEndedResponse.19
8.2.4.3 Referenced faults.19
8.3 Interface: PresenceSupplier.19
8.3.1 Operation: publish.19
8.3.1.1 Input message: publishRequest.20
8.3.1.2 Output message: publishResponse.20
8.3.1.3 Referenced faults.20
8.3.2 Operation: getOpenSubscriptions.20
8.3.2.1 Input message: getOpenSubscriptionsRequest.20
8.3.2.2 Output message: getOpenSubscriptionsResponse.20
8.3.2.3 Referenced faults.20
8.3.3 Operation: updateSubscriptionAuthorization.20
8.3.3.1 Input message: updateSubscriptionAuthorizationRequest .21
8.3.3.2 Output message: updateSubscriptionAuthorizationResponse .21
8.3.3.3 Referenced faults.21
8.3.4 Operation: getMyWatchers.21
8.3.4.1 Input message: getMyWatchersRequest .21
8.3.4.2 Output message: getMyWatchersResponse.21
8.3.4.3 Referenced faults.21
8.3.5 Operation: getSubscribedAttributes.22
8.3.5.1 Input message: getSubscribedAttributesRequest .22
8.3.5.2 Output message: getSubscribedAttributesResponse .22
8.3.5.3 Referenced faults.22
8.3.6 Operation: blockSubscription.22
8.3.6.1 Input message: blockSubscriptionRequest.22
8.3.6.2 Output message: blockSubscriptionResponse.22
8.3.6.3 Referenced faults.22
9 Fault definitions.23
9.1 ServiceException.23
9.1.1 SVC0220: No subscription request.23
9.1.2 SVC0221: Not a watcher .23
10 Service policies .23
Annex A (normative): WSDL for Presence .24
Annex B (informative): Bibliography.25
History .26
ETSI
5 ETSI ES 202 391-14 V1.3.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 2 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".
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 2.2 set of specifications.
The present document is equivalent to 3GPP TS 29.199-14 V6.7.0 (Release 6).
ETSI
6 ETSI ES 202 391-14 V1.3.1 (2008-05)
1 Scope
The present document is part 14 of the Stage 3 Parlay X 2 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
version 7.2.0 Release 7)".
ETSI
7 ETSI ES 202 391-14 V1.3.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 391-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 2)".
[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 391-13: "Open Service Access (OSA); Parlay X Web Services; Part 13: Address List
Management (Parlay X 2)".
[8] IETF RFC 3265: "Session Initiation Protocol (SIP)-Specific Event Notification".
[9] Void.
[10] ETSI ES 202 391-8: "Open Service Access (OSA); Parlay X Web Services; Part 8: Terminal
Status (Parlay X 2)".
[11] ETSI ES 202 391-9: "Open Service Access (OSA); Parlay X Web Services; Part 9: Terminal
Location (Parlay X 2)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 391-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 clause 4.4.1 in ES 202 915-14 [4].
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: 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: names used 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
8 ETSI ES 202 391-14 V1.3.1 (2008-05)
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 391-1 [3] and the following apply:
IETF Internet Engineering Task Force
IMS IP Multimedia Subsystem
ISC IP multimedia subsystem Service Control interface
MMS Multimedia Message Service
PAM Presence and Availability Management
SCF Service Capability Feature
SIMPLE SIP for Instant Messaging and Presence Leveraging Extensions
SIP Session Initiation Protocol
SMS Short Message Service
XCAP XML Configuration Access Protocol
XML eXtensible Markup Language
XMPP eXtensible Messaging and Presence Protocol
XSD XML Schema Definition
4 Detailed service description
The presence service allows for presence information to be obtained about one or more users and to register presence
for the same. It is assumed that the typical client of these interfaces is either a supplier or a consumer of the presence
information. An Instant Messaging application is a canonical example of such a client of this interface.
Figure 1 shows the architecture of the Presence Web Service and the underlying services. The Parlay/OSA PAM SCF is
the straightforward option and implements the presence server with extended identity, device capability, and presence
agent management. Parlay/OSA PAM allows aggregation of presence information from internet, mobile and enterprise
users, etc. using a presence transport network of SIP or XMPP servers. The Presence Web Service can however
communicate directly for example with IMS presence network elements (presence and resource list servers) using the
ISC (SIP/SIMPLE) protocol interface.
watcher
client
presentity
watcher
client
application
Parlay X API
Parlay X Address List
Management Web Parlay X Presence Web Service
Service
Parlay/OSA API
Policy Parlay/OSA PAM
Network protocols
rules
SCF
(e.g. SIP)
Network elements
(e.g. SIP)
Figure 1: Presence web service environment
ETSI
9 ETSI ES 202 391-14 V1.3.1 (2008-05)
4.1 Relationship to Similar or Supplanted Specifications
The most important relations are to:
• Parlay X 2 Terminal Status Web Service [10] and Parlay X 2 Terminal Location Web Service [11]: Both
services deal with information that could be considered part of the user's presence information.
Communication abilities can be derived from terminal status information, and the user's placetype can be
derived from his location.
• Parlay/OSA PAM [4]: The Parlay/OSA Presence and Availability specification can be considered the big
brother of the present document. While Parlay X 2 Presence stays behind Parlay/OSA PAM in terms of
flexibility and power - especially concerning attributes and management interfaces - it also extends PAM by
introducing end-to-end authorization. The present document aims to be mappable to Parlay/OSA PAM.
• SIP SIMPLE [5]: The present document aims to be mappable to the SIP/SIMPLE architecture.
• XMPP (Jabber) (see Bibliography): Many principles of XMPP have been adopted, especially the end-to-end
authorization.
• IETF Rich Presence(see Bibliography). The set of attributes the present document specifies is closely aligned
with the IETF's Rich Presence ideas.
• Group Management [7]: Presence of groups is supported by the present document, however their creation and
manipulation has to be done using the Parlay X 2 Address List Management Web Service. In the 3GPP
presence context, contact lists and group manipulation is done with the XCAP protocol(see Bibliography).
5 Namespaces
The PresenceConsumer interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/presence/consumer/v2_5
The PresenceNotification interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/presence/notification/v2_4
The PresenceSupplier interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/presence/supplier/v2_5
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/presence/v2_4
The "xsd" namespace is used in the present document to refer to the XML Schema data types defined in
XML Schema [2]. The use of the name "xsd" is not semantically significant.
6 Sequence diagrams
6.1 Interface flow overview
The sequence diagram shows the interactions in case both watcher application and presentity are Web Service clients.
Compared to the SIP interactions, the subscription notification is separated from the delivery of presence information
itself. Based on the subscription result, the watcher can select the polling or notification mode for presence events.
Changes in the authorization of presence attributes are propagated to the watchers via the notifySubscription()
operation, the blocking of a subscription by the presentity is propagated via a subscriptionEnded operation.
ETSI
10 ETSI ES 202 391-14 V1.3.1 (2008-05)
The sequence diagram does not show the internal communication within the presence server. It is assumed that the
Presence Consumer and Supplier interfaces are implemented by the same instance. If an implementer of the API find
other solutions preferable, he has to take care of the internal communication himself.
Watcher Application : Presence Web Service : Presence Web Service :
Presentity Application
PresenceConsumerNotifications PresenceConsumer PresenceSupplier
:
subscribePresence
check subscription policies
after a while the
user logs on
notifySubscript
...
SLOVENSKI STANDARD
01-september-2008
2GSUWLGRVWRSGRVWRULWYH26$6SOHWQHVWRULWYH3DUOD\;GHO1DY]RþQRVW
3DUOD\;
Open Service Access (OSA) - Parlay X Web Services - Part 14: Presence (Parlay X 2)
Ta slovenski standard je istoveten z: ES 202 391-14 Version 1.3.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 14: Presence
(Parlay X 2)
�
2 ETSI ES 202 391-14 V1.3.1 (2008-05)
Reference
RES/TISPAN-01056-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
3 ETSI ES 202 391-14 V1.3.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
2.1 Normative references.6
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.8
4 Detailed service description .8
4.1 Relationship to Similar or Supplanted Specifications .9
5 Namespaces.9
6 Sequence diagrams.9
6.1 Interface flow overview.9
7 XML Schema data type definition .11
7.1 PresenceAttributeType enumeration.11
7.2 ActivityValue enumeration.11
7.3 PlaceValue enumeration.12
7.4 PrivacyValue enumeration.12
7.5 SphereValue enumeration.12
7.6 CommunicationMeansType enumeration.13
7.7 CommunicationMeans structure.13
7.8 CommunicationValue structure.13
7.9 OtherValue structure.13
7.10 PresenceAttribute structure.13
7.11 SubscriptionRequest structure.14
7.12 PresencePermission structure.14
8 Web Service interface definition.14
8.1 Interface: PresenceConsumer.14
8.1.1 Operation: subscribePresence.14
8.1.1.1 Input message: subscribePresenceRequest.15
8.1.1.2 Output message: subscribePresenceResponse.15
8.1.1.3 Referenced faults.15
8.1.2 Operation: getUserPresence.15
8.1.2.1 Input message: getUserPresenceRequest .15
8.1.2.2 Output message: getUserPresenceResponse.15
8.1.2.3 Referenced faults.16
8.1.3 Operation: startPresenceNotification.16
8.1.3.1 Input message: startPresenceNotificationRequest.16
8.1.3.2 Output message: startPresenceNotificationResponse.16
8.1.3.3 Referenced faults.17
8.1.4 Operation: endPresenceNotification.17
8.1.4.1 Input message: endPresenceNotificationRequest.17
8.1.4.2 Output message: endPresenceNotificationResponse.17
8.1.4.3 Referenced faults.17
8.2 Interface: PresenceNotification.17
8.2.1 Operation: statusChanged.18
8.2.1.1 Input message: statusChangedRequest.18
8.2.1.2 Output message: statusChangedResponse.18
8.2.1.3 Referenced faults.18
8.2.2 Operation: statusEnd.18
8.2.2.1 Input message: statusEndRequest .18
ETSI
4 ETSI ES 202 391-14 V1.3.1 (2008-05)
8.2.2.2 Output message: statusEndResponse.18
8.2.2.3 Referenced faults.18
8.2.3 Operation: notifySubscription.18
8.2.3.1 Input message: notifySubscriptionRequest .19
8.2.3.2 Output message: notifySubscriptionResponse .19
8.2.3.3 Referenced faults.19
8.2.4 Operation: subscriptionEnded.19
8.2.4.1 Input message: subscriptionEndedRequest .19
8.2.4.2 Output message: subscriptionEndedResponse.19
8.2.4.3 Referenced faults.19
8.3 Interface: PresenceSupplier.19
8.3.1 Operation: publish.19
8.3.1.1 Input message: publishRequest.20
8.3.1.2 Output message: publishResponse.20
8.3.1.3 Referenced faults.20
8.3.2 Operation: getOpenSubscriptions.20
8.3.2.1 Input message: getOpenSubscriptionsRequest.20
8.3.2.2 Output message: getOpenSubscriptionsResponse.20
8.3.2.3 Referenced faults.20
8.3.3 Operation: updateSubscriptionAuthorization.20
8.3.3.1 Input message: updateSubscriptionAuthorizationRequest .21
8.3.3.2 Output message: updateSubscriptionAuthorizationResponse .21
8.3.3.3 Referenced faults.21
8.3.4 Operation: getMyWatchers.21
8.3.4.1 Input message: getMyWatchersRequest .21
8.3.4.2 Output message: getMyWatchersResponse.21
8.3.4.3 Referenced faults.21
8.3.5 Operation: getSubscribedAttributes.22
8.3.5.1 Input message: getSubscribedAttributesRequest .22
8.3.5.2 Output message: getSubscribedAttributesResponse .22
8.3.5.3 Referenced faults.22
8.3.6 Operation: blockSubscription.22
8.3.6.1 Input message: blockSubscriptionRequest.22
8.3.6.2 Output message: blockSubscriptionResponse.22
8.3.6.3 Referenced faults.22
9 Fault definitions.23
9.1 ServiceException.23
9.1.1 SVC0220: No subscription request.23
9.1.2 SVC0221: Not a watcher .23
10 Service policies .23
Annex A (normative): WSDL for Presence .24
Annex B (informative): Bibliography.25
History .26
ETSI
5 ETSI ES 202 391-14 V1.3.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 2 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".
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 2.2 set of specifications.
The present document is equivalent to 3GPP TS 29.199-14 V6.7.0 (Release 6).
ETSI
6 ETSI ES 202 391-14 V1.3.1 (2008-05)
1 Scope
The present document is part 14 of the Stage 3 Parlay X 2 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
version 7.2.0 Release 7)".
ETSI
7 ETSI ES 202 391-14 V1.3.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 391-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 2)".
[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 391-13: "Open Service Access (OSA); Parlay X Web Services; Part 13: Address List
Management (Parlay X 2)".
[8] IETF RFC 3265: "Session Initiation Protocol (SIP)-Specific Event Notification".
[9] Void.
[10] ETSI ES 202 391-8: "Open Service Access (OSA); Parlay X Web Services; Part 8: Terminal
Status (Parlay X 2)".
[11] ETSI ES 202 391-9: "Open Service Access (OSA); Parlay X Web Services; Part 9: Terminal
Location (Parlay X 2)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 391-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 clause 4.4.1 in ES 202 915-14 [4].
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: 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: names used 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
8 ETSI ES 202 391-14 V1.3.1 (2008-05)
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 391-1 [3] and the following apply:
IETF Internet Engineering Task Force
IMS IP Multimedia Subsystem
ISC IP multimedia subsystem Service Control interface
MMS Multimedia Message Service
PAM Presence and Availability Management
SCF Service Capability Feature
SIMPLE SIP for Instant Messaging and Presence Leveraging Extensions
SIP Session Initiation Protocol
SMS Short Message Service
XCAP XML Configuration Access Protocol
XML eXtensible Markup Language
XMPP eXtensible Messaging and Presence Protocol
XSD XML Schema Definition
4 Detailed service description
The presence service allows for presence information to be obtained about one or more users and to register presence
for the same. It is assumed that the typical client of these interfaces is either a supplier or a consumer of the presence
information. An Instant Messaging application is a canonical example of such a client of this interface.
Figure 1 shows the architecture of the Presence Web Service and the underlying services. The Parlay/OSA PAM SCF is
the straightforward option and implements the presence server with extended identity, device capability, and presence
agent management. Parlay/OSA PAM allows aggregation of presence information from internet, mobile and enterprise
users, etc. using a presence transport network of SIP or XMPP servers. The Presence Web Service can however
communicate directly for example with IMS presence network elements (presence and resource list servers) using the
ISC (SIP/SIMPLE) protocol interface.
watcher
client
presentity
watcher
client
application
Parlay X API
Parlay X Address List
Management Web Parlay X Presence Web Service
Service
Parlay/OSA API
Policy Parlay/OSA PAM
Network protocols
rules
SCF
(e.g. SIP)
Network elements
(e.g. SIP)
Figure 1: Presence web service environment
ETSI
9 ETSI ES 202 391-14 V1.3.1 (2008-05)
4.1 Relationship to Similar or Supplanted Specifications
The most important relations are to:
• Parlay X 2 Terminal Status Web Service [10] and Parlay X 2 Terminal Location Web Service [11]: Both
services deal with information that could be considered part of the user's presence information.
Communication abilities can be derived from terminal status information, and the user's placetype can be
derived from his location.
• Parlay/OSA PAM [4]: The Parlay/OSA Presence and Availability specification can be considered the big
brother of the present document. While Parlay X 2 Presence stays behind Parlay/OSA PAM in terms of
flexibility and power - especially concerning attributes and management interfaces - it also extends PAM by
introducing end-to-end authorization. The present document aims to be mappable to Parlay/OSA PAM.
• SIP SIMPLE [5]: The present document aims to be mappable to the SIP/SIMPLE architecture.
• XMPP (Jabber) (see Bibliography): Many principles of XMPP have been adopted, especially the end-to-end
authorization.
• IETF Rich Presence(see Bibliography). The set of attributes the present document specifies is closely aligned
with the IETF's Rich Presence ideas.
• Group Management [7]: Presence of groups is supported by the present document, however their creation and
manipulation has to be done using the Parlay X 2 Address List Management Web Service. In the 3GPP
presence context, contact lists and group manipulation is done with the XCAP protocol(see Bibliography).
5 Namespaces
The PresenceConsumer interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/presence/consumer/v2_5
The PresenceNotification interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/presence/notification/v2_4
The PresenceSupplier interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/presence/supplier/v2_5
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/presence/v2_4
The "xsd" namespace is used in the present document to refer to the XML Schema data types defined in
XML Schema [2]. The use of the name "xsd" is not semantically significant.
6 Sequence diagrams
6.1 Interface flow overview
The sequence diagram shows the interactions in case both watcher application and presentity are Web Service clients.
Compared to the SIP interactions, the subscription notification is separated from the delivery of presence information
itself. Based on the subscription result, the watcher can select the polling or notification mode for presence events.
Changes in the authorization of presence attributes are propagated to the watchers via the notifySubscription()
operation, the blocking of a subscription by the presentity is propagated via a subscriptionEnded operation.
ETSI
10 ETSI ES 202 391-14 V1.3.1 (2008-05)
The sequence diagram does not show the internal communication within the presence server. It is assumed that the
Presence Consumer and Supplier interfaces are implemented by the same instance. If an implementer of the API find
other solutions preferable, he has to take care of the internal communication himself.
...











