SIST ES 202 391-1 V1.3.1:2008

• Abstract:

  Update of ES 202 391 to become Parlay X 2.2, to cover maintenance updates.The present document is part 1 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 Common aspects of the Parlay X 2 Web Services. The following are defined here:; • Name spaces.; • Data definitions.; • Fault definitions.; • WSDL Description of the interfaces.

• Status: Published
• Publication Date: 15-Jul-2008
• ICS: 35.100.01 - Open systems interconnection in general
• 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
• Ref Project: ETSI ES 202 391-1 V1.3.1 (2008-05) - Open Service Access (OSA); Parlay X Web Services; Part 1: Common (Parlay X 2)

SIST ES 202 391-1 V1.3.1:2008 is the SIST publication of ETSI ES 202 391-1, Open Service Access (OSA) - Parlay X Web Services - Part 1: Common (Parlay X 2). It specifies the shared namespace, XML data, fault and WSDL conventions used by Parlay X 2 Web Services in the OSA API family. It is meant for application developers, Web Service providers and integrators who need the common technical layer before using the individual service parts.

What does SIST ES 202 391-1 V1.3.1:2008 specify?

SIST ES 202 391-1 V1.3.1:2008 is part 1 of the Stage 3 Parlay X 2 Web Services specification for Open Service Access (OSA). The OSA architecture lets application developers access network functionality through an open standardized interface, the OSA APIs.

The standard covers the common building blocks used across Parlay X 2 Web Services:

• namespaces
• data definitions
• fault definitions
• WSDL descriptions of the interfaces

The document is organized into clauses for scope, references, definitions, Web Services technology use, detailed service description, namespaces, XML Schema data types, WSDL interface definition, fault definitions, service policies and WSDL usage and style. Annex A contains the normative WSDL for the common data definitions.

What are the key requirements of SIST ES 202 391-1 V1.3.1:2008?

Clause 4 sets the baseline web-service technology stack. SIS T ES 202 391-1 requires SOAP, XML and HTTP messages to conform to the WS-I Basic Profile and to use document/literal encoding. In practice, implementations are expected to interoperate with standard web-service tools rather than use custom message formats.

Clause 4 also requires WSDL 1.1 for interface definitions. The standard ties WSDL usage to the WS-I Basic Profile and then expands the Parlay X 2 authoring style in clause 12. For implementers, this means the service contract is not just a schema - it is a structured set of WSDL documents with fixed conventions.

Security is defined in clause 4.3. If a message carries an identifier or credentials for the sender, they must be carried in the manner prescribed by WS-Security. If encryption is required, the document allows either a Virtual Private Network or HTTP over TLS. If integrity is required, XML Digital Signature is the method to use.

Clause 5.1 defines how addresses are handled. A Parlay X 2 Web Service must accept tel: addresses according to RFC 3966 and sip: addresses according to RFC 3261, and it also defines short: for shortcodes and RFC 3986 URIs for aliases. In practice, this gives a common way to validate addresses and a common rule for what counts as the address itself.

Clause 5.2 and clause 8.3 define the shared ChargingInformation structure. It carries description, currency, amount and code, with currency based on ISO 4217 and the code supplied by the Web Service Provider. This matters when a service supports bill-on-behalf-of charging, because the charging details travel in the request rather than in a separate process. If the data is not acceptable, the standard uses SVC0007 as the generic charging fault.

Clauses 5.3 to 5.5 and clause 10 define the fault model. ServiceException is used for service failures that will still fail if retried with the same input, while PolicyException is used when the request conflicts with policy criteria. The standard gives common message formats, prefixes SVC and POL, and defined codes such as invalid input, privacy failure, too many addresses, charging not supported and retention time interval expired. For readers, this means client software can handle faults by stable identifiers instead of parsing free text.

Clause 8 defines the shared XML Schema data types. TimeMetrics and TimeMetric support time-based services, ServiceError carries fault-like detail in group responses, and SimpleReference carries endpoint, interfaceName and correlator values for service references. These types let different Parlay X services use the same data shape for similar tasks, which simplifies client code and testing.

Clause 10.3 reserves fault number ranges by service. That gives each Parlay X 2 Web Service room for its own service-specific SVC and POL codes without conflicting with the shared codes. For implementers, this is the rule to follow when defining additional faults for a particular service part.

Clause 12 defines the WSDL style to be followed. It requires separate document types for types, shared faults, service interfaces and service bindings, with versioned namespaces and consistent naming rules. In practice, this supports reuse, tool compatibility and side-by-side versions of the same service.

What terms does SIST ES 202 391-1 V1.3.1:2008 define?

• application - a computer program that accesses a Web Service.
• SOAP - the protocol used for XML messaging.
• Web Service - a software system designed for interoperable machine-to-machine interaction over a network.
• Web Service Provider - the entity that provides Web Service interfaces to capabilities.
• Web Service Requester - the entity that operates the applications accessing the Web Services.
• OSA - Open Service Access, the architecture that exposes network functionality through standardized APIs.
• WSDL - Web Service Definition Language, used here to define service interfaces and bindings.

Who uses SIST ES 202 391-1 V1.3.1:2008?

