ETSI ES 202 504-17 V1.1.1 (2008-05)
Open Service Access (OSA); Parlay X Web Services; Part 17: Application-driven Quality of Service (QoS); (Parlay X 3)
Open Service Access (OSA); Parlay X Web Services; Part 17: Application-driven Quality of Service (QoS); (Parlay X 3)
DES/TISPAN-01034-17-OSA
Odprti dostop do storitve (OSA) - Spletne storitve Parlay X - 17. del: Aplikacijsko gnana kakovost storitve - (Parlay X 3)
General Information
Buy Standard
Standards Content (Sample)
ETSI ES 202 504-17 V1.1.1 (2008-05)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 17: Application-driven Quality of Service (QoS);
(Parlay X 3)
�
---------------------- Page: 1 ----------------------
2 ETSI ES 202 504-17 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-17-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 2 ----------------------
3 ETSI ES 202 504-17 V1.1.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 Detailed service description .8
5 Namespaces.10
6 Sequence diagrams.10
6.1 Interface Flow overview.10
7 XML Schema data type definition .12
7.1 QoSFeatureProperties structure.12
7.2 Property structure.13
7.3 QoSFeatureData structure.13
7.4 QoSStatus structure.13
7.5 TrafficClass structure.13
7.6 QoSHistory structure.14
7.7 QoSEvent enumeration.14
8 Web Service interface definition.14
8.1 Interface: ApplicationQoS.14
8.1.1 Operation: applyQoSFeature.14
8.1.1.1 Input message: applyQoSFeatureRequest.15
8.1.1.2 Output message: applyQoSFeatureResponse.15
8.1.1.3 Referenced faults.15
8.1.2 Operation: modifyQoSFeature.15
8.1.2.1 Input message: modifyQoSFeatureRequest .16
8.1.2.2 Output message: modifyQoSFeatureResponse .16
8.1.2.3 Referenced faults.16
8.1.3 Operation: removeQoSFeature.16
8.1.3.1 Input message: removeQoSFeatureRequest.16
8.1.3.2 Output message: removeQoSFeatureResponse.16
8.1.3.3 Referenced faults.17
8.1.4 Operation: getQoSStatus.17
8.1.4.1 Input message: getQoSStatusRequest .17
8.1.4.2 Output message: getQoSStatusResponse .17
8.1.4.3 Referenced Faults.17
8.1.5 Operation: getQoSHistory.17
8.1.5.1 Input message: getQoSHistoryRequest.18
8.1.5.2 Output message: getQoSHistoryResponse.18
8.1.5.3 Referenced Faults.18
8.2 Interface: ApplicationQoSNotificationManager .18
8.2.1 Operation: startQoSNotification.18
8.2.1.1 Input message: startQoSNotificationRequest.18
8.2.1.2 Output message: startQoSNotificationResponse.19
8.2.1.3 Referenced faults.19
8.2.2 Operation: stopQoSNotification.19
8.2.2.1 Input message: stopQoSNotificationRequest.19
8.2.2.2 Output message: stopQoSNotificationResponse.19
8.2.2.3 Referenced faults.19
ETSI
---------------------- Page: 3 ----------------------
4 ETSI ES 202 504-17 V1.1.1 (2008-05)
8.3 Interface: ApplicationQoSNotification.19
8.3.1 Operation: notifyQoSEvent.19
8.3.1.1 Input message: notifyQoSEventRequest.20
8.3.1.2 Output message: notifyQoSEventResponse.20
8.3.1.3 Referenced faults.20
9 Fault definitions.20
9.1 ServiceException.20
9.1.1 SVC0340: Insufficient Connection Resources.20
9.1.2 SVC0341: Unknown QoS Feature Identifier .20
9.1.3 SVC0342: End User Is Not Online.20
9.1.4 SVC0343: Specified And Existing Temporary QoS Features Conflict .20
9.1.5 SVC0344: QoS Feature Cannot Be Applied As Default.21
10 Service policies .21
Annex A (normative): WSDL for Application-driven QoS.22
Annex B (informative): Bibliography.23
History .24
ETSI
---------------------- Page: 4 ----------------------
5 ETSI ES 202 504-17 V1.1.1 (2008-05)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN).
The present document is part 17 of a multi-part deliverable covering Open Service Access (OSA); Parlay X 3 Web
Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
Part 7: "Account Management";
Part 8: "Terminal Status";
Part 9: "Terminal Location";
Part 10: "Call Handling";
Part 11: "Audio Call";
Part 12: "Multimedia Conference";
Part 13: "Address List Management";
Part 14: "Presence";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
---------------------- Page: 5 ----------------------
6 ETSI ES 202 504-17 V1.1.1 (2008-05)
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP.
The present document forms part of the Parlay X 3.0 set of specifications.
The present document is equivalent to 3GPP TS 29.199-17 V7.0.2 (Release 7).
ETSI
---------------------- Page: 6 ----------------------
7 ETSI ES 202 504-17 V1.1.1 (2008-05)
1 Scope
The present document is part 17 of the Stage 3 Parlay X 3 Web Services specification for Open Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardized interface, i.e. the OSA APIs.
The present document specifies the Application-driven Quality of Service (QoS) Web Service. The following are
defined here:
• Name spaces.
• Sequence diagrams.
• Data definitions.
• Interface specification plus detailed method descriptions.
• Fault definitions.
• Service Policies.
• WSDL Description of the interfaces.
2 References
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• Non-specific reference may be made only to a complete document or a part thereof and only in the following
cases:
- if it is accepted that it will be possible to use all future changes of the referenced document for the
purposes of the referring document;
- for informative references.
Referenced documents which are not found to be publicly available in the expected location might be found at
http://docbox.etsi.org/Reference.
For online referenced documents, information sufficient to identify and locate the source shall be provided. Preferably,
the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the
reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the
method of access to the referenced document and the full network address, with the same punctuation and use of upper
case and lower case letters.
NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee
their long term validity.
2.1 Normative references
The following referenced documents are indispensable for the application of the present document. For dated
references, only the edition cited applies. For non-specific references, the latest edition of the referenced document
(including any amendments) applies.
[1] 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: 7 ----------------------
8 ETSI ES 202 504-17 V1.1.1 (2008-05)
[2] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 504-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2] and the following apply:
ADQ Application-Driven Quality of Service
QoS Quality of Service
4 Detailed service description
'Application Driven QoS ' is a service which enables applications to dynamically change the quality of service (e.g.
bandwidth) available on end user network connections. Changes in QoS may be applied on either a temporary basis (i.e.
for a defined period of time), or as the default QoS to be applied for a user each time they connect to the network.
Applications will govern the quality of service available to the end user by requesting that pre-defined QoS Feature
profiles are applied on the end user's connection. It is the responsibility of the Service Provider to define these QoS
Features and share them beforehand with application providers, along with a clear indication as to which of these can be
used as temporary QoS Features and which can be used to set the default QoS on an end user connection.
The following scenarios provide example business use-cases to further illustrate the difference between default and
temporary QoS Features and when they may be applied by the application.
End User ISP App ADQ WS
EU wishes to Upgrade to “Broadband Gold” product
upgrade to
defaul tQ oSFeature = T rue
faster ISP
QoSFeature = DSL_8192
applyQoSFeature()
Service
offering E.g.
DSL 2048
kbps to 8192
kbps
EU QoS Profile will be
applied on a permanent
basis. I.e. each time EU
terminal attaches to
network .
Figure 4.1: Example Default QoS Feature Use-Case
Figure 4.1 provides an example of where a default QoS Feature could be applied to an end user connection. The
scenario given shows the end user of a DSL service requesting a permanent upgrade from their existing service offering
(e.g. 2048 kbps) to a higher bandwidth service (e.g. 8192 kbps). The application subsequently makes a request to the
ADQ web service to apply the pre-defined 'DSL_8192' QoS Feature to the end user connection on a permanent, or
default, basis. Following successful completion of this use-case, each time the end user's terminal equipment attaches to
their DSL service, the default QoS (in this case DSL_8192) will be applied.
ETSI
---------------------- Page: 8 ----------------------
9 ETSI ES 202 504-17 V1.1.1 (2008-05)
Video Server App
End User ADQ WS
EU wishes to Stream Video
stream a video
defaultQ oSFeature = F alse
lasting 3
applyQoSFeature() QoSFeature = Download_QoS
hours, but
requires
qosFeatureProperties:
tempor ar y
bandwidth
Duration = 180 mins
upgrade to
UpStreamSpeedRate = 256kbps
support
DownStreamSpeedRate = 4096kbps
streaming.
E.g. EU may
only have
contracted a
1Mbps DSL
service from
EU QoS Profile will be
ISP.
applied in network on a
temporary basis only (i.e.
for 3 hrs, or until user
terminates connection).
Figure 4.2: Example Temporary QoS Feature Use-Case
Figure 4.2 provides an example of where a temporary QoS Feature could be applied to an end user connection. The
scenario given shows an end user of a DSL service who wishes to stream a piece of video content. Their current service
offering (e.g. 1024 kbps DSL) however will not support video streaming and hence they require a temporary bandwidth
upgrade for the duration of the video stream. The streaming application then makes a request to the ADQ web service to
apply the pre-defined 'Download_QoS' QoS Feature to the end user connection, specifying the upstream and
downstream bandwidth rate and the duration for which the temporary QoS Feature should be applied. Assuming that the
network supports the requested bandwidth rate, the end user's bandwidth will be increased to the rate requested by the
application for the specified duration. Once the requested duration has expired, the end user's service will resume to
their original (in this example 1024 kbps bandwidth) QoS.
Figure 4.3: ADQ Web Service
ETSI
---------------------- Page: 9 ----------------------
10 ETSI ES 202 504-17 V1.1.1 (2008-05)
The ADQ service is enabled as a Web Service interface, as depicted in figure 4.3, and will accept four logical kinds of
requests from the Applications viz.:
• Requests to change the default quality of service available on the end user's connection,
• Requests to change the quality of service available on the end user's connection
...
Final draft ETSI ES 202 504-17 V1.1.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 17: Application-driven Quality of Service (QoS);
(Parlay X 3)
�
---------------------- Page: 1 ----------------------
2 Final draft ETSI ES 202 504-17 V1.1.1 (2008-02)
Reference
DES/TISPAN-01034-17-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 2 ----------------------
3 Final draft ETSI ES 202 504-17 V1.1.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 Detailed service description .8
5 Namespaces.10
6 Sequence diagrams.10
6.1 Interface Flow overview.10
7 XML Schema data type definition .12
7.1 QoSFeatureProperties structure.12
7.2 Property structure.13
7.3 QoSFeatureData structure.13
7.4 QoSStatus structure.13
7.5 TrafficClass structure.13
7.6 QoSHistory structure.14
7.7 QoSEvent enumeration.14
8 Web Service interface definition.14
8.1 Interface: ApplicationQoS.14
8.1.1 Operation: applyQoSFeature.14
8.1.1.1 Input message: applyQoSFeatureRequest.15
8.1.1.2 Output message: applyQoSFeatureResponse.15
8.1.1.3 Referenced faults.15
8.1.2 Operation: modifyQoSFeature.15
8.1.2.1 Input message: modifyQoSFeatureRequest .16
8.1.2.2 Output message: modifyQoSFeatureResponse .16
8.1.2.3 Referenced faults.16
8.1.3 Operation: removeQoSFeature.16
8.1.3.1 Input message: removeQoSFeatureRequest.16
8.1.3.2 Output message: removeQoSFeatureResponse.16
8.1.3.3 Referenced faults.17
8.1.4 Operation: getQoSStatus.17
8.1.4.1 Input message: getQoSStatusRequest .17
8.1.4.2 Output message: getQoSStatusResponse .17
8.1.4.3 Referenced Faults.17
8.1.5 Operation: getQoSHistory.17
8.1.5.1 Input message: getQoSHistoryRequest.18
8.1.5.2 Output message: getQoSHistoryResponse.18
8.1.5.3 Referenced Faults.18
8.2 Interface: ApplicationQoSNotificationManager .18
8.2.1 Operation: startQoSNotification.18
8.2.1.1 Input message: startQoSNotificationRequest.18
8.2.1.2 Output message: startQoSNotificationResponse.19
8.2.1.3 Referenced faults.19
8.2.2 Operation: stopQoSNotification.19
8.2.2.1 Input message: stopQoSNotificationRequest.19
8.2.2.2 Output message: stopQoSNotificationResponse.19
8.2.2.3 Referenced faults.19
ETSI
---------------------- Page: 3 ----------------------
4 Final draft ETSI ES 202 504-17 V1.1.1 (2008-02)
8.3 Interface: ApplicationQoSNotification.19
8.3.1 Operation: notifyQoSEvent.19
8.3.1.1 Input message: notifyQoSEventRequest.20
8.3.1.2 Output message: notifyQoSEventResponse.20
8.3.1.3 Referenced faults.20
9 Fault definitions.20
9.1 ServiceException.20
9.1.1 SVC0340: Insufficient Connection Resources.20
9.1.2 SVC0341: Unknown QoS Feature Identifier .20
9.1.3 SVC0342: End User Is Not Online.20
9.1.4 SVC0343: Specified And Existing Temporary QoS Features Conflict .20
9.1.5 SVC0344: QoS Feature Cannot Be Applied As Default.21
10 Service policies .21
Annex A (normative): WSDL for Application-driven QoS.22
Annex B (informative): Bibliography.23
History .24
ETSI
---------------------- Page: 4 ----------------------
5 Final draft ETSI ES 202 504-17 V1.1.1 (2008-02)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN), and is now submitted for the ETSI standards
Membership Approval Procedure.
The present document is part 17 of a multi-part deliverable covering Open Service Access (OSA); Parlay X 3 Web
Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
Part 7: "Account Management";
Part 8: "Terminal Status";
Part 9: "Terminal Location";
Part 10: "Call Handling";
Part 11: "Audio Call";
Part 12: "Multimedia Conference";
Part 13: "Address List Management";
Part 14: "Presence";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
---------------------- Page: 5 ----------------------
6 Final draft ETSI ES 202 504-17 V1.1.1 (2008-02)
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP.
The present document forms part of the Parlay X 3.0 set of specifications.
The present document is equivalent to 3GPP TS 29.199-17 V7.0.2 (Release 7).
ETSI
---------------------- Page: 6 ----------------------
7 Final draft ETSI ES 202 504-17 V1.1.1 (2008-02)
1 Scope
The present document is part 17 of the Stage 3 Parlay X 3 Web Services specification for Open Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardized interface, i.e. the OSA APIs.
The present document specifies the Application-driven Quality of Service (QoS) Web Service. The following are
defined here:
• Name spaces.
• Sequence diagrams.
• Data definitions.
• Interface specification plus detailed method descriptions.
• Fault definitions.
• Service Policies.
• WSDL Description of the interfaces.
2 References
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• Non-specific reference may be made only to a complete document or a part thereof and only in the following
cases:
- if it is accepted that it will be possible to use all future changes of the referenced document for the
purposes of the referring document;
- for informative references.
Referenced documents which are not found to be publicly available in the expected location might be found at
http://docbox.etsi.org/Reference.
For online referenced documents, information sufficient to identify and locate the source shall be provided. Preferably,
the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the
reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the
method of access to the referenced document and the full network address, with the same punctuation and use of upper
case and lower case letters.
NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee
their long term validity.
2.1 Normative references
The following referenced documents are indispensable for the application of the present document. For dated
references, only the edition cited applies. For non-specific references, the latest edition of the referenced document
(including any amendments) applies.
[1] 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: 7 ----------------------
8 Final draft ETSI ES 202 504-17 V1.1.1 (2008-02)
[2] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 504-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2] and the following apply:
ADQ Application-Driven Quality of Service
QoS Quality of Service
4 Detailed service description
'Application Driven QoS ' is a service which enables applications to dynamically change the quality of service (e.g.
bandwidth) available on end user network connections. Changes in QoS may be applied on either a temporary basis (i.e.
for a defined period of time), or as the default QoS to be applied for a user each time they connect to the network.
Applications will govern the quality of service available to the end user by requesting that pre-defined QoS Feature
profiles are applied on the end user's connection. It is the responsibility of the Service Provider to define these QoS
Features and share them beforehand with application providers, along with a clear indication as to which of these can be
used as temporary QoS Features and which can be used to set the default QoS on an end user connection.
The following scenarios provide example business use-cases to further illustrate the difference between default and
temporary QoS Features and when they may be applied by the application.
End User ISP App ADQ WS
EU wishes to Upgrade to “Broadband Gold” product
upgrade to
defaul tQ oSFeature = T rue
faster ISP
QoSFeature = DSL_8192
applyQoSFeature()
Service
offering E.g.
DSL 2048
kbps to 8192
kbps
EU QoS Profile will be
applied on a permanent
basis. I.e. each time EU
terminal attaches to
network .
Figure 4.1: Example Default QoS Feature Use-Case
Figure 4.1 provides an example of where a default QoS Feature could be applied to an end user connection. The
scenario given shows the end user of a DSL service requesting a permanent upgrade from their existing service offering
(e.g. 2048 kbps) to a higher bandwidth service (e.g. 8192 kbps). The application subsequently makes a request to the
ADQ web service to apply the pre-defined 'DSL_8192' QoS Feature to the end user connection on a permanent, or
default, basis. Following successful completion of this use-case, each time the end user's terminal equipment attaches to
their DSL service, the default QoS (in this case DSL_8192) will be applied.
ETSI
---------------------- Page: 8 ----------------------
9 Final draft ETSI ES 202 504-17 V1.1.1 (2008-02)
Video Server App
End User ADQ WS
EU wishes to Stream Video
stream a video
defaultQ oSFeature = F alse
lasting 3
applyQoSFeature() QoSFeature = Download_QoS
hours, but
requires
qosFeatureProperties:
tempor ar y
bandwidth
Duration = 180 mins
upgrade to
UpStreamSpeedRate = 256kbps
support
DownStreamSpeedRate = 4096kbps
streaming.
E.g. EU may
only have
contracted a
1Mbps DSL
service from
EU QoS Profile will be
ISP.
applied in network on a
temporary basis only (i.e.
for 3 hrs, or until user
terminates connection).
Figure 4.2: Example Temporary QoS Feature Use-Case
Figure 4.2 provides an example of where a temporary QoS Feature could be applied to an end user connection. The
scenario given shows an end user of a DSL service who wishes to stream a piece of video content. Their current service
offering (e.g. 1024 kbps DSL) however will not support video streaming and hence they require a temporary bandwidth
upgrade for the duration of the video stream. The streaming application then makes a request to the ADQ web service to
apply the pre-defined 'Download_QoS' QoS Feature to the end user connection, specifying the upstream and
downstream bandwidth rate and the duration for which the temporary QoS Feature should be applied. Assuming that the
network supports the requested bandwidth rate, the end user's bandwidth will be increased to the rate requested by the
application for the specified duration. Once the requested duration has expired, the end user's service will resume to
their original (in this example 1024 kbps bandwidth) QoS.
Figure 4.3: ADQ Web Service
ETSI
---------------------- Page: 9 ----------------------
10 Final draft ETSI ES 202 504-17 V1.1.1 (2008-02)
The ADQ service is enabled as a Web Service interface, as depicted in figure 4.3, and will accept four logical kinds of
requests from the Applications viz.:
• Requests to change the default quality of service available on the end user's connection,
• Requests to change the quality of service available
...
SLOVENSKI STANDARD
SIST ES 202 504-17 V1.1.1:2008
01-september-2008
Odprti dostop do storitve (OSA) - Spletne storitve Parlay X - 17. del: Aplikacijsko
gnana kakovost storitve - (Parlay X 3)
Open Service Access (OSA) - Parlay X Web Services - Part 17: Application-driven
Quality of Service (QoS) - (Parlay X 3)
Ta slovenski standard je istoveten z: ES 202 504-17 Version 1.1.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
SIST ES 202 504-17 V1.1.1:2008 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
---------------------- Page: 1 ----------------------
SIST ES 202 504-17 V1.1.1:2008
---------------------- Page: 2 ----------------------
SIST ES 202 504-17 V1.1.1:2008
ETSI ES 202 504-17 V1.1.1 (2008-05)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 17: Application-driven Quality of Service (QoS);
(Parlay X 3)
�
---------------------- Page: 3 ----------------------
SIST ES 202 504-17 V1.1.1:2008
2 ETSI ES 202 504-17 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-17-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 4 ----------------------
SIST ES 202 504-17 V1.1.1:2008
3 ETSI ES 202 504-17 V1.1.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 Detailed service description .8
5 Namespaces.10
6 Sequence diagrams.10
6.1 Interface Flow overview.10
7 XML Schema data type definition .12
7.1 QoSFeatureProperties structure.12
7.2 Property structure.13
7.3 QoSFeatureData structure.13
7.4 QoSStatus structure.13
7.5 TrafficClass structure.13
7.6 QoSHistory structure.14
7.7 QoSEvent enumeration.14
8 Web Service interface definition.14
8.1 Interface: ApplicationQoS.14
8.1.1 Operation: applyQoSFeature.14
8.1.1.1 Input message: applyQoSFeatureRequest.15
8.1.1.2 Output message: applyQoSFeatureResponse.15
8.1.1.3 Referenced faults.15
8.1.2 Operation: modifyQoSFeature.15
8.1.2.1 Input message: modifyQoSFeatureRequest .16
8.1.2.2 Output message: modifyQoSFeatureResponse .16
8.1.2.3 Referenced faults.16
8.1.3 Operation: removeQoSFeature.16
8.1.3.1 Input message: removeQoSFeatureRequest.16
8.1.3.2 Output message: removeQoSFeatureResponse.16
8.1.3.3 Referenced faults.17
8.1.4 Operation: getQoSStatus.17
8.1.4.1 Input message: getQoSStatusRequest .17
8.1.4.2 Output message: getQoSStatusResponse .17
8.1.4.3 Referenced Faults.17
8.1.5 Operation: getQoSHistory.17
8.1.5.1 Input message: getQoSHistoryRequest.18
8.1.5.2 Output message: getQoSHistoryResponse.18
8.1.5.3 Referenced Faults.18
8.2 Interface: ApplicationQoSNotificationManager .18
8.2.1 Operation: startQoSNotification.18
8.2.1.1 Input message: startQoSNotificationRequest.18
8.2.1.2 Output message: startQoSNotificationResponse.19
8.2.1.3 Referenced faults.19
8.2.2 Operation: stopQoSNotification.19
8.2.2.1 Input message: stopQoSNotificationRequest.19
8.2.2.2 Output message: stopQoSNotificationResponse.19
8.2.2.3 Referenced faults.19
ETSI
---------------------- Page: 5 ----------------------
SIST ES 202 504-17 V1.1.1:2008
4 ETSI ES 202 504-17 V1.1.1 (2008-05)
8.3 Interface: ApplicationQoSNotification.19
8.3.1 Operation: notifyQoSEvent.19
8.3.1.1 Input message: notifyQoSEventRequest.20
8.3.1.2 Output message: notifyQoSEventResponse.20
8.3.1.3 Referenced faults.20
9 Fault definitions.20
9.1 ServiceException.20
9.1.1 SVC0340: Insufficient Connection Resources.20
9.1.2 SVC0341: Unknown QoS Feature Identifier .20
9.1.3 SVC0342: End User Is Not Online.20
9.1.4 SVC0343: Specified And Existing Temporary QoS Features Conflict .20
9.1.5 SVC0344: QoS Feature Cannot Be Applied As Default.21
10 Service policies .21
Annex A (normative): WSDL for Application-driven QoS.22
Annex B (informative): Bibliography.23
History .24
ETSI
---------------------- Page: 6 ----------------------
SIST ES 202 504-17 V1.1.1:2008
5 ETSI ES 202 504-17 V1.1.1 (2008-05)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN).
The present document is part 17 of a multi-part deliverable covering Open Service Access (OSA); Parlay X 3 Web
Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
Part 7: "Account Management";
Part 8: "Terminal Status";
Part 9: "Terminal Location";
Part 10: "Call Handling";
Part 11: "Audio Call";
Part 12: "Multimedia Conference";
Part 13: "Address List Management";
Part 14: "Presence";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
---------------------- Page: 7 ----------------------
SIST ES 202 504-17 V1.1.1:2008
6 ETSI ES 202 504-17 V1.1.1 (2008-05)
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP.
The present document forms part of the Parlay X 3.0 set of specifications.
The present document is equivalent to 3GPP TS 29.199-17 V7.0.2 (Release 7).
ETSI
---------------------- Page: 8 ----------------------
SIST ES 202 504-17 V1.1.1:2008
7 ETSI ES 202 504-17 V1.1.1 (2008-05)
1 Scope
The present document is part 17 of the Stage 3 Parlay X 3 Web Services specification for Open Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardized interface, i.e. the OSA APIs.
The present document specifies the Application-driven Quality of Service (QoS) Web Service. The following are
defined here:
• Name spaces.
• Sequence diagrams.
• Data definitions.
• Interface specification plus detailed method descriptions.
• Fault definitions.
• Service Policies.
• WSDL Description of the interfaces.
2 References
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• Non-specific reference may be made only to a complete document or a part thereof and only in the following
cases:
- if it is accepted that it will be possible to use all future changes of the referenced document for the
purposes of the referring document;
- for informative references.
Referenced documents which are not found to be publicly available in the expected location might be found at
http://docbox.etsi.org/Reference.
For online referenced documents, information sufficient to identify and locate the source shall be provided. Preferably,
the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the
reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the
method of access to the referenced document and the full network address, with the same punctuation and use of upper
case and lower case letters.
NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee
their long term validity.
2.1 Normative references
The following referenced documents are indispensable for the application of the present document. For dated
references, only the edition cited applies. For non-specific references, the latest edition of the referenced document
(including any amendments) applies.
[1] 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 504-17 V1.1.1:2008
8 ETSI ES 202 504-17 V1.1.1 (2008-05)
[2] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 504-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2] and the following apply:
ADQ Application-Driven Quality of Service
QoS Quality of Service
4 Detailed service description
'Application Driven QoS ' is a service which enables applications to dynamically change the quality of service (e.g.
bandwidth) available on end user network connections. Changes in QoS may be applied on either a temporary basis (i.e.
for a defined period of time), or as the default QoS to be applied for a user each time they connect to the network.
Applications will govern the quality of service available to the end user by requesting that pre-defined QoS Feature
profiles are applied on the end user's connection. It is the responsibility of the Service Provider to define these QoS
Features and share them beforehand with application providers, along with a clear indication as to which of these can be
used as temporary QoS Features and which can be used to set the default QoS on an end user connection.
The following scenarios provide example business use-cases to further illustrate the difference between default and
temporary QoS Features and when they may be applied by the application.
End User ISP App ADQ WS
EU wishes to Upgrade to “Broadband Gold” product
upgrade to
defaul tQ oSFeature = T rue
faster ISP
QoSFeature = DSL_8192
applyQoSFeature()
Service
offering E.g.
DSL 2048
kbps to 8192
kbps
EU QoS Profile will be
applied on a permanent
basis. I.e. each time EU
terminal attaches to
network .
Figure 4.1: Example Default QoS Feature Use-Case
Figure 4.1 provides an example of where a default QoS Feature could be applied to an end user connection. The
scenario given shows the end user of a DSL service requesting a permanent upgrade from their existing service offering
(e.g. 2048 kbps) to a higher bandwidth service (e.g. 8192 kbps). The application subsequently makes a request to the
ADQ web service to apply the pre-defined 'DSL_8192' QoS Feature to the end user connection on a permanent, or
default, basis. Following successful completion of this use-case, each time the end user's terminal equipment attaches to
their DSL service, the default QoS (in this case DSL_8192) will be applied.
ETSI
---------------------- Page: 10 ----------------------
SIST ES 202 504-17 V1.1.1:2008
9 ETSI ES 202 504-17 V1.1.1 (2008-05)
Video Server App
End User ADQ WS
EU wishes to Stream Video
stream a video
defaultQ oSFeature = F alse
lasting 3
applyQoSFeature() QoSFeature = Download_QoS
hours, but
requires
qosFeatureProperties:
tempor ar y
bandwidth
Duration = 180 mins
upgrade to
UpStreamSpeedRate = 256kbps
support
DownStreamSpeedRate = 4096kbps
streaming.
E.g. EU may
only have
contracted a
1Mbps DSL
service from
EU QoS Profile will be
ISP.
applied in network on a
temporary basis only (i.e.
for 3 hrs, or until user
terminates connection).
Figure 4.2: Example Temporary QoS Feature Use-Case
Figure 4.2 provides an example of where a temporary QoS Feature could be applied to an end user connection. The
scenario given shows an end user of a DSL service who wishes to stream a piece of video content. Their current service
offering (e.g. 1024 kbps DSL) however will not support video streaming and hence they require a temporary bandwidth
upgrade for the duration of the video stream. The streaming application then makes a request to the ADQ web service to
apply the pre-defined 'Download_QoS' QoS Feature to the end user connection, specifying the upstream and
downstream bandwidth rate and the duration for which the temporary QoS Feature should be applied. Assuming that the
network supports the requested bandwidth rate, the end user's bandwidth will be increased to the rate requested by the
application for the specified duration. Once the requested duration has expired, the end user's service will resume to
their original (in this example 1024 kbps bandwidth) QoS.
Figure 4.3: ADQ Web Service
ETSI
---------------------- Page: 11 ----------------------
SIST ES 202 504-17 V1.1.1:2008
10 ETSI ES 202 504-17 V1.1.1 (2008-05)
The ADQ service is enabled as a Web Service interface, as depicted in figure 4.3, and will accept four logical kinds of
requests from the Applications viz.:
• Requests to change the default quality of service available on the end user's connection,
• Requests to change the quality of service available on the end user's connection on a temporary basis,
• Requests to manage event registrations and
• Self-care requests.
Applications can register with the service for notifications about network events that affect the quality of service
temporarily configured on the end user's connection. Whenever such events occur, the Service generates notifications to
inform Applications about the impact that these events had on the temporary QoS features set up on the end user's
connection.
Self-care requests enable Applications to view transaction history and current quality of service status.
5 Namespaces
The ApplicationQoS interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/adq/v3_0
The ApplicationQoSImpactNotificationManager interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/adq/notification_manager/v3_0
The ApplicationQoSImpactNotification uses the namespace:
http://www.csapi.org/wsdl/parlayx/adq/notification/v3_0
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/adq/v3_0
The 'xsd' namespace is used in the present document to refer to the XML Schema data types defined in
XML Schema [1]. The use of the name 'xsd' is not semantically significant.
6 Sequence diagrams
6.1 Interface Flow overview
The sequence diagrams show the interaction where the Application Provider has a Web Service compliant Application
capable of sending requests to the service and receiving notifications from the service.
Every method defined in the interface is synchronous, in the sense, that the response to the request is instantaneous and
contains the status of the request. There is no polling required on part of the Application to determine the status of a
request.
Notifications are unsolicited. The Application will indicate their interest in receiving notifications by registering for
events. When an event occurs in the network that merits a notification to be raised, interested Applications will receive
a notification and its implications on the temporary QoS features active on the end user connection.
The sequence diagrams do not show the internal logic within the server implementing this service, which is required for
processing the requests. It is assumed that such a server is capable of interacting with the network to service requests
sent by the Application.
ETSI
---------------------- Page: 12 ----------------------
SIST ES 202 504-17 V1.1.1:2008
11 ETSI ES 202 504-17 V1.1.1 (2008-05)
: Application : ADQ Web
Service
ApplyQoSFeature
Apply QoS feature to connection
Generate request identifier
Respond with request identifier and modified QoS Feature parameters
Modify temporary QoS Feature (request identifier)
Identify active temporary QoS Feature in network using request identifier
Modify active temporary QoS Feature
Acknowledgement with modified QoS Feature parameters
Remove active temporary QoS Feature (request identifier)
Identify active temporary QoS Feature in network using request identifier
Remove active temporary QoS Feature
Acknowledgement with result
Figure 6.1.1
ETSI
---------------------- Page: 13 ----------------------
SIST ES 202 504-17 V1.1.1:2008
12 ETSI ES 202 504-17 V1.1.1 (2008-05)
: Application : ADQ Web : ADQ Notification : Application Notification
Service Application Web Service
Register for QoS impact notifications
Store registration
Acknowledgement
Inform about event
Build notification with correlator
Notification with correlator
Stop notifications (correlator)
Delete registration record
Acknowledgement
Figure 6.1.2
7 XML Schema data type definition
7.1 QoSFeatureProperties structure
Element name Element type Optional Description
duration common:TimeMetric Yes e.g. “15 minutes”
upStreamSpeedRate xsd:string Yes e.g. “256 kbps”
downStreamSpeedRate xsd:string Yes e.g. “1.5 Mbps”.
otherProperties Property Yes Additional configurable properties relating to the QoS
[0.unbounded] Feature which may be specified by the service provider
and hence not defined in this specification.
ETSI
---------------------- Page: 14 ----------------------
SIST ES 202 504-17 V1.1.1:2008
13 ETSI ES 202 504-17 V1.1.1 (2008-05)
7.2 Property structure
Property with a name and value. May be used to specify service configurable QoSFeatureProperties or additional search
criteria for filtering QoS history transactions.
Element name Type Optional Description
name xsd:string No Name of property
value xsd:string No Value of property
7.3 QoSFeatureData structure
Uniquely identifies the temporary QoS feature instance that is currently active on the end user connection, and any
additional parameter values.
Element name Element type Optional Description
requestID xsd:string No Contains a unique request identifier generated by the Web
Service, which can be used by the application to identify this
specific invocation to the applyQoSFeature operation.
qoSFeatureIdentifier xsd:string No Uniquely identifies the QoS feature that was applied on a
temporary basis to the end user connection
actualProperties QoSFeatureProperties Yes Contains the current value of the configurable service
attributes. Note: Values may be altered by the service from
those stated in the original applyQoSFeature request if they
do not fit the service definition of the QoS Feature.
7.4 QoSStatus structure
The status of an end user connection, including information about the temporary QoS features that are currently
activated
Element name Element type Optional Description
userIsConnected xsd:boolean No Specifies whether the user is connected (i.e. online) or not
connected (i.e. offline)
defaultQoSFeature xsd:string Yes The default QoS feature that is currently applied to the end
Identifier user connection. Do not specify if no default feature is
applied.
trafficClasses TrafficClass Yes The traffic classes supported in this end user connection
[0.unbounded] including the speed rates that these traffic classes support.
qosFeatureStatuses QoSFeatureData Yes The array containing status of every temporary QoS feature
[0.unbounded] that is currently active on the end user connection
7.5 TrafficClass structure
Information about the traffic class supported on an end user connection
Element name Element type Optional Description
trafficClassName xsd:string No Name of the traffic class
maxUpstreamRate xsd:int No The applicable maximum speed rate in the upstream
direction for this traffic class
maxDownstreamRate xsd:int No The applicable maximum speed rate in the downstream
direction for this traffic class
ETSI
---------------------- Page: 15 ----------------------
SIST ES 202 504-17 V1.1.1:2008
14 ETSI ES 202 504-17 V1.1.1 (2008-05)
7.6 QoSHistory structure
Information about individual transactions retrieved as part of
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.