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.

Odprti dostop do storitve (OSA) - Spletne storitve Parlay X - 1. del: Splošno (Parlay X 2)

General Information

Status
Published
Publication Date
15-Jul-2008
Current Stage
6060 - National Implementation/Publication (Adopted Project)
Start Date
19-Jun-2008
Due Date
24-Aug-2008
Completion Date
16-Jul-2008

Buy Standard

Standardization document
SIST ES 202 391-1 V1.3.1:2008
English language
31 pages
sale - 10%
Preview
sale - 10%
Preview

Standards Content (sample)

SLOVENSKI STANDARD
SIST ES 202 391-1 V1.3.1:2008
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
SIST ES 202 391-1 V1.3.1:2008 en

2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

---------------------- Page: 1 ----------------------
SIST ES 202 391-1 V1.3.1:2008
---------------------- Page: 2 ----------------------
SIST ES 202 391-1 V1.3.1:2008
ETSI ES 202 391-1 V1.3.1 (2008-05)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 1: Common
(Parlay X 2)
---------------------- Page: 3 ----------------------
SIST ES 202 391-1 V1.3.1:2008
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.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org

The present document may be made available in more than one electronic version or in print. In any case of existing or

perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).

In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive

within ETSI Secretariat.

Users of the present document should be aware that the document may be subject to revision or change of status.

Information on the current status of this and other ETSI documents is available at

http://portal.etsi.org/tb/status/status.asp

If you find errors in the present document, please send your comment to one of the following services:

http://portal.etsi.org/chaircor/ETSI_support.asp
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM

DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered

for the benefit of its Members.

3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.

ETSI
---------------------- Page: 4 ----------------------
SIST ES 202 391-1 V1.3.1:2008
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
---------------------- Page: 5 ----------------------
SIST ES 202 391-1 V1.3.1:2008
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
---------------------- Page: 6 ----------------------
SIST ES 202 391-1 V1.3.1:2008
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
---------------------- Page: 7 ----------------------
SIST ES 202 391-1 V1.3.1:2008
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
---------------------- Page: 8 ----------------------
SIST ES 202 391-1 V1.3.1:2008
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
---------------------- Page: 9 ----------------------
SIST ES 202 391-1 V1.3.1:2008
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
---------------------- Page: 10 ----------------------
SIST ES 202 391-1 V1.3.1:2008
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 Servi
...

Questions, Comments and Discussion

Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.