SIST ES 202 391-1 V1.3.1:2008 is used by developers and architects building Parlay X 2 clients and servers, especially in telecommunications and network-service integration. It is also relevant to Web Service providers that expose charging, address, presence, messaging or call-related capabilities through OSA APIs.

Quality managers, testers and systems integrators use it to check WSDL structure, namespace versioning, fault handling and security choices. Buyers and technical evaluators use it to judge whether a platform follows the shared Parlay X 2 conventions before adopting service-specific parts.

What changed in SIST ES 202 391-1 V1.3.1:2008 from the previous edition?

This edition updates ES 202 391 to become Parlay X 2.2 and covers maintenance updates. The foreword places it in the Parlay X 2.2 set.

Which standards are used with SIST ES 202 391-1 V1.3.1:2008?

Reference	What it contributes
ETSI TR 121 905	Shared vocabulary used for abbreviations and telecom terms.
XML Schema Part 2: Datatypes	XML Schema datatype rules used for the schema definitions.
RFC 3966	tel: URI rules for telephone numbers.
RFC 3261	sip: URI rules for SIP addresses.
WS-I Basic Profile 1.0	Interoperability rules for SOAP, XML, HTTP and WSDL.
WSDL 1.1	The WSDL language used for interface, binding and service definitions.
WS-Security 1.0	The required way to carry identifiers and credentials.
XML-Signature Syntax and Processing	Message integrity protection when needed.
ISO 4217	Currency codes used by ChargingInformation.
RFC 3986	Generic URI syntax used for alias addresses.
ETSI ES 203 915 series	OSA API mapping companion referenced by the foreword.

The same family also includes Parts 2 to 14 for individual services such as Third Party Call, Call Notification, Short Messaging, Multimedia Messaging, Payment, Account Management, Terminal Status, Terminal Location, Call Handling, Audio Call, Multimedia Conference, Address List Management and Presence.

What does the SIST ES 202 391-1 V1.3.1:2008 document contain?

Clause 8 gives the XML Schema content for common data types, including the TimeMetrics enumeration and the TimeMetric, ChargingInformation, ServiceError and SimpleReference structures. Clause 10 gives the common ServiceException and PolicyException codes and the reserved fault ranges by service.

Clause 12 contains the WSDL authoring rules, naming rules, namespace versioning rules, document decomposition approach and document layout guidance. Annex A provides the normative WSDL text for the common data definitions in the accompanying archive, which is the part used when creating actual service interface files and bindings.

Final draft ETSI ES 202 391-1 V1.3.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 1: Common
(Parlay X 2)
�
2 Final draft ETSI ES 202 391-1 V1.3.1 (2008-02)

Reference
RES/TISPAN-01056-01-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

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-1 V1.3.1 (2008-02)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope .7
2 References .7
2.1 Normative references .7
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations .8
4 Use of Web Services technologies .9
4.1 Web Service message content .9
4.1.1 SOAP .9
4.1.2 XML .9
4.1.3 HTTP .9
4.2 Web Service interface definitions .9
4.2.1 WSDL.9
4.3 Security for Parlay X 2 Web Services .9
4.4 XML data types.9
5 Detailed service description .10
5.1 Address data items.10
5.2 Charging.10
5.2.1 Charging data type.10
5.3 Exception definition .11
5.4 Service exception .11
5.5 Policy exception .11
6 Namespaces.12
7 Sequence diagrams.12
8 XML Schema data type definition .12
8.1 TimeMetrics enumeration .12
8.2 TimeMetric structure.12
8.3 ChargingInformation structure .12
8.4 ServiceError structure.13
8.5 SimpleReference structure.13
9 Web Service interface definition.13
10 Fault definitions.13
10.1 ServiceException.13
10.1.1 SVC0001: Service error.13
10.1.2 SVC0002: Invalid input value .14
10.1.3 SVC0003: Invalid input value with list of valid values .14
10.1.4 SVC0004: No valid addresses .14
10.1.5 SVC0005: Duplicate correlator.14
10.1.6 SVC0006: Invalid group.14
10.1.7 SVC0007: Invalid charging information.14
10.1.8 SVC0008: Overlapping Criteria .14
10.2 PolicyException .15
10.2.1 POL0001: Policy error.15
10.2.2 POL0002: Privacy error.15
10.2.3 POL0003: Too many addresses .15
10.2.4 POL0004: Unlimited notifications not supported.15
10.2.5 POL0005: Too many notifications requested .15
10.2.6 POL0006: Groups not allowed .16
ETSI
4 Final draft ETSI ES 202 391-1 V1.3.1 (2008-02)
10.2.7 POL0007: Nested groups not allowed .16
10.2.8 POL0008: Charging not supported .16
10.2.9 POL0009: Invalid frequency requested .16
10.2.10 POL0010: Retention time interval expired .16
10.3 Fault number ranges by service.16
11 Service policies .17
12 WSDL usage and style .17
12.1 Service definition and documents .17
12.1.1 Interface sets .17
12.1.2 Preparing for document definition.17
12.1.3 Documents .18
12.1.3.1 Types definition document.18
12.1.3.2 Shared faults document .18
12.1.3.3 Service interface document .19
12.1.3.4 Service bindings document .19
12.1.4 Document separation rationale .19
12.1.5 Document version identifier .19
12.1.6 Document naming example .20
12.1.7 Service definitions for notification patterns.20
12.2 Namespaces.20
12.2.1 Namespaces for Parlay X 2 Web Services.21
12.2.2 Use of namespaces.21
12.2.3 Namespace elements.21
12.2.4 Namespace usage.21
12.2.4.1 Why namespace versions are used .21
12.2.4.2 When namespace versions are changed .22
12.2.4.3 Benefit of managing namespace versions .22
12.2.5 Common namespaces .22
12.2.6 Target namespace .22
12.2.7 WSDL and Schema namespaces.23
12.2.8 Local namespace use .23
12.2.9 Examples .23
12.3 Authoring style - Document content and names.24
12.3.1 General WSDL document information.24
12.3.2 Names .24
12.3.3 Case usage for names.24
12.3.4 Naming conventions for special names .25
12.3.5 Document layout.25
12.4 Data type definitions .25
12.4.1 Types section declaration.25
12.4.1.1 Optional elements .26
12.4.1.2 Nillable elements.26
12.4.1.3 User defined simple data types.26
12.4.1.4 Data structures.26
12.4.1.5 Enumerations .26
12.4.1.6 Unions .27
12.4.1.7 Web Service references.27
12.5 Messages and interfaces (PortTypes) .27
12.5.1 Messages.27
12.5.1.1 Document style Web Services.28
12.5.2 Interfaces (PortTypes).28
12.5.3 Faults (Exceptions) .28
12.6 Bindings and service definitions .29
12.6.1 Binding .29
12.6.2 Service definition.29
History .31

