ETSI ES 202 504-1 V1.1.1 (2008-05)
Open Service Access (OSA); Parlay X Web Services; Part 1: Common (Parlay X 3)
Open Service Access (OSA); Parlay X Web Services; Part 1: Common (Parlay X 3)
DES/TISPAN-01034-1-OSA
Odprti dostop do storitve (OSA) - Spletne storitve Parlay X - 1. del: Splošno (Parlay X 3)
General Information
Standards Content (Sample)
Final draft ETSI ES 202 504-1 V1.1.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 1: Common
(Parlay X 3)
�
2 Final draft ETSI ES 202 504-1 V1.1.1 (2008-02)
Reference
DES/TISPAN-01034-1-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 504-1 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.9
4 Use of Web Services technologies .10
4.1 Web Service message content .10
4.1.1 SOAP.10
4.1.2 XML.10
4.1.3 HTTP.10
4.2 Web Service interface definitions .10
4.2.1 WSDL.10
4.3 Security for Parlay X 3 Web Services .10
4.4 XML data types.10
5 Detailed service description .11
5.1 Address data items.11
5.2 Charging.11
5.2.1 Charging data type.11
5.3 Exception definition.12
5.4 Service exception .12
5.5 Policy exception .12
6 Namespaces.13
7 Sequence diagrams.13
8 XML Schema data type definition .13
8.1 TimeMetrics enumeration.13
8.2 TimeMetric structure.13
8.3 ChargingInformation structure.13
8.4 ServiceError structure.14
8.5 SimpleReference structure.14
8.6 CallParticipantStatus enumeration .14
8.7 CallParticipantTerminationCause enumeration.14
8.8 CallParticipantInformation structure.15
8.9 CallSession structure.15
8.10 MediaInfo structure.15
8.11 Media enumeration.15
8.12 MediaDirection enumeration.15
9 Web Service interface definition.16
10 Fault definitions.16
10.1 ServiceException.16
10.1.1 SVC0001: Service error.16
10.1.2 SVC0002: Invalid input value .16
10.1.3 SVC0003: Invalid input value with list of valid values .16
10.1.4 SVC0004: No valid address(es).16
10.1.5 SVC0005: Duplicate correlator.17
10.1.6 SVC0006: Invalid group.17
10.1.7 SVC0007: Invalid charging information.17
10.1.8 SVC0008: Overlapping Criteria .17
ETSI
4 Final draft ETSI ES 202 504-1 V1.1.1 (2008-02)
10.2 PolicyException.17
10.2.1 POL0001: Policy error.17
10.2.2 POL0002: Privacy error.18
10.2.3 POL0003: Too many addresses .18
10.2.4 POL0004: Unlimited notifications not supported.18
10.2.5 POL0005: Too many notifications requested .18
10.2.6 POL0006: Groups not allowed .18
10.2.7 POL0007: Nested groups not allowed .18
10.2.8 POL0008: Charging not supported .18
10.2.9 POL0009: Invalid frequency requested .19
10.2.10 POL0010: Retention time interval expired .19
10.2.11 POL0011: Media type not supported.19
10.3 Fault number ranges by service.19
11 Service policies .19
12 WSDL usage and style .19
12.1 Service definition and documents .20
12.1.1 Interface sets.20
12.1.2 Preparing for document definition.20
12.1.3 Documents.21
12.1.3.1 Types definition document.21
12.1.3.2 Shared faults document .21
12.1.3.3 Service interface document .21
12.1.3.4 Service bindings document .21
12.1.4 Document separation rationale .22
12.1.5 Document version identifier.22
12.1.6 Document naming example.22
12.1.7 Service definitions for notification patterns.23
12.2 Namespaces.23
12.2.1 Namespaces for Parlay X 3 Web Services.23
12.2.2 Use of namespaces.23
12.2.3 Namespace elements.24
12.2.4 Namespace usage.24
12.2.4.1 Why namespace versions are used .24
12.2.4.2 When namespace versions are changed .24
12.2.4.3 Benefit of managing namespace versions .25
12.2.5 Common namespaces.25
12.2.6 Target namespace.25
12.2.7 WSDL and Schema namespaces.25
12.2.8 Local namespace use.26
12.2.9 Examples.26
12.3 Authoring style - Document content and names.26
12.3.1 General WSDL document information.26
12.3.2 Names.26
12.3.3 Case usage for names.27
12.3.4 Naming conventions for special names .27
12.3.5 Document layout.27
12.4 Data type definitions .28
12.4.1 Types section declaration.28
12.4.1.1 Optional elements.28
12.4.1.2 Nillable elements.28
12.4.1.3 User defined simple data types.28
12.4.1.4 Data structures.29
12.4.1.5 Enumerations .29
12.4.1.6 Unions.29
12.4.1.7 Web Service references.29
12.5 Messages and interfaces (PortTypes) .30
12.5.1 Messages.30
12.5.1.1 Document style Web Services.30
12.5.2 Interfaces (PortTypes).30
12.5.3 Faults (Exceptions).30
ETSI
5 Final draft ETSI ES 202 504-1 V1.1.1 (2008-02)
12.6 Bindings and service definitions .31
12.6.1 Binding.31
12.6.2 Service definition.31
Annex A (normative): WSDL for common data definitions .32
History .33
ETSI
6 Final draft ETSI ES 202 504-1 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 1 of a multi-part deliverable covering Open Service Access (OSA); Parlay X
Web Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
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
7 Final draft ETSI ES 202 504-1 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-01 V7.2.0 (Release 7).
The Mapping specification of the Parlay X 3 Web Services (ES 202 504) to the Parlay/OSA APIs (ES 203 915 [11])
and, where applicable, to IMS, is also structured as above. A mapping of the Parlay X 3 Web Services is however not
applicable for all parts (e.g. part 13), but the numbering of parts is kept.
Table 1: Overview of the Parlay X 3 Web Services and OSA APIs mappings
Parlay X 3 Web Services OSA APIs (and IMS) mappings
(ES 202 504 series) (TR 102 397 series)
ES 202 504-1 Common TR 102 397-1 Common mapping
ES 202 504-2 Third party call TR 102 397-2-1 Generic Call Control mapping
TR 102 397-2-2 Multi-Party Call Control mapping
ES 202 504-3 Call notification TR 102 397-3-1 Generic Call Control mapping
TR 102 397-3-2 Multi-Party Call Control mapping
ES 202 504-4 Short messaging TR 102 397-4-1 User Interaction mapping
TR 102 397-4-2 Multi-Media Messaging mapping
ES 202 504-5 Multimedia messaging TR 102 397-5-1 User Interaction mapping
TR 102 397-5-2 Multi-Media Messaging mapping
ES 202 504-6 Payment TR 102 397-6 Charging mapping
ES 202 504-7 Account management TR 102 397-7 Account Management mapping
ES 202 504-8 Terminal status TR 102 397-8 Mobility User Status mapping
ES 202 504-9 Terminal location TR 102 397-9-1 Mobility User Location mapping
TR 102 397-9-2 Mobility User Location CAMEL mapping
ES 202 504-10 Call handling TR 102 397-10-1 Generic Call Control & User Interaction mapping
TR 102 397-10-2 Multi-Party Call Control & User Interaction mapping
TR 102 397-10-3 Policy Management mapping
ES 202 504-11 Audio call TR 102 397-11-1 Generic Call Control & User Interaction mapping
TR 102 397-11-2 Multi-Party Call Control & User Interaction mapping
ES 202 504-12 Multimedia conference TR 102 397-12 Multi-Media Call Control mapping
ES 202 504-13 Address list management TR 102 397-13 Not Applicable
ES 202 504-14 Presence TR 102 397-14-1 Presence & Availability Management mapping
TR 102 397-14-2 SIP/IMS Networks mapping
ES 202 504-15 Message broadcast TR 102 397-15 Message Broadcast mapping
ES 202 504-16 Geocoding TR 102 397-16 Geocoding mapping
ES 202 504-17 Application-driven QoS TR 102 397-17 To be determined
ES 202 504-18 Device management TR 102 397-18 To be determined
ES 202 504-19 Multimedia streaming TR 102 397-19 To be determined
control
ES 202 504-20 Multimedia multicast TR 102 397-20 To be determined
session management
ETSI
8 Final draft ETSI ES 202 504-1 V1.1.1 (2008-02)
1 Scope
The present document is part 1 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 Common aspects of the Parlay X 3 Web Services. The following are defined here:
• Name spaces.
• Data definitions.
• Fault definitions.
• 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)".
[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] IETF RFC 3966: "The tel URI for Telephone Numbers".
ETSI
9 Final draft ETSI ES 202 504-1 V1.1.1 (2008-02)
NOTE: Available at: http://www.ietf.org/rfc/rfc3966.txt.
[4] IETF RFC 3261: "SIP: Session Initiation Protocol".
NOTE: Available at: http://www.ietf.org/rfc/rfc3261.txt.
[5] WS-I Basic Profile Version 1.0: "Final Material".
NOTE: Available at: http://www.ws-i.org/Profiles/BasicProfile-1.0-2004-04-16.html.
[6] W3C Note (15 March 2001): "Web Services Description Language (WSDL) 1.1".
NOTE: Available at: http://www.w3.org/TR/2001/NOTE-wsdl-20010315.
[7] OASIS Standard 200401 (March 2004): "Web Services Security: SOAP Message Security 1.0
(WS-Security 2004)".
NOTE: Available at: http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0.pdf.
[8] W3C Recommendation (12 February 2002): "XML-Signature Syntax and Processing".
NOTE: Available at: http://www.w3.org/TR/2002/REC-xmldsig-core-20020212/.
[9] ISO 4217: "Codes for the representation of currencies and funds".
[10] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax".
NOTE: Available at: http://www.ietf.org/rfc/rfc3986.txt.
[11] ETSI ES 203 915 (All parts): "Open Service Access (OSA); Application Programming
Interface (API)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the following terms and definitions apply:
application: computer program that accesses a Web Service
SOAP: not an acronym, protocol used for XML messaging
Web Service: software system designed to support interoperable machine-to-machine interaction over a network
Web Service Provider: entity which provides Web Services interfaces to capabilities offered
Web Service Requester: entity which operates Applications that access Web Services
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in TR 121 905 [1] and the following apply:
3GPP Third Generation Partnership Project
ETSI European Telecommunications Standards Institute
IT Information Technology
OASIS Organization for the Advancement of Structured Information Standards
OSA Open Service Access
RFC Request For Comment
SIP Session Initiation Protocol
UDDI Universal Description Discovery and Integration
URI Uniform Resource Identifier
W3C World Wide Web Consortium
ETSI
10 Final draft ETSI ES 202 504-1 V1.1.1 (2008-02)
WSDL Web Service Definition Language
WS-I Web Services-Interoperability Organization
XML Extensible Markup Language
4 Use of Web Services technologies
4.1 Web Service message content
4.1.1 SOAP
All Web Service messages SHALL send and accept messages that conform to the SOAP use defined in the
WS-I Basic Profile [5], using the document/literal encoding style.
4.1.2 XML
All Web Service messages SHALL send and accept messages that conform to the XML use defined in the
WS-I Basic Profile [5].
4.1.3 HTTP
All Web Service messages SHALL send and accept messages that conform to the HTTP use defined in the
WS-I Basic Profile [5].
4.2 Web Service interface definitions
All Parlay X 3 Web Services are defined according to the following.
4.2.1 WSDL
All Web Service interfaces SHALL be defined using WSDL 1.1 as defined in the WSDL specification [6] and be
conformant to the WSDL use defined in WS-I Basic Profile [5].
See clause 12 for detailed information on the WSDL style to be followed by Parlay X 3 Web Services.
4.3 Security for Parlay X 3 Web Services
If a message contains an identifier and/or credentials representing the sender of the message then these SHALL be
provided in a manner prescribed by WS-Security [7].
Encryption of message content MAY be required by the Web Service Provider. If this is required, then this SHALL be
accomplished in one of the following manners:
• Use of a Virtual Private Network, to be administered independent of the Web Service implementation.
• Use of Transport Level Security using HTTP over TLS as specified in the WS-I Basic Profile [5].
Integrity of the message content MAY be required by the Web Service Provider. If this is required, then this SHALL be
accomplished using XML Digital Signature [8].
4.4 XML data types
Where possible standard XML Schema data types are used, as defined in clause 3 (Built-in datatypes) in
XML Schema [2].
ETSI
11 Final draft ETSI ES 202 504-1 V1.1.1 (2008-02)
5 Detailed service description
5.1 Address data items
Addresses, unless the specification provides specific additional instruction, MUST conform to the address portion of the
URI definition provided in RFC 3966 [3] for 'tel:' addresses, RFC 3261 [4] for 'sip:' addresses or the definition given
below for shortcodes or aliased addresses. Optional additions to the address portion of these URI definitions MUST
NOT be considered part of the address accepted by the Parlay X 3 Web Services interfaces, and an implementation
MAY choose to reject an address as invalid if it contains any content other than the address portion.
When processing a 'tel:' URI, as specified in RFC 3966 [3], Parlay X 3 Web Services MUST accept national addresses
(those not starting with '+' and a country code) and MUST accept international addresses (those starting with '+' and a
country code). When specified in the definition of a service operation, the URI may contain wildcard characters in
accordance with the appropriate specification (i.e. RFC 3966 [3] or RFC 3261 [4]).
Shortcodes are short telephone numbers, usually 4 to 6 digits in length reserved for telecom service providers' own
functionality. They shall be differentiated from national addresses by the use of a 'short:' rather than 'tel:' URI scheme.
The short code defined in the URI consists of a string of digits with no non-digit characters.
Support for aliases in addresses is provided by use of the URI defined in RFC 3986 [10]. This allows for arbitrary data
to be submitted to the Parlay X Web Service interface. The following is an example of how this could be applied:
:
An alias is generally a relatively short character string that holds a scrambled address such that only the application
identified in the URI can expand it.
5.2 Charging
Web Services may use a Web Service Provider to deliver content or function. In some cases, the producer of the content
or capability will wish to use a bill-on-behalf-of capability offered by the Web Service Provider to charge for the
content/function provided. For those services where the charge is part of a single activity, providing the charging related
information as part of the message is very efficient.
An example is a messaging service, where a sports business collects information and distributes short messages with
sports scores to its subscribers. The sports business has an agreement with a Web Service Provider where the charges
for the messages are included in the bill provided by the Web Service Provider (thus the Web Service Provider is billing
on behalf of the sports business.
To enable this capability to be provided across a variety of services in a consistent manner, thus making implementation
easy and efficient, the information to be provided in the Web Service message for charging information is defined as a
common charging data type.
5.2.1 Charging data type
The charging information is provided in an XML data type, using the following schema:
ETSI
12 Final draft ETSI ES 202 504-1 V1.1.1 (2008-02)
The application accessing the Web Service provides this information:
• Description text, which will often be used to provide billing text. This text does not have specific required
content, but would likely include information on the business, the content or service provided, and a
transaction identifier. Credit card statements are a good example of description text provided by different
companies.
• Currency in which the charge is to be applied. Values for the currency field are defined by ISO 4217 [9].
• Defines the amount to be charged.
• Code specifies a charging code which references a contract under which this charge is applied. The code
identifier is provided by the Web Service Provider.
The charging information provided may not be acceptable to the Web Service Provider. For example, the Web Service
Provider may limit the amount that may be specified for a particular Web Service or for a particular Web Service
Requester. If the information provided is not acceptable, an appropriate fault message may be returned to the Web
Service Requester (SVC0007 is defined as a generic charging fault).
5.3 Exception definition
Exceptions are defined with three data items.
The first data item is a unique identifier for the message. This allows the receiver of the message to recognize the
message easily in a language-neutral manner. Thus applications and people seeing the message do not have to
understand the message text to be able to identify the message. This is very useful for customer support as well, since it
does not depend on the reader to be able to read the language of the message.
The second data item is the message text, including placeholders (marked with %) for additional information. This form
is consistent with the form for internationalization of messages used by many technologies (operating systems,
programming environments, etc.). Use of this form enables translation of messages to different languages independent
of program changes. This is well suited for Web Services messages, as a programming language is not defined.
The third data item is a list of zero or more strings that represent the content to put in each placeholder defined in the
message in the second data item.
5.4 Service exception
When a service is not able to process a request, and retrying the request with the same information will also result in a
failure, and the issue is not related to a service policy issue, then the service will issue a fault using the
ServiceException fault message. A Service Exception uses the letters 'SVC' at the beginning of the message identifier.
Examples of service exceptions include invalid input, lack of availability of a required resource or a processing error.
5.5 Policy exception
When a service is not able to complete because the request fails to meet a policy criteria, then the service will issue a
fault using the PolicyException fault message. To clarify how a Policy Exception differs from a Service Exception,
consider that all the input to an operation may be valid as meeting the required input for the operation (thus no Service
Exception), but using that input in the execution of the service may result in conditions that require the service not to
complete. A Policy Exception uses the letters 'POL' at the beginning of the message identifier.
Examples of policy exceptions include privacy violations, requests not permitted under a governing service agreement
or input content not acceptable to the service provider.
ETSI
13 Final draft ETSI ES 202 504-1 V1.1.1 (2008-02)
6 Namespaces
The namespace for the common data types is:
• http://www.csapi.org/schema/parlayx/common/v3_1
The namespace for the common faults is:
• http://www.csapi.org/wsdl/parlayx/common/v3_0/faults
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.
7 Sequence diagrams
Not applicable.
8 XML Schema data type definition
8.1 TimeMetrics enumeration
List of time metric values.
Enumeration value Description
Millisecond Millisecond
Second Second
Minute Minute
Hour Hour
Day Day
Week Week
Month Month
Year Year
8.2 TimeMetric structure
For services that provide service based on a time interval or duration or similar metric, this type is used to specify the
time metric.
Element name Element type Optional Description
metric TimeMetrics No Metric to use for time measurement
units xsd:int No Number of units of TimeMetrics
8.3 ChargingInformation structure
For services that include charging as an inline message part, the charging information is provided in this data structure.
Element name Element type Optional Description
description xsd:string No Description text to be use for information and billing text
currency xsd:string Yes Currency identifier as defined in ISO 4217 [9]
amount xsd:decimal Yes Amount to be charged
code xsd:string Yes Charging code, referencing a contract under which the charge is
applied
ETSI
14 Final draft ETSI ES 202 504-1 V1.1.1 (2008-02)
8.4 ServiceError structure
Some services that process requests for both single addresses and group of addresses return a fault message for the
single request, and a data item for the group response. This data structure allows the data item returned for a group
response to contain the same level of information as the fault message response.
Element name Element type Optional Description
messageId xsd:string No Message identifier (take from fault definitions)
text xsd:string No Message text, with replacement variables marked with %#
variables xsd:string Yes Variables to substitute into Text string
[0.unbounded]
8.5 SimpleReference structure
For those services that require a reference to a Web Service, the information required to create the endpoint information
is contained in this type.
Element name Element type Optional Description
endpoint xsd:anyURI No Endpoint address
interfaceName xsd:string No Name of interface
correlator xsd:string No Correlation information
8.6 CallParticipantStatus enumeration
List of the status values associated with a call to a participant.
Enumeration value Description
CallParticipantInitial The call is being established to a participant
CallParticipantConnected The participant is active in the call
CallParticipantTerminated The call to the participant was terminated
8.7 CallParticipantTerminationCause enumeration
List of the termination causes associated with a call to a participant.
Enumeration value Description
CallParticipantNoAnswer The participant did not answer the call
CallParticipantBusy The participant was busy
CallParticipantNotReachable The participant was not reachable
CallParticipantHangUp The participant hung up thereby terminating the call for that party
CallParticipantAborted The call was aborted for the participant (i.e. any termination cause
other than hanging up)
ETSI
15 Final draft ETSI ES 202 504-1 V1.1.1 (2008-02)
8.8 CallParticipantInformation structure
Information about a participant in a call.
Element name Element type Optional Description
callParticipantIdentifier xsd:anyURI No Identifies an individual call participant.
callParticipantStatus CallParticipantStatus No It indicates the current status of the participant in the
call
callParticipantStartTime xsd:dateTime Yes When applicable (callParticipantStatus <>
CallParticipantInitial), it indicates the time when the
call participant was added to the call
When applicable (callParticipantStatus =
callParticipantDuration xsd:int Yes
CallParticipantTerminated), it indicates the duration
of the call participant's involvement in the call
expressed in seconds
callParticipantTermination CallParticipant Yes When applicable (callParticipantStatus =
Cause TerminationCause CallParticipantTerminated), it indicates the cause of
the call participant's termination from the call
mediaInfo MediaInfo Yes When applicable, it indicates the media currently used
[0.unbounded] in the call for the identified participant
8.9 CallSession structure
Call Session information for this call.
Element name Element type Optional Description
callSessionIdentifier xsd:string No Identifies the call session with one or more
participants. Note: Parlay X call control related
web services may use this identifier to interact
with call participants (e.g. PlayMedia)
callParticipantInformation CallParticipantInformation Yes Identifies all information related to an individual
[0.unbounded] participant (or set of call participants) within a
call session
8.10 MediaInfo structure
Element name Element Type Optional Description
media Media No Identifies the type
...
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 1: Common
(Parlay X 3)
�
2 ETSI ES 202 504-1 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-1-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 504-1 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.9
4 Use of Web Services technologies .10
4.1 Web Service message content .10
4.1.1 SOAP.10
4.1.2 XML.10
4.1.3 HTTP.10
4.2 Web Service interface definitions .10
4.2.1 WSDL.10
4.3 Security for Parlay X 3 Web Services .10
4.4 XML data types.10
5 Detailed service description .11
5.1 Address data items.11
5.2 Charging.11
5.2.1 Charging data type.11
5.3 Exception definition.12
5.4 Service exception .12
5.5 Policy exception .12
6 Namespaces.13
7 Sequence diagrams.13
8 XML Schema data type definition .13
8.1 TimeMetrics enumeration.13
8.2 TimeMetric structure.13
8.3 ChargingInformation structure.13
8.4 ServiceError structure.14
8.5 SimpleReference structure.14
8.6 CallParticipantStatus enumeration .14
8.7 CallParticipantTerminationCause enumeration.14
8.8 CallParticipantInformation structure.15
8.9 CallSession structure.15
8.10 MediaInfo structure.15
8.11 Media enumeration.15
8.12 MediaDirection enumeration.15
9 Web Service interface definition.16
10 Fault definitions.16
10.1 ServiceException.16
10.1.1 SVC0001: Service error.16
10.1.2 SVC0002: Invalid input value .16
10.1.3 SVC0003: Invalid input value with list of valid values .16
10.1.4 SVC0004: No valid address(es).16
10.1.5 SVC0005: Duplicate correlator.17
10.1.6 SVC0006: Invalid group.17
10.1.7 SVC0007: Invalid charging information.17
10.1.8 SVC0008: Overlapping Criteria .17
ETSI
4 ETSI ES 202 504-1 V1.1.1 (2008-05)
10.2 PolicyException.17
10.2.1 POL0001: Policy error.17
10.2.2 POL0002: Privacy error.18
10.2.3 POL0003: Too many addresses .18
10.2.4 POL0004: Unlimited notifications not supported.18
10.2.5 POL0005: Too many notifications requested .18
10.2.6 POL0006: Groups not allowed .18
10.2.7 POL0007: Nested groups not allowed .18
10.2.8 POL0008: Charging not supported .18
10.2.9 POL0009: Invalid frequency requested .19
10.2.10 POL0010: Retention time interval expired .19
10.2.11 POL0011: Media type not supported.19
10.3 Fault number ranges by service.19
11 Service policies .19
12 WSDL usage and style .19
12.1 Service definition and documents .20
12.1.1 Interface sets.20
12.1.2 Preparing for document definition.20
12.1.3 Documents.21
12.1.3.1 Types definition document.21
12.1.3.2 Shared faults document .21
12.1.3.3 Service interface document .21
12.1.3.4 Service bindings document .21
12.1.4 Document separation rationale .22
12.1.5 Document version identifier.22
12.1.6 Document naming example.22
12.1.7 Service definitions for notification patterns.23
12.2 Namespaces.23
12.2.1 Namespaces for Parlay X 3 Web Services.23
12.2.2 Use of namespaces.23
12.2.3 Namespace elements.24
12.2.4 Namespace usage.24
12.2.4.1 Why namespace versions are used .24
12.2.4.2 When namespace versions are changed .24
12.2.4.3 Benefit of managing namespace versions .25
12.2.5 Common namespaces.25
12.2.6 Target namespace.25
12.2.7 WSDL and Schema namespaces.25
12.2.8 Local namespace use.26
12.2.9 Examples.26
12.3 Authoring style - Document content and names.26
12.3.1 General WSDL document information.26
12.3.2 Names.26
12.3.3 Case usage for names.27
12.3.4 Naming conventions for special names .27
12.3.5 Document layout.27
12.4 Data type definitions .28
12.4.1 Types section declaration.28
12.4.1.1 Optional elements.28
12.4.1.2 Nillable elements.28
12.4.1.3 User defined simple data types.28
12.4.1.4 Data structures.29
12.4.1.5 Enumerations .29
12.4.1.6 Unions.29
12.4.1.7 Web Service references.29
12.5 Messages and interfaces (PortTypes) .30
12.5.1 Messages.30
12.5.1.1 Document style Web Services.30
12.5.2 Interfaces (PortTypes).30
12.5.3 Faults (Exceptions).30
ETSI
5 ETSI ES 202 504-1 V1.1.1 (2008-05)
12.6 Bindings and service definitions .31
12.6.1 Binding.31
12.6.2 Service definition.31
Annex A (normative): WSDL for common data definitions .32
History .33
ETSI
6 ETSI ES 202 504-1 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 1 of a multi-part deliverable covering Open Service Access (OSA); Parlay X
Web Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
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".
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.
ETSI
7 ETSI ES 202 504-1 V1.1.1 (2008-05)
The present document is equivalent to 3GPP TS 29.199-01 V7.2.0 (Release 7).
The Mapping specification of the Parlay X 3 Web Services (ES 202 504) to the Parlay/OSA APIs (ES 203 915 [11])
and, where applicable, to IMS, is also structured as above. A mapping of the Parlay X 3 Web Services is however not
applicable for all parts (e.g. part 13), but the numbering of parts is kept.
Table 1: Overview of the Parlay X 3 Web Services and OSA APIs mappings
Parlay X 3 Web Services OSA APIs (and IMS) mappings
(ES 202 504 series) (TR 102 397 series)
ES 202 504-1 Common TR 102 397-1 Common mapping
ES 202 504-2 Third party call TR 102 397-2-1 Generic Call Control mapping
TR 102 397-2-2 Multi-Party Call Control mapping
ES 202 504-3 Call notification TR 102 397-3-1 Generic Call Control mapping
TR 102 397-3-2 Multi-Party Call Control mapping
ES 202 504-4 Short messaging TR 102 397-4-1 User Interaction mapping
TR 102 397-4-2 Multi-Media Messaging mapping
ES 202 504-5 Multimedia messaging TR 102 397-5-1 User Interaction mapping
TR 102 397-5-2 Multi-Media Messaging mapping
ES 202 504-6 Payment TR 102 397-6 Charging mapping
ES 202 504-7 Account management TR 102 397-7 Account Management mapping
ES 202 504-8 Terminal status TR 102 397-8 Mobility User Status mapping
ES 202 504-9 Terminal location TR 102 397-9-1 Mobility User Location mapping
TR 102 397-9-2 Mobility User Location CAMEL mapping
ES 202 504-10 Call handling TR 102 397-10-1 Generic Call Control & User Interaction mapping
TR 102 397-10-2 Multi-Party Call Control & User Interaction mapping
TR 102 397-10-3 Policy Management mapping
ES 202 504-11 Audio call TR 102 397-11-1 Generic Call Control & User Interaction mapping
TR 102 397-11-2 Multi-Party Call Control & User Interaction mapping
ES 202 504-12 Multimedia conference TR 102 397-12 Multi-Media Call Control mapping
ES 202 504-13 Address list management TR 102 397-13 Not Applicable
ES 202 504-14 Presence TR 102 397-14-1 Presence & Availability Management mapping
TR 102 397-14-2 SIP/IMS Networks mapping
ES 202 504-15 Message broadcast TR 102 397-15 Message Broadcast mapping
ES 202 504-16 Geocoding TR 102 397-16 Geocoding mapping
ES 202 504-17 Application-driven QoS TR 102 397-17 To be determined
ES 202 504-18 Device management TR 102 397-18 To be determined
ES 202 504-19 Multimedia streaming TR 102 397-19 To be determined
control
ES 202 504-20 Multimedia multicast TR 102 397-20 To be determined
session management
ETSI
8 ETSI ES 202 504-1 V1.1.1 (2008-05)
1 Scope
The present document is part 1 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 Common aspects of the Parlay X 3 Web Services. The following are defined here:
• Name spaces.
• Data definitions.
• Fault definitions.
• 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)".
[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] IETF RFC 3966: "The tel URI for Telephone Numbers".
ETSI
9 ETSI ES 202 504-1 V1.1.1 (2008-05)
NOTE: Available at: http://www.ietf.org/rfc/rfc3966.txt.
[4] IETF RFC 3261: "SIP: Session Initiation Protocol".
NOTE: Available at: http://www.ietf.org/rfc/rfc3261.txt.
[5] WS-I Basic Profile Version 1.0: "Final Material".
NOTE: Available at: http://www.ws-i.org/Profiles/BasicProfile-1.0-2004-04-16.html.
[6] W3C Note (15 March 2001): "Web Services Description Language (WSDL) 1.1".
NOTE: Available at: http://www.w3.org/TR/2001/NOTE-wsdl-20010315.
[7] OASIS Standard 200401 (March 2004): "Web Services Security: SOAP Message Security 1.0
(WS-Security 2004)".
NOTE: Available at: http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0.pdf.
[8] W3C Recommendation (12 February 2002): "XML-Signature Syntax and Processing".
NOTE: Available at: http://www.w3.org/TR/2002/REC-xmldsig-core-20020212/.
[9] ISO 4217: "Codes for the representation of currencies and funds".
[10] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax".
NOTE: Available at: http://www.ietf.org/rfc/rfc3986.txt.
[11] ETSI ES 203 915 (All parts): "Open Service Access (OSA); Application Programming
Interface (API)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the following terms and definitions apply:
application: computer program that accesses a Web Service
SOAP: not an acronym, protocol used for XML messaging
Web Service: software system designed to support interoperable machine-to-machine interaction over a network
Web Service Provider: entity which provides Web Services interfaces to capabilities offered
Web Service Requester: entity which operates Applications that access Web Services
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in TR 121 905 [1] and the following apply:
3GPP Third Generation Partnership Project
ETSI European Telecommunications Standards Institute
IT Information Technology
OASIS Organization for the Advancement of Structured Information Standards
OSA Open Service Access
RFC Request For Comment
SIP Session Initiation Protocol
UDDI Universal Description Discovery and Integration
URI Uniform Resource Identifier
W3C World Wide Web Consortium
ETSI
10 ETSI ES 202 504-1 V1.1.1 (2008-05)
WSDL Web Service Definition Language
WS-I Web Services-Interoperability Organization
XML Extensible Markup Language
4 Use of Web Services technologies
4.1 Web Service message content
4.1.1 SOAP
All Web Service messages SHALL send and accept messages that conform to the SOAP use defined in the
WS-I Basic Profile [5], using the document/literal encoding style.
4.1.2 XML
All Web Service messages SHALL send and accept messages that conform to the XML use defined in the
WS-I Basic Profile [5].
4.1.3 HTTP
All Web Service messages SHALL send and accept messages that conform to the HTTP use defined in the
WS-I Basic Profile [5].
4.2 Web Service interface definitions
All Parlay X 3 Web Services are defined according to the following.
4.2.1 WSDL
All Web Service interfaces SHALL be defined using WSDL 1.1 as defined in the WSDL specification [6] and be
conformant to the WSDL use defined in WS-I Basic Profile [5].
See clause 12 for detailed information on the WSDL style to be followed by Parlay X 3 Web Services.
4.3 Security for Parlay X 3 Web Services
If a message contains an identifier and/or credentials representing the sender of the message then these SHALL be
provided in a manner prescribed by WS-Security [7].
Encryption of message content MAY be required by the Web Service Provider. If this is required, then this SHALL be
accomplished in one of the following manners:
• Use of a Virtual Private Network, to be administered independent of the Web Service implementation.
• Use of Transport Level Security using HTTP over TLS as specified in the WS-I Basic Profile [5].
Integrity of the message content MAY be required by the Web Service Provider. If this is required, then this SHALL be
accomplished using XML Digital Signature [8].
4.4 XML data types
Where possible standard XML Schema data types are used, as defined in clause 3 (Built-in datatypes) in
XML Schema [2].
ETSI
11 ETSI ES 202 504-1 V1.1.1 (2008-05)
5 Detailed service description
5.1 Address data items
Addresses, unless the specification provides specific additional instruction, MUST conform to the address portion of the
URI definition provided in RFC 3966 [3] for 'tel:' addresses, RFC 3261 [4] for 'sip:' addresses or the definition given
below for shortcodes or aliased addresses. Optional additions to the address portion of these URI definitions MUST
NOT be considered part of the address accepted by the Parlay X 3 Web Services interfaces, and an implementation
MAY choose to reject an address as invalid if it contains any content other than the address portion.
When processing a 'tel:' URI, as specified in RFC 3966 [3], Parlay X 3 Web Services MUST accept national addresses
(those not starting with '+' and a country code) and MUST accept international addresses (those starting with '+' and a
country code). When specified in the definition of a service operation, the URI may contain wildcard characters in
accordance with the appropriate specification (i.e. RFC 3966 [3] or RFC 3261 [4]).
Shortcodes are short telephone numbers, usually 4 to 6 digits in length reserved for telecom service providers' own
functionality. They shall be differentiated from national addresses by the use of a 'short:' rather than 'tel:' URI scheme.
The short code defined in the URI consists of a string of digits with no non-digit characters.
Support for aliases in addresses is provided by use of the URI defined in RFC 3986 [10]. This allows for arbitrary data
to be submitted to the Parlay X Web Service interface. The following is an example of how this could be applied:
:
An alias is generally a relatively short character string that holds a scrambled address such that only the application
identified in the URI can expand it.
5.2 Charging
Web Services may use a Web Service Provider to deliver content or function. In some cases, the producer of the content
or capability will wish to use a bill-on-behalf-of capability offered by the Web Service Provider to charge for the
content/function provided. For those services where the charge is part of a single activity, providing the charging related
information as part of the message is very efficient.
An example is a messaging service, where a sports business collects information and distributes short messages with
sports scores to its subscribers. The sports business has an agreement with a Web Service Provider where the charges
for the messages are included in the bill provided by the Web Service Provider (thus the Web Service Provider is billing
on behalf of the sports business.
To enable this capability to be provided across a variety of services in a consistent manner, thus making implementation
easy and efficient, the information to be provided in the Web Service message for charging information is defined as a
common charging data type.
5.2.1 Charging data type
The charging information is provided in an XML data type, using the following schema:
ETSI
12 ETSI ES 202 504-1 V1.1.1 (2008-05)
The application accessing the Web Service provides this information:
• Description text, which will often be used to provide billing text. This text does not have specific required
content, but would likely include information on the business, the content or service provided, and a
transaction identifier. Credit card statements are a good example of description text provided by different
companies.
• Currency in which the charge is to be applied. Values for the currency field are defined by ISO 4217 [9].
• Defines the amount to be charged.
• Code specifies a charging code which references a contract under which this charge is applied. The code
identifier is provided by the Web Service Provider.
The charging information provided may not be acceptable to the Web Service Provider. For example, the Web Service
Provider may limit the amount that may be specified for a particular Web Service or for a particular Web Service
Requester. If the information provided is not acceptable, an appropriate fault message may be returned to the Web
Service Requester (SVC0007 is defined as a generic charging fault).
5.3 Exception definition
Exceptions are defined with three data items.
The first data item is a unique identifier for the message. This allows the receiver of the message to recognize the
message easily in a language-neutral manner. Thus applications and people seeing the message do not have to
understand the message text to be able to identify the message. This is very useful for customer support as well, since it
does not depend on the reader to be able to read the language of the message.
The second data item is the message text, including placeholders (marked with %) for additional information. This form
is consistent with the form for internationalization of messages used by many technologies (operating systems,
programming environments, etc.). Use of this form enables translation of messages to different languages independent
of program changes. This is well suited for Web Services messages, as a programming language is not defined.
The third data item is a list of zero or more strings that represent the content to put in each placeholder defined in the
message in the second data item.
5.4 Service exception
When a service is not able to process a request, and retrying the request with the same information will also result in a
failure, and the issue is not related to a service policy issue, then the service will issue a fault using the
ServiceException fault message. A Service Exception uses the letters 'SVC' at the beginning of the message identifier.
Examples of service exceptions include invalid input, lack of availability of a required resource or a processing error.
5.5 Policy exception
When a service is not able to complete because the request fails to meet a policy criteria, then the service will issue a
fault using the PolicyException fault message. To clarify how a Policy Exception differs from a Service Exception,
consider that all the input to an operation may be valid as meeting the required input for the operation (thus no Service
Exception), but using that input in the execution of the service may result in conditions that require the service not to
complete. A Policy Exception uses the letters 'POL' at the beginning of the message identifier.
Examples of policy exceptions include privacy violations, requests not permitted under a governing service agreement
or input content not acceptable to the service provider.
ETSI
13 ETSI ES 202 504-1 V1.1.1 (2008-05)
6 Namespaces
The namespace for the common data types is:
• http://www.csapi.org/schema/parlayx/common/v3_1
The namespace for the common faults is:
• http://www.csapi.org/wsdl/parlayx/common/v3_0/faults
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.
7 Sequence diagrams
Not applicable.
8 XML Schema data type definition
8.1 TimeMetrics enumeration
List of time metric values.
Enumeration value Description
Millisecond Millisecond
Second Second
Minute Minute
Hour Hour
Day Day
Week Week
Month Month
Year Year
8.2 TimeMetric structure
For services that provide service based on a time interval or duration or similar metric, this type is used to specify the
time metric.
Element name Element type Optional Description
metric TimeMetrics No Metric to use for time measurement
units xsd:int No Number of units of TimeMetrics
8.3 ChargingInformation structure
For services that include charging as an inline message part, the charging information is provided in this data structure.
Element name Element type Optional Description
description xsd:string No Description text to be use for information and billing text
currency xsd:string Yes Currency identifier as defined in ISO 4217 [9]
amount xsd:decimal Yes Amount to be charged
code xsd:string Yes Charging code, referencing a contract under which the charge is
applied
ETSI
14 ETSI ES 202 504-1 V1.1.1 (2008-05)
8.4 ServiceError structure
Some services that process requests for both single addresses and group of addresses return a fault message for the
single request, and a data item for the group response. This data structure allows the data item returned for a group
response to contain the same level of information as the fault message response.
Element name Element type Optional Description
messageId xsd:string No Message identifier (take from fault definitions)
text xsd:string No Message text, with replacement variables marked with %#
variables xsd:string Yes Variables to substitute into Text string
[0.unbounded]
8.5 SimpleReference structure
For those services that require a reference to a Web Service, the information required to create the endpoint information
is contained in this type.
Element name Element type Optional Description
endpoint xsd:anyURI No Endpoint address
interfaceName xsd:string No Name of interface
correlator xsd:string No Correlation information
8.6 CallParticipantStatus enumeration
List of the status values associated with a call to a participant.
Enumeration value Description
CallParticipantInitial The call is being established to a participant
CallParticipantConnected The participant is active in the call
CallParticipantTerminated The call to the participant was terminated
8.7 CallParticipantTerminationCause enumeration
List of the termination causes associated with a call to a participant.
Enumeration value Description
CallParticipantNoAnswer The participant did not answer the call
CallParticipantBusy The participant was busy
CallParticipantNotReachable The participant was not reachable
CallParticipantHangUp The participant hung up thereby terminating the call for that party
CallParticipantAborted The call was aborted for the participant (i.e. any termination cause
other than hanging up)
ETSI
15 ETSI ES 202 504-1 V1.1.1 (2008-05)
8.8 CallParticipantInformation structure
Information about a participant in a call.
Element name Element type Optional Description
callParticipantIdentifier xsd:anyURI No Identifies an individual call participant.
callParticipantStatus CallParticipantStatus No It indicates the current status of the participant in the
call
callParticipantStartTime xsd:dateTime Yes When applicable (callParticipantStatus <>
CallParticipantInitial), it indicates the time when the
call participant was added to the call
When applicable (callParticipantStatus =
callParticipantDuration xsd:int Yes
CallParticipantTerminated), it indicates the duration
of the call participant's involvement in the call
expressed in seconds
callParticipantTermination CallParticipant Yes When applicable (callParticipantStatus =
Cause TerminationCause CallParticipantTerminated), it indicates the cause of
the call participant's termination from the call
mediaInfo MediaInfo Yes When applicable, it indicates the media currently used
[0.unbounded] in the call for the identified participant
8.9 CallSession structure
Call Session information for this call.
Element name Element type Optional Description
callSessionIdentifier xsd:string No Identifies the call session with one or more
participants. Note: Parlay X call control related
web services may use this identifier to interact
with call participants (e.g. PlayMedia)
callParticipantInformation CallParticipantInformation Yes Identifies all information related to an individual
[0.unbounded] participant (or set of call participants) within a
call session
8.10 MediaInfo structure
Element name Element Type Optional Description
media Media No Identifies the type of media information
mediaDirection MediaDirection No Identifies the direction of the media
8.11 Media enumeration
Enumeration value Description
Audio Audio media type
Video Video media type
Chat Chat media type
Data Other media type
8.12 Medi
...
SLOVENSKI STANDARD
01-september-2008
Odprti dostop do storitve (OSA) - Spletne storitve Parlay X - 1. del: Splošno (Parlay
X 3)
Open Service Access (OSA) - Parlay X Web Services - Part 1: Common (Parlay X 3)
Ta slovenski standard je istoveten z: ES 202 504-1 Version 1.1.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 1: Common
(Parlay X 3)
�
2 ETSI ES 202 504-1 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-1-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 504-1 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.9
4 Use of Web Services technologies .10
4.1 Web Service message content .10
4.1.1 SOAP.10
4.1.2 XML.10
4.1.3 HTTP.10
4.2 Web Service interface definitions .10
4.2.1 WSDL.10
4.3 Security for Parlay X 3 Web Services .10
4.4 XML data types.10
5 Detailed service description .11
5.1 Address data items.11
5.2 Charging.11
5.2.1 Charging data type.11
5.3 Exception definition.12
5.4 Service exception .12
5.5 Policy exception .12
6 Namespaces.13
7 Sequence diagrams.13
8 XML Schema data type definition .13
8.1 TimeMetrics enumeration.13
8.2 TimeMetric structure.13
8.3 ChargingInformation structure.13
8.4 ServiceError structure.14
8.5 SimpleReference structure.14
8.6 CallParticipantStatus enumeration .14
8.7 CallParticipantTerminationCause enumeration.14
8.8 CallParticipantInformation structure.15
8.9 CallSession structure.15
8.10 MediaInfo structure.15
8.11 Media enumeration.15
8.12 MediaDirection enumeration.15
9 Web Service interface definition.16
10 Fault definitions.16
10.1 ServiceException.16
10.1.1 SVC0001: Service error.16
10.1.2 SVC0002: Invalid input value .16
10.1.3 SVC0003: Invalid input value with list of valid values .16
10.1.4 SVC0004: No valid address(es).16
10.1.5 SVC0005: Duplicate correlator.17
10.1.6 SVC0006: Invalid group.17
10.1.7 SVC0007: Invalid charging information.17
10.1.8 SVC0008: Overlapping Criteria .17
ETSI
4 ETSI ES 202 504-1 V1.1.1 (2008-05)
10.2 PolicyException.17
10.2.1 POL0001: Policy error.17
10.2.2 POL0002: Privacy error.18
10.2.3 POL0003: Too many addresses .18
10.2.4 POL0004: Unlimited notifications not supported.18
10.2.5 POL0005: Too many notifications requested .18
10.2.6 POL0006: Groups not allowed .18
10.2.7 POL0007: Nested groups not allowed .18
10.2.8 POL0008: Charging not supported .18
10.2.9 POL0009: Invalid frequency requested .19
10.2.10 POL0010: Retention time interval expired .19
10.2.11 POL0011: Media type not supported.19
10.3 Fault number ranges by service.19
11 Service policies .19
12 WSDL usage and style .19
12.1 Service definition and documents .20
12.1.1 Interface sets.20
12.1.2 Preparing for document definition.20
12.1.3 Documents.21
12.1.3.1 Types definition document.21
12.1.3.2 Shared faults document .21
12.1.3.3 Service interface document .21
12.1.3.4 Service bindings document .21
12.1.4 Document separation rationale .22
12.1.5 Document version identifier.22
12.1.6 Document naming example.22
12.1.7 Service definitions for notification patterns.23
12.2 Namespaces.23
12.2.1 Namespaces for Parlay X 3 Web Services.23
12.2.2 Use of namespaces.23
12.2.3 Namespace elements.24
12.2.4 Namespace usage.24
12.2.4.1 Why namespace versions are used .24
12.2.4.2 When namespace versions are changed .24
12.2.4.3 Benefit of managing namespace versions .25
12.2.5 Common namespaces.25
12.2.6 Target namespace.25
12.2.7 WSDL and Schema namespaces.25
12.2.8 Local namespace use.26
12.2.9 Examples.26
12.3 Authoring style - Document content and names.26
12.3.1 General WSDL document information.26
12.3.2 Names.26
12.3.3 Case usage for names.27
12.3.4 Naming conventions for special names .27
12.3.5 Document layout.27
12.4 Data type definitions .28
12.4.1 Types section declaration.28
12.4.1.1 Optional elements.28
12.4.1.2 Nillable elements.28
12.4.1.3 User defined simple data types.28
12.4.1.4 Data structures.29
12.4.1.5 Enumerations .29
12.4.1.6 Unions.29
12.4.1.7 Web Service references.29
12.5 Messages and interfaces (PortTypes) .30
12.5.1 Messages.30
12.5.1.1 Document style Web Services.30
12.5.2 Interfaces (PortTypes).30
12.5.3 Faults (Exceptions).30
ETSI
5 ETSI ES 202 504-1 V1.1.1 (2008-05)
12.6 Bindings and service definitions .31
12.6.1 Binding.31
12.6.2 Service definition.31
Annex A (normative): WSDL for common data definitions .32
History .33
ETSI
6 ETSI ES 202 504-1 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 1 of a multi-part deliverable covering Open Service Access (OSA); Parlay X
Web Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
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".
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.
ETSI
7 ETSI ES 202 504-1 V1.1.1 (2008-05)
The present document is equivalent to 3GPP TS 29.199-01 V7.2.0 (Release 7).
The Mapping specification of the Parlay X 3 Web Services (ES 202 504) to the Parlay/OSA APIs (ES 203 915 [11])
and, where applicable, to IMS, is also structured as above. A mapping of the Parlay X 3 Web Services is however not
applicable for all parts (e.g. part 13), but the numbering of parts is kept.
Table 1: Overview of the Parlay X 3 Web Services and OSA APIs mappings
Parlay X 3 Web Services OSA APIs (and IMS) mappings
(ES 202 504 series) (TR 102 397 series)
ES 202 504-1 Common TR 102 397-1 Common mapping
ES 202 504-2 Third party call TR 102 397-2-1 Generic Call Control mapping
TR 102 397-2-2 Multi-Party Call Control mapping
ES 202 504-3 Call notification TR 102 397-3-1 Generic Call Control mapping
TR 102 397-3-2 Multi-Party Call Control mapping
ES 202 504-4 Short messaging TR 102 397-4-1 User Interaction mapping
TR 102 397-4-2 Multi-Media Messaging mapping
ES 202 504-5 Multimedia messaging TR 102 397-5-1 User Interaction mapping
TR 102 397-5-2 Multi-Media Messaging mapping
ES 202 504-6 Payment TR 102 397-6 Charging mapping
ES 202 504-7 Account management TR 102 397-7 Account Management mapping
ES 202 504-8 Terminal status TR 102 397-8 Mobility User Status mapping
ES 202 504-9 Terminal location TR 102 397-9-1 Mobility User Location mapping
TR 102 397-9-2 Mobility User Location CAMEL mapping
ES 202 504-10 Call handling TR 102 397-10-1 Generic Call Control & User Interaction mapping
TR 102 397-10-2 Multi-Party Call Control & User Interaction mapping
TR 102 397-10-3 Policy Management mapping
ES 202 504-11 Audio call TR 102 397-11-1 Generic Call Control & User Interaction mapping
TR 102 397-11-2 Multi-Party Call Control & User Interaction mapping
ES 202 504-12 Multimedia conference TR 102 397-12 Multi-Media Call Control mapping
ES 202 504-13 Address list management TR 102 397-13 Not Applicable
ES 202 504-14 Presence TR 102 397-14-1 Presence & Availability Management mapping
TR 102 397-14-2 SIP/IMS Networks mapping
ES 202 504-15 Message broadcast TR 102 397-15 Message Broadcast mapping
ES 202 504-16 Geocoding TR 102 397-16 Geocoding mapping
ES 202 504-17 Application-driven QoS TR 102 397-17 To be determined
ES 202 504-18 Device management TR 102 397-18 To be determined
ES 202 504-19 Multimedia streaming TR 102 397-19 To be determined
control
ES 202 504-20 Multimedia multicast TR 102 397-20 To be determined
session management
ETSI
8 ETSI ES 202 504-1 V1.1.1 (2008-05)
1 Scope
The present document is part 1 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 Common aspects of the Parlay X 3 Web Services. The following are defined here:
• Name spaces.
• Data definitions.
• Fault definitions.
• 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)".
[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] IETF RFC 3966: "The tel URI for Telephone Numbers".
ETSI
9 ETSI ES 202 504-1 V1.1.1 (2008-05)
NOTE: Available at: http://www.ietf.org/rfc/rfc3966.txt.
[4] IETF RFC 3261: "SIP: Session Initiation Protocol".
NOTE: Available at: http://www.ietf.org/rfc/rfc3261.txt.
[5] WS-I Basic Profile Version 1.0: "Final Material".
NOTE: Available at: http://www.ws-i.org/Profiles/BasicProfile-1.0-2004-04-16.html.
[6] W3C Note (15 March 2001): "Web Services Description Language (WSDL) 1.1".
NOTE: Available at: http://www.w3.org/TR/2001/NOTE-wsdl-20010315.
[7] OASIS Standard 200401 (March 2004): "Web Services Security: SOAP Message Security 1.0
(WS-Security 2004)".
NOTE: Available at: http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0.pdf.
[8] W3C Recommendation (12 February 2002): "XML-Signature Syntax and Processing".
NOTE: Available at: http://www.w3.org/TR/2002/REC-xmldsig-core-20020212/.
[9] ISO 4217: "Codes for the representation of currencies and funds".
[10] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax".
NOTE: Available at: http://www.ietf.org/rfc/rfc3986.txt.
[11] ETSI ES 203 915 (All parts): "Open Service Access (OSA); Application Programming
Interface (API)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the following terms and definitions apply:
application: computer program that accesses a Web Service
SOAP: not an acronym, protocol used for XML messaging
Web Service: software system designed to support interoperable machine-to-machine interaction over a network
Web Service Provider: entity which provides Web Services interfaces to capabilities offered
Web Service Requester: entity which operates Applications that access Web Services
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in TR 121 905 [1] and the following apply:
3GPP Third Generation Partnership Project
ETSI European Telecommunications Standards Institute
IT Information Technology
OASIS Organization for the Advancement of Structured Information Standards
OSA Open Service Access
RFC Request For Comment
SIP Session Initiation Protocol
UDDI Universal Description Discovery and Integration
URI Uniform Resource Identifier
W3C World Wide Web Consortium
ETSI
10 ETSI ES 202 504-1 V1.1.1 (2008-05)
WSDL Web Service Definition Language
WS-I Web Services-Interoperability Organization
XML Extensible Markup Language
4 Use of Web Services technologies
4.1 Web Service message content
4.1.1 SOAP
All Web Service messages SHALL send and accept messages that conform to the SOAP use defined in the
WS-I Basic Profile [5], using the document/literal encoding style.
4.1.2 XML
All Web Service messages SHALL send and accept messages that conform to the XML use defined in the
WS-I Basic Profile [5].
4.1.3 HTTP
All Web Service messages SHALL send and accept messages that conform to the HTTP use defined in the
WS-I Basic Profile [5].
4.2 Web Service interface definitions
All Parlay X 3 Web Services are defined according to the following.
4.2.1 WSDL
All Web Service interfaces SHALL be defined using WSDL 1.1 as defined in the WSDL specification [6] and be
conformant to the WSDL use defined in WS-I Basic Profile [5].
See clause 12 for detailed information on the WSDL style to be followed by Parlay X 3 Web Services.
4.3 Security for Parlay X 3 Web Services
If a message contains an identifier and/or credentials representing the sender of the message then these SHALL be
provided in a manner prescribed by WS-Security [7].
Encryption of message content MAY be required by the Web Service Provider. If this is required, then this SHALL be
accomplished in one of the following manners:
• Use of a Virtual Private Network, to be administered independent of the Web Service implementation.
• Use of Transport Level Security using HTTP over TLS as specified in the WS-I Basic Profile [5].
Integrity of the message content MAY be required by the Web Service Provider. If this is required, then this SHALL be
accomplished using XML Digital Signature [8].
4.4 XML data types
Where possible standard XML Schema data types are used, as defined in clause 3 (Built-in datatypes) in
XML Schema [2].
ETSI
11 ETSI ES 202 504-1 V1.1.1 (2008-05)
5 Detailed service description
5.1 Address data items
Addresses, unless the specification provides specific additional instruction, MUST conform to the address portion of the
URI definition provided in RFC 3966 [3] for 'tel:' addresses, RFC 3261 [4] for 'sip:' addresses or the definition given
below for shortcodes or aliased addresses. Optional additions to the address portion of these URI definitions MUST
NOT be considered part of the address accepted by the Parlay X 3 Web Services interfaces, and an implementation
MAY choose to reject an address as invalid if it contains any content other than the address portion.
When processing a 'tel:' URI, as specified in RFC 3966 [3], Parlay X 3 Web Services MUST accept national addresses
(those not starting with '+' and a country code) and MUST accept international addresses (those starting with '+' and a
country code). When specified in the definition of a service operation, the URI may contain wildcard characters in
accordance with the appropriate specification (i.e. RFC 3966 [3] or RFC 3261 [4]).
Shortcodes are short telephone numbers, usually 4 to 6 digits in length reserved for telecom service providers' own
functionality. They shall be differentiated from national addresses by the use of a 'short:' rather than 'tel:' URI scheme.
The short code defined in the URI consists of a string of digits with no non-digit characters.
Support for aliases in addresses is provided by use of the URI defined in RFC 3986 [10]. This allows for arbitrary data
to be submitted to the Parlay X Web Service interface. The following is an example of how this could be applied:
:
An alias is generally a relatively short character string that holds a scrambled address such that only the application
identified in the URI can expand it.
5.2 Charging
Web Services may use a Web Service Provider to deliver content or function. In some cases, the producer of the content
or capability will wish to use a bill-on-behalf-of capability offered by the Web Service Provider to charge for the
content/function provided. For those services where the charge is part of a single activity, providing the charging related
information as part of the message is very efficient.
An example is a messaging service, where a sports business collects information and distributes short messages with
sports scores to its subscribers. The sports business has an agreement with a Web Service Provider where the charges
for the messages are included in the bill provided by the Web Service Provider (thus the Web Service Provider is billing
on behalf of the sports business.
To enable this capability to be provided across a variety of services in a consistent manner, thus making implementation
easy and efficient, the information to be provided in the Web Service message for charging information is defined as a
common charging data type.
5.2.1 Charging data type
The charging information is provided in an XML data type, using the following schema:
ETSI
12 ETSI ES 202 504-1 V1.1.1 (2008-05)
The application accessing the Web Service provides this information:
• Description text, which will often be used to provide billing text. This text does not have specific required
content, but would likely include information on the business, the content or service provided, and a
transaction identifier. Credit card statements are a good example of description text provided by different
companies.
• Currency in which the charge is to be applied. Values for the currency field are defined by ISO 4217 [9].
• Defines the amount to be charged.
• Code specifies a charging code which references a contract under which this charge is applied. The code
identifier is provided by the Web Service Provider.
The charging information provided may not be acceptable to the Web Service Provider. For example, the Web Service
Provider may limit the amount that may be specified for a particular Web Service or for a particular Web Service
Requester. If the information provided is not acceptable, an appropriate fault message may be returned to the Web
Service Requester (SVC0007 is defined as a generic charging fault).
5.3 Exception definition
Exceptions are defined with three data items.
The first data item is a unique identifier for the message. This allows the receiver of the message to recognize the
message easily in a language-neutral manner. Thus applications and people seeing the message do not have to
understand the message text to be able to identify the message. This is very useful for customer support as well, since it
does not depend on the reader to be able to read the language of the message.
The second data item is the message text, including placeholders (marked with %) for additional information. This form
is consistent with the form for internationalization of messages used by many technologies (operating systems,
programming environments, etc.). Use of this form enables translation of messages to different languages independent
of program changes. This is well suited for Web Services messages, as a programming language is not defined.
The third data item is a list of zero or more strings that represent the content to put in each placeholder defined in the
message in the second data item.
5.4 Service exception
When a service is not able to process a request, and retrying the request with the same information will also result in a
failure, and the issue is not related to a service policy issue, then the service will issue a fault using the
ServiceException fault message. A Service Exception uses the letters 'SVC' at the beginning of the message identifier.
Examples of service exceptions include invalid input, lack of availability of a required resource or a processing error.
5.5 Policy exception
When a service is not able to complete because the request fails to meet a policy criteria, then the service will issue a
fault using the PolicyException fault message. To clarify how a Policy Exception differs from a Service Exception,
consider that all the input to an operation may be valid as meeting the required input for the operation (thus no Service
Exception), but using that input in the execution of the service may result in conditions that require the service not to
complete. A Policy Exception uses the letters 'POL' at the beginning of the message identifier.
Examples of policy exceptions include privacy violations, requests not permitted under a governing service agreement
or input content not acceptable to the service provider.
ETSI
13 ETSI ES 202 504-1 V1.1.1 (2008-05)
6 Namespaces
The namespace for the common data types is:
• http://www.csapi.org/schema/parlayx/common/v3_1
The namespace for the common faults is:
• http://www.csapi.org/wsdl/parlayx/common/v3_0/faults
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.
7 Sequence diagrams
Not applicable.
8 XML Schema data type definition
8.1 TimeMetrics enumeration
List of time metric values.
Enumeration value Description
Millisecond Millisecond
Second Second
Minute Minute
Hour Hour
Day Day
Week Week
Month Month
Year Year
8.2 TimeMetric structure
For services that provide service based on a time interval or duration or similar metric, this type is used to specify the
time metric.
Element name Element type Optional Description
metric TimeMetrics No Metric to use for time measurement
units xsd:int No Number of units of TimeMetrics
8.3 ChargingInformation structure
For services that include charging as an inline message part, the charging information is provided in this data structure.
Element name Element type Optional Description
description xsd:string No Description text to be use for information and billing text
currency xsd:string Yes Currency identifier as defined in ISO 4217 [9]
amount xsd:decimal Yes Amount to be charged
code xsd:string Yes Charging code, referencing a contract under which the charge is
applied
ETSI
14 ETSI ES 202 504-1 V1.1.1 (2008-05)
8.4 ServiceError structure
Some services that process requests for both single addresses and group of addresses return a fault message for the
single request, and a data item for the group response. This data structure allows the data item returned for a group
response to contain the same level of information as the fault message response.
Element name Element type Optional Description
messageId xsd:string No Message identifier (take from fault definitions)
text xsd:string No Message text, with replacement variables marked with %#
variables xsd:string Yes Variables to substitute into Text string
[0.unbounded]
8.5 SimpleReference structure
For those services that require a reference to a Web Service, the information required to create the endpoint information
is contained in this type.
Element name Element type Optional Description
endpoint xsd:anyURI No Endpoint address
interfaceName xsd:string No Name of interface
correlator xsd:string No Correlation information
8.6 CallParticipantStatus enumeration
List of the status values associated with a call to a participant.
Enumeration value Description
CallParticipantInitial The call is being established to a participant
CallParticipantConnected The participant is active in the call
CallParticipantTerminated The call to the participant was terminated
8.7 CallParticipantTerminationCause enumeration
List of the termination causes associated with a call to a participant.
Enumeration value Description
CallParticipantNoAnswer The participant did not answer the call
CallParticipantBusy The participant was busy
CallParticipantNotReachable The participant was not reachable
CallParticipantHangUp The participant hung up thereby terminating the call for that party
CallParticipantAborted The call was aborted for the participant (i.e. any termination cause
other than hanging up)
ETSI
15 ETSI ES 202 504-1 V1.1.1 (2008-05)
8.8 CallParticipantInformation structure
Information about a participant in a call.
Element name Element type Optional Description
callParticipantIdentifier xsd:anyURI No Identifies an individual call participant.
callParticipantStatus CallParticipantStatus No It indicates the current status of the participant in the
call
callParticipantStartTime xsd:dateTime Yes When applicable (callParticipantStatus <>
CallParticipantInitial), it indicates the time when the
call participant was added to the call
When applicable (callParticipantStatus =
callParticipantDuration xsd:int Yes
CallParticipantTerminated), it indicates the duration
of the call participant's involvement in the call
expressed in seconds
callParticipantTermination CallParticipant Yes
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.
Loading comments...