ETSI
5 Final draft ETSI ES 202 391-1 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 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".
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-01 V6.6.0 (Release 6).
The Mapping specification of the Parlay X 2 Web Services (ES 202 391) 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 2 Web Services is however not
applicable for all parts (e.g. part 13), but the numbering of parts is kept.
ETSI
6 Final draft ETSI ES 202 391-1 V1.3.1 (2008-02)
Table 1: Overview of the Parlay X 2 Web Services and OSA APIs mappings
Parlay X 2 Web Services OSA APIs (and IMS) mappings
(ES 202 391 series) (TR 102 397 series)
ES 202 391-01 Common TR 102 397-01 Common mapping
ES 202 391-02 Third party call TR 102 397-02-1 Generic Call Control mapping
TR 102 397-02-2 Multi-Party Call Control mapping
ES 202 391-03 Call notification TR 102 397-03-1 Generic Call Control mapping
TR 102 397-03-2 Multi-Party Call Control mapping
ES 202 391-04 Short messaging TR 102 397-04-1 User Interaction mapping
TR 102 397-04-2 Multi-Media Messaging mapping
ES 202 391-05 Multimedia messaging TR 102 397-05-1 User Interaction mapping
TR 102 397-05-2 Multi-Media Messaging mapping
ES 202 391-06 Payment TR 102 397-06 Charging mapping
ES 202 391-07 Account management TR 102 397-07 Account Management mapping
ES 202 391-08 Terminal status TR 102 397-08 Mobility User Status mapping
ES 202 391-09 Terminal location TR 102 397-09-1 Mobility User Location mapping
TR 102 397-09-2 Mobility User Location CAMEL mapping
ES 202 391-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 391-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 391-12 Multimedia conference TR 102 397-12 Multi-Media Call Control mapping
ES 202 391-13 Address list TR 102 397-13 Not Applicable
management
ES 202 391-14 Presence TR 102 397-14-1 Presence & Availability Management mapping
TR 102 397-14-2 SIP/IMS Networks mapping

ETSI
7 Final draft ETSI ES 202 391-1 V1.3.1 (2008-02)
1 Scope
The present document is part 1 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 Common aspects of the Parlay X 2 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/.
ETSI
8 Final draft ETSI ES 202 391-1 V1.3.1 (2008-02)
[3] IETF RFC 3966: "The tel URI for Telephone Numbers".
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 (series): "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
ETSI
9 Final draft ETSI ES 202 391-1 V1.3.1 (2008-02)
URI Uniform Resource Identifier
W3C World Wide Web Consortium
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 2 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 2 Web Services.
4.3 Security for Parlay X 2 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
10 Final draft ETSI ES 202 391-1 V1.3.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 2 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 2 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
11 Final draft ETSI ES 202 391-1 V1.3.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
12 Final draft ETSI ES 202 391-1 V1.3.1 (2008-02)
6 Namespaces
The namespace for the common data types is:
• http://www.csapi.org/schema/parlayx/common/v2_1
The namespace for the common faults is:
• http://www.csapi.org/wsdl/parlayx/common/v2_1/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
13 Final draft ETSI ES 202 391-1 V1.3.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

9 Web Service interface definition
Not applicable.
10 Fault definitions
10.1 ServiceException
Faults related to the operation of the service, not including policy related faults, result in the return of a
ServiceException message. Service exception messages use the reserved message identifier "SVC", and are defined
with numbers from 0001 to 0999, with numbers 0001 to 0199 reserved for common exceptions and 0200 to 0999 for
Parlay X 2 Web Services specification use. Numbers from "1000" to "9999" may be used by third parties.
Element name Element type Optional Description
messageId xsd:string No Message identifier, with prefix SVC
text xsd:string No Message text, with replacement variables marked with %#
variables xsd:string Yes Variables to substitute into Text string
[0.unbounded]
10.1.1 SVC0001: Service error
Element name Description
messageId SVC0001
text A service error occurred. Error code is %1
variables %1 Error code from service - meaningful to support, and may be documented in
product documentation
ETSI
14 Final draft ETSI ES 202 391-1 V1.3.1 (2008-02)
10.1.2 SVC0002: Invalid input value
Element name Description
messageId SVC0002
text Invalid input value for message part %1
variables %1 - message part
10.1.3 SVC0003: Invalid input value with list of valid values
Element name Description
messageId SVC0003
text Invalid input value for message part %1, valid values are %2
variables %1 - message part
%2 - list of valid values
10.1.4 SVC0004: No valid addresses
Element name Description
messageId SVC0004
text No valid addresses provided in message part %1
variables %1 - message part
10.1.5 SVC0005: Duplicate correlator
Element name Description
messageId SVC0005
text Correlator %1 specified in message part %2 is a duplicate
variables %1 - correlator
%2 - message part
10.1.6 SVC0006: Invalid group
Element name Description
messageId SVC0006
text Group %1 in message part %2 is not a valid group
variables %1 - identifier for the invalid group
%2 - message part
10.1.7 SVC0007: Invalid charging information
Element name Description
messageId SVC0007
text Invalid charging information
variables None
10.1.8 SVC0008: Overlapping Criteria
Name Description
message Id SVC0008
text Overlapped Criteria %1
variables %1 Message part with the overlapped criteria

ETSI
15 Final draft ETSI ES 202 391-1 V1.3.1 (2008-02)
10.2 PolicyException
Faults related to policies associated with the service, result in the return of a PolicyException message. Policy exception
messages use the reserved message identifier "POL", and are defined with numbers from 0001 to 0999, with numbers
0001 to 0199 reserved for common exceptions and 0200 to 0999 for Parlay X 2 Web Services specification use.
Numbers from "1000" to "9999" may be used by third parties.
Element name Element type Optional Description
messageId xsd:string No Message identifier, with prefix POL
text xsd:string No Message text, with replacement variables marked with %#
variables xsd:string Yes Variables to substitute into Text string
[0.unbounded]
10.2.1 POL0001: Policy error
Element name Description
messageId POL0001
text A policy error occurred. Error code is %1
variables %1 Error code from service - meaningful to support, and may be documented in
product documentation
10.2.2 POL0002: Privacy error
Element name Description
messageId POL0002
text Privacy verification failed for address %1, request is refused
variables %1 - address privacy verification failed for

10.2.3 POL0003: Too many addresses
Element name Description
messageId POL0003
text Too many addresses specified in message part %1
variables %1 - message part
10.2.4 POL0004: Unlimited notifications not supported
Element name Description
messageId POL0004
text Unlimited notification request not supported
variables None
10.2.5 POL0005: Too many notifications requested
Element name Description
messageId POL0005
text Too many notifications requested
variables None
ETSI
16 Final draft ETSI ES 202 391-1 V1.3.1 (2008-02)
10.2.6 POL0006: Groups not allowed
Element name Description
messageId POL0006
text Group specified in message part %1 not allowed
variables %1 - message part
10.2.7 POL0007: Nested groups not allowed
Element name Description
messageId POL0007
text Nested group specified in message part %1 not allowed
variables %1 - message part
10.2.8 POL0008: Charging not supported
Element name Description
messageId POL0008
text Charging is not supported
variables None
10.2.9 POL0009: Invalid frequency requested
Element name Description
messageId POL0009
tex
...

ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 1: Common
(Parlay X 2)
�
2 ETSI ES 202 391-1 V1.3.1 (2008-05)

Reference
RES/TISPAN-01056-01-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

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-1 V1.3.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.7
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Use of Web Services technologies .9
4.1 Web Service message content .9
4.1.1 SOAP.9
4.1.2 XML.9
4.1.3 HTTP.9
4.2 Web Service interface definitions .9
4.2.1 WSDL.9
4.3 Security for Parlay X 2 Web Services .9
4.4 XML data types.9
5 Detailed service description .10
5.1 Address data items.10
5.2 Charging.10
5.2.1 Charging data type.10
5.3 Exception definition.11
5.4 Service exception .11
5.5 Policy exception .11
6 Namespaces.12
7 Sequence diagrams.12
8 XML Schema data type definition .12
8.1 TimeMetrics enumeration.12
8.2 TimeMetric structure.12
8.3 ChargingInformation structure.12
8.4 ServiceError structure.13
8.5 SimpleReference structure.13
9 Web Service interface definition.13
10 Fault definitions.13
10.1 ServiceException.13
10.1.1 SVC0001: Service error.13
10.1.2 SVC0002: Invalid input value .14
10.1.3 SVC0003: Invalid input value with list of valid values .14
10.1.4 SVC0004: No valid addresses .14
10.1.5 SVC0005: Duplicate correlator.14
10.1.6 SVC0006: Invalid group.14
10.1.7 SVC0007: Invalid charging information.14
10.1.8 SVC0008: Overlapping Criteria .14
10.2 PolicyException.15
10.2.1 POL0001: Policy error.15
10.2.2 POL0002: Privacy error.15
10.2.3 POL0003: Too many addresses .15
10.2.4 POL0004: Unlimited notifications not supported.15
10.2.5 POL0005: Too many notifications requested .15
10.2.6 POL0006: Groups not allowed .16
ETSI
4 ETSI ES 202 391-1 V1.3.1 (2008-05)
10.2.7 POL0007: Nested groups not allowed .16
10.2.8 POL0008: Charging not supported .16
10.2.9 POL0009: Invalid frequency requested .16
10.2.10 POL0010: Retention time interval expired .16
10.3 Fault number ranges by service.16
11 Service policies .17
12 WSDL usage and style .17
12.1 Service definition and documents .17
12.1.1 Interface sets.17
12.1.2 Preparing for document definition.17
12.1.3 Documents.18
12.1.3.1 Types definition document.18
12.1.3.2 Shared faults document .18
12.1.3.3 Service interface document .19
12.1.3.4 Service bindings document .19
12.1.4 Document separation rationale .19
12.1.5 Document version identifier.19
12.1.6 Document naming example.20
12.1.7 Service definitions for notification patterns.20
12.2 Namespaces.20
12.2.1 Namespaces for Parlay X 2 Web Services.21
12.2.2 Use of namespaces.21
12.2.3 Namespace elements.21
12.2.4 Namespace usage.21
12.2.4.1 Why namespace versions are used .21
12.2.4.2 When namespace versions are changed .22
12.2.4.3 Benefit of managing namespace versions .22
12.2.5 Common namespaces.22
12.2.6 Target namespace.22
12.2.7 WSDL and Schema namespaces.23
12.2.8 Local namespace use.23
12.2.9 Examples.23
12.3 Authoring style - Document content and names.24
12.3.1 General WSDL document information.24
12.3.2 Names.24
12.3.3 Case usage for names.24
12.3.4 Naming conventions for special names .25
12.3.5 Document layout.25
12.4 Data type definitions .25
12.4.1 Types section declaration.25
12.4.1.1 Optional elements.26
12.4.1.2 Nillable elements.26
12.4.1.3 User defined simple data types.26
12.4.1.4 Data structures.26
12.4.1.5 Enumerations .26
12.4.1.6 Unions.27
12.4.1.7 Web Service references.27
12.5 Messages and interfaces (PortTypes) .27
12.5.1 Messages.27
12.5.1.1 Document style Web Services.28
12.5.2 Interfaces (PortTypes).28
12.5.3 Faults (Exceptions).28
12.6 Bindings and service definitions .29
12.6.1 Binding.29
12.6.2 Service definition.29
Annex A (normative): WSDL for common data definitions .30
History .31

ETSI
5 ETSI ES 202 391-1 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 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".
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-01 V6.6.0 (Release 6).
The Mapping specification of the Parlay X 2 Web Services (ES 202 391) 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 2 Web Services is however not
applicable for all parts (e.g. part 13), but the numbering of parts is kept.
ETSI
6 ETSI ES 202 391-1 V1.3.1 (2008-05)
Table 1: Overview of the Parlay X 2 Web Services and OSA APIs mappings
Parlay X 2 Web Services OSA APIs (and IMS) mappings
(ES 202 391 series) (TR 102 397 series)
ES 202 391-01 Common TR 102 397-01 Common mapping
ES 202 391-02 Third party call TR 102 397-02-1 Generic Call Control mapping
TR 102 397-02-2 Multi-Party Call Control mapping
ES 202 391-03 Call notification TR 102 397-03-1 Generic Call Control mapping
TR 102 397-03-2 Multi-Party Call Control mapping
ES 202 391-04 Short messaging TR 102 397-04-1 User Interaction mapping
TR 102 397-04-2 Multi-Media Messaging mapping
ES 202 391-05 Multimedia messaging TR 102 397-05-1 User Interaction mapping
TR 102 397-05-2 Multi-Media Messaging mapping
ES 202 391-06 Payment TR 102 397-06 Charging mapping
ES 202 391-07 Account management TR 102 397-07 Account Management mapping
ES 202 391-08 Terminal status TR 102 397-08 Mobility User Status mapping
ES 202 391-09 Terminal location TR 102 397-09-1 Mobility User Location mapping
TR 102 397-09-2 Mobility User Location CAMEL mapping
ES 202 391-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 391-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 391-12 Multimedia conference TR 102 397-12 Multi-Media Call Control mapping
ES 202 391-13 Address list TR 102 397-13 Not Applicable
management
ES 202 391-14 Presence TR 102 397-14-1 Presence & Availability Management mapping
TR 102 397-14-2 SIP/IMS Networks mapping

ETSI
7 ETSI ES 202 391-1 V1.3.1 (2008-05)
1 Scope
The present document is part 1 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 Common aspects of the Parlay X 2 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/.
ETSI
8 ETSI ES 202 391-1 V1.3.1 (2008-05)
[3] IETF RFC 3966: "The tel URI for Telephone Numbers".
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 (series): "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
ETSI
9 ETSI ES 202 391-1 V1.3.1 (2008-05)
URI Uniform Resource Identifier
W3C World Wide Web Consortium
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 2 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 2 Web Services.
4.3 Security for Parlay X 2 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
10 ETSI ES 202 391-1 V1.3.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 2 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 2 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
11 ETSI ES 202 391-1 V1.3.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
12 ETSI ES 202 391-1 V1.3.1 (2008-05)
6 Namespaces
The namespace for the common data types is:
• http://www.csapi.org/schema/parlayx/common/v2_1
The namespace for the common faults is:
• http://www.csapi.org/wsdl/parlayx/common/v2_1/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
13 ETSI ES 202 391-1 V1.3.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

9 Web Service interface definition
Not applicable.
10 Fault definitions
10.1 ServiceException
Faults related to the operation of the service, not including policy related faults, result in the return of a
ServiceException message. Service exception messages use the reserved message identifier "SVC", and are defined
with numbers from 0001 to 0999, with numbers 0001 to 0199 reserved for common exceptions and 0200 to 0999 for
Parlay X 2 Web Services specification use. Numbers from "1000" to "9999" may be used by third parties.
Element name Element type Optional Description
messageId xsd:string No Message identifier, with prefix SVC
text xsd:string No Message text, with replacement variables marked with %#
variables xsd:string Yes Variables to substitute into Text string
[0.unbounded]
10.1.1 SVC0001: Service error
Element name Description
messageId SVC0001
text A service error occurred. Error code is %1
variables %1 Error code from service - meaningful to support, and may be documented in
product documentation
ETSI
14 ETSI ES 202 391-1 V1.3.1 (2008-05)
10.1.2 SVC0002: Invalid input value
Element name Description
messageId SVC0002
text Invalid input value for message part %1
variables %1 - message part
10.1.3 SVC0003: Invalid input value with list of valid values
Element name Description
messageId SVC0003
text Invalid input value for message part %1, valid values are %2
variables %1 - message part
%2 - list of valid values
10.1.4 SVC0004: No valid addresses
Element name Description
messageId SVC0004
text No valid addresses provided in message part %1
variables %1 - message part
10.1.5 SVC0005: Duplicate correlator
Element name Description
messageId SVC0005
text Correlator %1 specified in message part %2 is a duplicate
variables %1 - correlator
%2 - message part
10.1.6 SVC0006: Invalid group
Element name Description
messageId SVC0006
text Group %1 in message part %2 is not a valid group
variables %1 - identifier for the invalid group
%2 - message part
10.1.7 SVC0007: Invalid charging information
Element name Description
messageId SVC0007
text Invalid charging information
variables None
10.1.8 SVC0008: Overlapping Criteria
Name Description
message Id SVC0008
text Overlapped Criteria %1
variables %1 Message part with the overlapped criteria

ETSI
15 ETSI ES 202 391-1 V1.3.1 (2008-05)
10.2 PolicyException
Faults related to policies associated with the service, result in the return of a PolicyException message. Policy exception
messages use the reserved message identifier "POL", and are defined with numbers from 0001 to 0999, with numbers
0001 to 0199 reserved for common exceptions and 0200 to 0999 for Parlay X 2 Web Services specification use.
Numbers from "1000" to "9999" may be used by third parties.
Element name Element type Optional Description
messageId xsd:string No Message identifier, with prefix POL
text xsd:string No Message text, with replacement variables marked with %#
variables xsd:string Yes Variables to substitute into Text string
[0.unbounded]
10.2.1 POL0001: Policy error
Element name Description
messageId POL0001
text A policy error occurred. Error code is %1
variables %1 Error code from service - meaningful to support, and may be documented in
product documentation
10.2.2 POL0002: Privacy error
Element name Description
messageId POL0002
text Privacy verification failed for address %1, request is refused
variables %1 - address privacy verification failed for

10.2.3 POL0003: Too many addresses
Element name Description
messageId POL0003
text Too many addresses specified in message part %1
variables %1 - message part
10.2.4 POL0004: Unlimited notifications not supported
Element name Description
messageId POL0004
text Unlimited notification request not supported
variables None
10.2.5 POL0005: Too many notifications requested
Element name Description
messageId POL0005
text Too many notifications requested
variables None
ETSI
16 ETSI ES 202 391-1 V1.3.1 (2008-05)
10.2.6 POL0006: Groups not allowed
Element name Description
messageId POL0006
text Group specified in message part %1 not allowed
variables %1 - message part
10.2.7 POL0007: Nested groups not allowed
Element name Description
messageId POL0007
text Nested group specified in message part %1 not allowed
variables %1 - message part
10.2.8 POL0008: Charging not supported
Element name Description
messageId POL0008
text Charging is not supported
variables None
10.2.9 POL0009: Invalid frequency requested
Element name Description
messageId POL0009
text Invalid frequency requested
variables None
10.2.10 POL0010: Retention time interval expired
Element name Description
messageId POL0010
text Requested information una
...

SLOVENSKI STANDARD
01-september-2008
Odprti dostop do storitve (OSA) - Spletne storitve Parlay X - 1. del: Splošno (Parlay
X 2)
Open Service Access (OSA) - Parlay X Web Services - Part 1: Common (Parlay X 2)
Ta slovenski standard je istoveten z: ES 202 391-1 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 1: Common
(Parlay X 2)
�
2 ETSI ES 202 391-1 V1.3.1 (2008-05)

Reference
RES/TISPAN-01056-01-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

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-1 V1.3.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.7
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Use of Web Services technologies .9
4.1 Web Service message content .9
4.1.1 SOAP.9
4.1.2 XML.9
4.1.3 HTTP.9
4.2 Web Service interface definitions .9
4.2.1 WSDL.9
4.3 Security for Parlay X 2 Web Services .9
4.4 XML data types.9
5 Detailed service description .10
5.1 Address data items.10
5.2 Charging.10
5.2.1 Charging data type.10
5.3 Exception definition.11
5.4 Service exception .11
5.5 Policy exception .11
6 Namespaces.12
7 Sequence diagrams.12
8 XML Schema data type definition .12
8.1 TimeMetrics enumeration.12
8.2 TimeMetric structure.12
8.3 ChargingInformation structure.12
8.4 ServiceError structure.13
8.5 SimpleReference structure.13
9 Web Service interface definition.13
10 Fault definitions.13
10.1 ServiceException.13
10.1.1 SVC0001: Service error.13
10.1.2 SVC0002: Invalid input value .14
10.1.3 SVC0003: Invalid input value with list of valid values .14
10.1.4 SVC0004: No valid addresses .14
10.1.5 SVC0005: Duplicate correlator.14
10.1.6 SVC0006: Invalid group.14
10.1.7 SVC0007: Invalid charging information.14
10.1.8 SVC0008: Overlapping Criteria .14
10.2 PolicyException.15
10.2.1 POL0001: Policy error.15
10.2.2 POL0002: Privacy error.15
10.2.3 POL0003: Too many addresses .15
10.2.4 POL0004: Unlimited notifications not supported.15
10.2.5 POL0005: Too many notifications requested .15
10.2.6 POL0006: Groups not allowed .16
ETSI
4 ETSI ES 202 391-1 V1.3.1 (2008-05)
10.2.7 POL0007: Nested groups not allowed .16
10.2.8 POL0008: Charging not supported .16
10.2.9 POL0009: Invalid frequency requested .16
10.2.10 POL0010: Retention time interval expired .16
10.3 Fault number ranges by service.16
11 Service policies .17
12 WSDL usage and style .17
12.1 Service definition and documents .17
12.1.1 Interface sets.17
12.1.2 Preparing for document definition.17
12.1.3 Documents.18
12.1.3.1 Types definition document.18
12.1.3.2 Shared faults document .18
12.1.3.3 Service interface document .19
12.1.3.4 Service bindings document .19
12.1.4 Document separation rationale .19
12.1.5 Document version identifier.19
12.1.6 Document naming example.20
12.1.7 Service definitions for notification patterns.20
12.2 Namespaces.20
12.2.1 Namespaces for Parlay X 2 Web Services.21
12.2.2 Use of namespaces.21
12.2.3 Namespace elements.21
12.2.4 Namespace usage.21
12.2.4.1 Why namespace versions are used .21
12.2.4.2 When namespace versions are changed .22
12.2.4.3 Benefit of managing namespace versions .22
12.2.5 Common namespaces.22
12.2.6 Target namespace.22
12.2.7 WSDL and Schema namespaces.23
12.2.8 Local namespace use.23
12.2.9 Examples.23
12.3 Authoring style - Document content and names.24
12.3.1 General WSDL document information.24
12.3.2 Names.24
12.3.3 Case usage for names.24
12.3.4 Naming conventions for special names .25
12.3.5 Document layout.25
12.4 Data type definitions .25
12.4.1 Types section declaration.25
12.4.1.1 Optional elements.26
12.4.1.2 Nillable elements.26
12.4.1.3 User defined simple data types.26
12.4.1.4 Data structures.26
12.4.1.5 Enumerations .26
12.4.1.6 Unions.27
12.4.1.7 Web Service references.27
12.5 Messages and interfaces (PortTypes) .27
12.5.1 Messages.27
12.5.1.1 Document style Web Services.28
12.5.2 Interfaces (PortTypes).28
12.5.3 Faults (Exceptions).28
12.6 Bindings and service definitions .29
12.6.1 Binding.29
12.6.2 Service definition.29
Annex A (normative): WSDL for common data definitions .30
History .31

ETSI
5 ETSI ES 202 391-1 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 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".
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-01 V6.6.0 (Release 6).
The Mapping specification of the Parlay X 2 Web Services (ES 202 391) 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 2 Web Services is however not
applicable for all parts (e.g. part 13), but the numbering of parts is kept.
ETSI
6 ETSI ES 202 391-1 V1.3.1 (2008-05)
Table 1: Overview of the Parlay X 2 Web Services and OSA APIs mappings
Parlay X 2 Web Services OSA APIs (and IMS) mappings
(ES 202 391 series) (TR 102 397 series)
ES 202 391-01 Common TR 102 397-01 Common mapping
ES 202 391-02 Third party call TR 102 397-02-1 Generic Call Control mapping
TR 102 397-02-2 Multi-Party Call Control mapping
ES 202 391-03 Call notification TR 102 397-03-1 Generic Call Control mapping
TR 102 397-03-2 Multi-Party Call Control mapping
ES 202 391-04 Short messaging TR 102 397-04-1 User Interaction mapping
TR 102 397-04-2 Multi-Media Messaging mapping
ES 202 391-05 Multimedia messaging TR 102 397-05-1 User Interaction mapping
TR 102 397-05-2 Multi-Media Messaging mapping
ES 202 391-06 Payment TR 102 397-06 Charging mapping
ES 202 391-07 Account management TR 102 397-07 Account Management mapping
ES 202 391-08 Terminal status TR 102 397-08 Mobility User Status mapping
ES 202 391-09 Terminal location TR 102 397-09-1 Mobility User Location mapping
TR 102 397-09-2 Mobility User Location CAMEL mapping
ES 202 391-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 391-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 391-12 Multimedia conference TR 102 397-12 Multi-Media Call Control mapping
ES 202 391-13 Address list TR 102 397-13 Not Applicable
management
ES 202 391-14 Presence TR 102 397-14-1 Presence & Availability Management mapping
TR 102 397-14-2 SIP/IMS Networks mapping

ETSI
7 ETSI ES 202 391-1 V1.3.1 (2008-05)
1 Scope
The present document is part 1 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 Common aspects of the Parlay X 2 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/.
ETSI
8 ETSI ES 202 391-1 V1.3.1 (2008-05)
[3] IETF RFC 3966: "The tel URI for Telephone Numbers".
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 (series): "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
ETSI
9 ETSI ES 202 391-1 V1.3.1 (2008-05)
URI Uniform Resource Identifier
W3C World Wide Web Consortium
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 2 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 2 Web Services.
4.3 Security for Parlay X 2 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
10 ETSI ES 202 391-1 V1.3.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 2 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 2 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
11 ETSI ES 202 391-1 V1.3.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
12 ETSI ES 202 391-1 V1.3.1 (2008-05)
6 Namespaces
The namespace for the common data types is:
• http://www.csapi.org/schema/parlayx/common/v2_1
The namespace for the common faults is:
• http://www.csapi.org/wsdl/parlayx/common/v2_1/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
13 ETSI ES 202 391-1 V1.3.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

9 Web Service interface definition
Not applicable.
10 Fault definitions
10.1 ServiceException
Faults related to the operation of the service, not including policy related faults, result in the return of a
ServiceException message. Service exception messages use the reserved message identifier "SVC", and are defined
with numbers from 0001 to 0999, with numbers 0001 to 0199 reserved for common exceptions and 0200 to 0999 for
Parlay X 2 Web Services specification use. Numbers from "1000" to "9999" may be used by third parties.
Element name Element type Optional Description
messageId xsd:string No Message identifier, with prefix SVC
text xsd:string No Message text, with replacement variables marked with %#
variables xsd:string Yes Variables to substitute into Text string
[0.unbounded]
10.1.1 SVC0001: Service error
Element name Description
messageId SVC0001
text A service error occurred. Error code is %1
variables %1 Error code from service - meaningful to support, and may be documented in
product documentation
ETSI
14 ETSI ES 202 391-1 V1.3.1 (2008-05)
10.1.2 SVC0002: Invalid input value
Element name Description
messageId SVC0002
text Invalid input value for message part %1
variables %1 - message part
10.1.3 SVC0003: Invalid input value with list of valid values
Element name Description
messageId SVC0003
text Invalid input value for message part %1, valid values are %2
variables %1 - message part
%2 - list of valid values
10.1.4 SVC0004: No valid addresses
Element name Description
messageId SVC0004
text No valid addresses provided in message part %1
variables %1 - message part
10.1.5 SVC0005: Duplicate correlator
Element name Description
messageId SVC0005
text Correlator %1 specified in message part %2 is a duplicate
variables %1 - correlator
%2 - message part
10.1.6 SVC0006: Invalid group
Element name Description
messageId SVC0006
text Group %1 in message part %2 is not a valid group
variables %1 - identifier for the invalid group
%2 - message part
10.1.7 SVC0007: Invalid charging information
Element name Description
messageId SVC0007
text Invalid charging information
variables None
10.1.8 SVC0008: Overlapping Criteria
Name Description
message Id SVC0008
text Overlapped Criteria %1
variables %1 Message part with the overlapped criteria

ETSI
15 ETSI ES 202 391-1 V1.3.1 (2008-05)
10.2 PolicyException
Faults related to policies associated with the service, result in the return of a PolicyException message. Policy exception
messages use the reserved message identifier "POL", and are defined with numbers from 0001 to 0999, with numbers
0001 to 0199 reserved for common exceptions and 0200 to 0999 for Parlay X 2 Web Services specification use.
Numbers from "1000" to "9999" may be used by third parties.
Element name Element type Optional Description
messageId xsd:string No Message identifier, with prefix POL
text xsd:string No Message text, with replacement variables marked with %#
variables xsd:string Yes Variables to substitute into Text string
[0.unbounded]
10.2.1 POL0001: Policy error
Element name Description
messageId POL0001
text A policy error occurred. Error code is %1
variables %1 Error code from service - meaningful to support, and may be documented in
product documentation
10.2.2 POL0002: Privacy error
Element name Description
messageId POL0002
text Privacy verification failed for address %1, request is refused
variables %1 - address privacy verification failed for

10.2.3 POL0003: Too many addresses
Element name Description
messageId POL0003
text Too many addresses specified in messag
...