SIST ES 201 915-2 V1.4.1:2005

• Abstract:

  Maintenance update of ES 201 915-2 v.1.3.1. Updated document will also be known as Parlay 3.3. Only those parts requiring modification will be updated ( most parts require maintenance fixes )

• Status: Published
• Publication Date: 31-Dec-2004
• ICS: 33.040.01 - Telecommunication systems in general
• Technical Committee: SPN - Services and Protocols for Networks
• Current Stage: 6060 - National Implementation/Publication (Adopted Project)
• Start Date: 01-Jan-2005
• Due Date: 01-Jan-2005
• Completion Date: 01-Jan-2005
• Ref Project: ETSI ES 201 915-2 V1.4.1 (2003-07) - Open Service Access (OSA); Application Programming Interface (API); Part 2: Common Data Definitions (Parlay 3)

SIST ES 201 915-2 V1.4.1:2005 is a SIST standard identical to ETSI ES 201 915-2 Version 1.4.1 for Open Service Access (OSA); Application Programming Interface (API); Part 2: Common Data Definitions (Parlay 3). It specifies the shared data types, exception classes, and OMG IDL description used across the OSA API so applications can work with network functions through a common interface. The document is for people implementing, integrating, or checking OSA/Parlay interfaces.

What does SIST ES 201 915-2 V1.4.1:2005 specify?

SIST ES 201 915-2 V1.4.1:2005 defines the common data model for the OSA API. It covers the data definitions that are reused across the rest of the API, together with the IDL description of those definitions, so different OSA parts can share the same types, identifiers, and error handling.

The document is organized into clauses 1 to 5, followed by two annexes.

Annex	What it covers
Annex A	Normative OMG IDL description of the Common Data definitions
Annex B	Informative record of changes, split into data definitions, exceptions, and others

The scope is limited to the common definitions. The service-specific OSA parts are listed in the foreword as the other parts of ES 201 915, such as the Framework and the service capability feature parts.

What are the key requirements of SIST ES 201 915-2 V1.4.1:2005?

Common data types and data sorts

Clause 5.1 states the standard data types that the client operating system is assumed to support. SIST ES 201 915-2 V1.4.1:2005 uses types such as TpBoolean, TpInt32, TpFloat, TpLongString, TpOctet, TpString, TpAny, and the attribute-related types. In practice, this means an implementation must be able to carry these shared values consistently across OSA methods.

The document also defines identifier types that carry operational meaning. TpAssignmentID is unique within an interface instance and can be used to track or stop previously requested functions such as event notifications, while TpSessionID identifies sessions within an SCF instance. For a developer or gateway builder, that is the basis for correlating call sessions, call legs, and request lifecycles.

Structured values and implementation mapping

Clause 5.2 defines the main data sorts: sequence of data elements, tagged choice of data elements, numbered set of data elements, and reference. These are the building blocks used to express OSA structures in implementation languages and in IDL. The practical point is that many OSA values are not single primitives - they are structured records, tagged unions, or sets that must be mapped correctly in code.

Clause 5.1 also defines TpAttribute, TpAttributeType, TpAttributeList, and TpAttributeSet. TpAttribute carries a name, type, and value, and the type can include TpString, TpInt32, and TpFloat. That lets applications pass metadata and multi-valued attributes in a controlled way.

Exceptions and error reporting

Clause 5.4 defines exceptions at two levels. It first describes implicit exceptions from the underlying technology, such as invalid parameter, invalid parameter value, and parameter missing, and then defines TpCommonExceptions for OSA-wide use. It also lists exception constants that are available to all methods on all interfaces, including resources unavailable, task refused, task cancelled, method not supported, invalid state, invalid session ID, invalid address, and unknown subscriber.

This matters in practice because OSA applications have to handle both transport or runtime problems and service-level rejections. The standard gives a shared error vocabulary, so clients can react consistently across different interfaces and services.

Date, time, and intervals

Clause 5.5 specifies date and time values using ISO 8601 formatting. TpDate, TpTime, and TpDateAndTime are string-based and use fixed formats with optional UTC notation. TpDuration is measured in milliseconds, with special values for infinite duration and default duration, and TpTimeInterval combines a start time and a stop time.

For implementers, this means timestamps and intervals must be encoded in the defined textual form before they are sent through the API. That reduces ambiguity when systems schedule calls, set validity windows, or compare event times.

Address data

Clause 5.6 defines the address model used by OSA. TpAddress combines an address plan, an address string, a name, presentation and screening indicators, and an optional subaddress. TpAddressPlan distinguishes plans such as IP, E.164, URL, SMTP, X.400, SIP, and national-specific use, while TpAddressRange adds wildcard matching for address selection.

This is important for gateway and service logic because the plan determines how the address string is interpreted. TpAddressRange is especially useful for matching address groups, and TpURL is kept separate from TpAddress so that a URL used for user interaction is not treated as a general user address.

Charging and language data

Clause 5.7 covers price-related data. TpPrice carries price information as a fixed numeric string, TpAoCInfo and TpChargeAdviceInfo carry Advice Of Charge data, and TpChargePerTime carries time-based charging information. TpLanguage uses ISO 639 language strings, or an empty string when no language indication is needed.

In practice, this section supports charging displays, tariff updates, and charge advice exchanged with terminals. It gives applications a common structure for presenting or processing billing-related information.

What terms does SIST ES 201 915-2 V1.4.1:2005 define?

TpAssignmentID is an interface-instance identifier used to track requests, notifications, or later changes to a previously issued assignment. TpSessionID identifies a session within an SCF instance, such as a call session or call leg session.

TpAddressPlan identifies the numbering or address plan used by TpAddress and also shows whether an address is present at all. TpAddressRange is a matching form of address data that can use wildcards and can match an entire class of addresses.

TpCommonExceptions is the shared exception structure for all methods, carrying an exception type and extra information. TpDuration is a millisecond-based time interval with special values for infinite and default duration.

TpAoCOrder is the tagged choice that selects the charging plan representation, such as charge advice information, charge per time, or network-specific charging data. TpURL is a URL-only string type used where the application needs a URL rather than a general user address.

Who uses SIST ES 201 915-2 V1.4.1:2005?

SIST ES 201 915-2 V1.4.1:2005 is used by OSA and Parlay API developers, telecom platform and gateway vendors, and integrators who map network functions into application-facing interfaces. It is also relevant to quality and test teams that need to check data formats, address handling, charging data, and standardized exceptions. Service providers and buyers use it when they need a common data model for application access to network capabilities.

What changed in SIST ES 201 915-2 V1.4.1:2005 from the previous edition?

SIST ES 201 915-2 V1.4.1:2005 is a maintenance update of ES 201 915-2 v1.3.1 and is also known as Parlay 3.3. The scope says only the parts requiring modification were updated, with most parts receiving maintenance fixes.

Annex B records these specific changes:

• TpSessionID description updated
• TpAssignmentID description updated
• P_ADDRESS_PLAN_NATIONAL added to TpAddressPlan
• P_INVALID_STATE value modified to match IDL

Which standards are used with SIST ES 201 915-2 V1.4.1:2005?

ES 201 915-1, Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview (Parlay 3), provides the terms, definitions, and references that apply here.

ISO 8601 is used for the date and time formats in TpDate, TpTime, and TpDateAndTime. ISO-4217:1995 is used for the currency unit in TpAoCInfo. ISO 639 is used for language strings in TpLanguage. TS 122 024 is the source for the Charging Advice Information elements referenced in TpCAIElements. Annex A uses OMG IDL to provide the machine-readable representation of the common data definitions.

The foreword also states that the document is equivalent to 3GPP TS 29.198-2 V4.5.0 (Release 4), and it sits within the multi-part ES 201 915 API specification.

What does the SIST ES 201 915-2 V1.4.1:2005 document contain?

• Detailed definitions for common system data types such as TpBoolean, TpInt32, TpSessionID, TpAddress, TpPrice, and related attribute and exception types.
• Examples showing how to represent sequences, tagged choices, numbered sets, and references in implementation languages.
• Tables for address plans, presentation and screening values, address errors, and charging categories.
• ISO-based formats for dates, times, date-time values, durations, and time intervals.
• Annex A’s OMG IDL file for implementation and code generation, and Annex B’s change record for migration and review.

SLOVENSKI STANDARD
01-januar-2005
2GSUWLGRVWRSGRVWRULWYH26$±9PHVQLN]DDSOLNDFLMVNRSURJUDPLUDQMH$3,±
GHO'RORþLWHYVNXSQLKSRGDWNRY
Open Service Access (OSA); Application Programming Interface (API); Part 2: Common
Data Definitions (Parlay 3)
Ta slovenski standard je istoveten z: ES 201 915-2 Version 1.4.1
ICS:
33.040.01 Telekomunikacijski sistemi Telecommunication systems
na splošno in general
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 2: Common Data Definitions
(Parlay 3)
�
2 ETSI ES 201 915-2 V1.4.1 (2003-07)

Reference
RES/SPAN-120095-2
Keywords
API, OSA, IDL, UML
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, send your comment to:
[e-mail]
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 2003.
© The Parlay Group 2003.
All rights reserved.
TM TM TM
DECT , PLUGTESTS and UMTS are Trade Marks of ETSI registered for the benefit of its Members.
TM
TIPHON and the TIPHON logo are Trade Marks currently being registered by ETSI 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 201 915-2 V1.4.1 (2003-07)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
3 Definitions and abbreviations.6
3.1 Definitions.6
3.2 Abbreviations.6
4 Common Data Definitions.6
5 Common System Data Definitions.7
5.1 Standard Data Types .7
5.1.1 TpBoolean.7
5.1.2 TpInt32.7
5.1.3 TpFloat.7
5.1.4 TpLongString.7
5.1.5 TpOctet.7
5.1.6 TpOctetSet.7
5.1.7 TpString.7
5.1.8 TpAssignmentID.7
5.1.9 TpSessionID.7
5.1.10 TpSessionIDSet.8
5.1.11 TpAny.8
5.1.12 TpAttribute.8
5.1.13 TpAttributeType.8
5.1.14 TpAttributeList.8
5.1.15 TpAttributeSet.8
5.2 Other Data Sorts .9
5.2.1 Sequence of Data Elements .9
5.2.2 Tagged Choice of Data Elements .9
5.2.3 Numbered Set of Data Elements.9
5.2.4 Reference.10
5.3 Interface Related Data Definitions .10
5.3.1 IpInterface.10
5.3.2 IpInterfaceRef.10
5.4 Exception Classes.10
5.4.1 Underlying Technology Exceptions .10
5.4.2 TpCommonExceptions.10
5.4.3 Constants associated with TpCommonExceptions .11
5.4.4 Exceptions available to all methods on all interfaces .11
5.5 Date and Time Related Data Definitions.12
5.5.1 TpDate.12
5.5.2 TpTime.12
5.5.3 TpDateAndTime.13
5.5.4 TpDuration.13
5.5.5 TpTimeInterval.13
5.6 Address Related Data Definitions .14
5.6.1 TpAddress.14
5.6.2 TpAddressSet.15
5.6.3 TpAddressPresentation.15
5.6.4 TpAddressScreening.15
5.6.5 TpAddressPlan.15
5.6.6 TpAddressError.16
5.6.7 TpAddressRange.16
5.6.8 TpURL.17
ETSI
4 ETSI ES 201 915-2 V1.4.1 (2003-07)
5.7 Price-related Data Definitions .17
5.7.1 TpPrice.17
5.7.2 TpAoCInfo.17
5.7.3 TpAoCOrder.18
5.7.4 TpCallAoCOrderCategory.18
5.7.5 TpChargeAdviceInfo.18
5.7.6 TpCAIElements.18
5.7.7 TpChargePerTime.19
5.7.8 TpLanguage.19
Annex A (normative): OMG IDL Description of the Common Data definitions .20
Annex B (informative): Record of changes .21
B.1 Data Definitions.21
B.1.1 New.21
B.1.2 Modified.21
B.1.3 Removed.21
B.2 Exceptions.22
B.2.1 New.22
B.2.2 Modified.22
B.2.3 Removed.22
B.3 Others.22
History .23

ETSI
5 ETSI ES 201 915-2 V1.4.1 (2003-07)
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 Services and Protocols for Advanced
Networks (SPAN).
The present document is part 2 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 201 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control SCF";
Part 5: "User Interaction SCF";
Part 6: "Mobility SCF";
Part 7: "Terminal Capabilities SCF";
Part 8: "Data Session Control SCF";
Part 9: "Generic Messaging SCF";
Part 10: "Connectivity Manager SCF";
Part 11: "Account Management SCF";
Part 12: "Charging SCF".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP,
in co-operation with a number of JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 3.3 set of specifications.
The present document is equivalent to 3GPP TS 29.198-2 V4.5.0 (Release 4).
ETSI
6 ETSI ES 201 915-2 V1.4.1 (2003-07)
1 Scope
The present document is part 2 of the Stage 3 specification for an Application Programming Interface (API) for Open
Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardised interface, i.e. the OSA APIs.
The present document specifies the Common Data Definitions of the OSA. The Common Data Definitions contain
data-types that are common across the rest of the OSA API. All aspects of the Common Data are defined here, these
being:
• Data Definitions
• IDL Description of the interfaces
2 References
The references listed in clause 2 of ES 201 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 201 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 201 915-1 apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations defined in ES 201 915-1 apply.
4 Common Data Definitions
The following clauses describe each aspect of the Common data definitions.
The order is as follows:
• The Data Definitions section shows a detailed expansion of each of the data types associated with the methods
within the classes. Note that some data types are used in other methods and classes and are therefore defined
within the Common Data types part of the present document.
ETSI
7 ETSI ES 201 915-2 V1.4.1 (2003-07)
5 Common System Data Definitions
These data definitions are assumed to be provided by the client operating system.
5.1 Standard Data Types
The APIs assume that the following data types can be supported.
5.1.1 TpBoolean
Defines a Boolean data type.
5.1.2 TpInt32
Defines a signed 32-bit integer.
5.1.3 TpFloat
Defines a single precision real number
5.1.4 TpLongString
Defines a Byte string, comprising length and data. The length must be at least a 32-bit integer.
5.1.5 TpOctet
Defines an 8-bit quantity that is not translated during transmission.
5.1.6 TpOctetSet
Defines a Numbered Set of Data elements of TpOctet.
5.1.7 TpString
Defines a Byte string, comprising length and data. The length must be at least a 16-bit integer.
5.1.8 TpAssignmentID
Defines an assignment ID with a value that is unique within any instance of an implementation of a given interface,
irrespective of the method invoked on that interface instance. This ID may be used for example to identify single or
multiple event notifications enabled by a requesting interface implementation, or may be used by a requesting interface
implementation to modify or stop functionality associated with a previously supplied assignment ID, e.g. event
notifications, call load control, abort requests.
The assignment ID is identical to a TpInt32 type.
5.1.9 TpSessionID
Defines a session ID with a value that is at least unique within the context of a specific instance of an SCF. An instance
of an SCF is a single service manager instance plus the associated subordinate instances. For example, a single
MultiPartyCallControlManager instance plus all associated MultiPartyCall and MultiPartyCallLeg instances. The
session ID is used to identify different sessions (e.g. different call or call leg sessions) of an interface capable of
handling multiple sessions.
ETSI
8 ETSI ES 201 915-2 V1.4.1 (2003-07)
Example 1, myCallObject may implement the IpCall interface. If so, myCallObject may handle multiple call sessions,
and each call session will be identified by a call session ID value (e.g. 1, 2, 3) that is unique within the context of the
SCF instance.
Example 2, myCallAndCallLegObject may implement the IpCall and IpCallLeg interfaces. If so,
myCallAndCallLegObject may handle multiple call sessions and multiple call leg sessions. Each call session will be
identified by a call session ID value (e.g. 1, 2, 3) that is unique within the context of the SCF instance. Similarly, each
call leg session will be identified by a call leg session ID value (e.g. 1, 2, 3, 4, 5, 6) that is also unique within the context
of the SCF instance. Because call session IDs and call leg session IDs are different data types, overlapping values are
permitted and their uniqueness still remains.
The session ID is identical to a TpInt32 type.
5.1.10 TpSessionIDSet
Defines a Numbered Set of Data Elements of TpSessionID.
5.1.11 TpAny
Defines a type that can hold any type. This is not restricted to only the primitive types.
5.1.12 TpAttribute
This is a Sequence of Data Elements containing the attribute name, type, and value. The attribute Value is
interpreted based on the value of the attribute Type.
Sequence Element Name Sequence Element Type Notes
The name of the attribute.
AttributeName TpString
The type of the attribute. Valid values for Type must include at
AttributeType TpAttributeType
least TpString, TpInt32 and TpFloat.
The values for the attribute. This model allows multi-valued
AttributeValue TpAny
attributes. Cannot be an empty list.

5.1.13 TpAttributeType
This data type is identical to a TpString, and is defined as a string of characters that uniquely identifies the type of an
attribute. Other Network operator specific capabilities may also be used, but should be preceded by the string "SP_".
The following values are defined.
Character String Value Description
NULL
An empty (NULL) string indicates no attribute type
P_STRING
Attribute type is type TpString.
P_INT32
Attribute type is type TpInt32.
P_FLOAT Attribute type is type TpFloat.

5.1.14 TpAttributeList
This is a Numbered List of Data Elements of type TpAttribute.
5.1.15 TpAttributeSet
This is a Numbered Set of Data Elements of type TpAttribute.
ETSI
9 ETSI ES 201 915-2 V1.4.1 (2003-07)
5.2 Other Data Sorts
The APIs assumes that the following data syntaxes can be supported.
5.2.1 Sequence of Data Elements
This describes a sequence of data types. This may be defined as a structure (for example, in C++) or simply a sequence
of data elements within a structure.
Example
The TpAddress data type may be defined in C++ as:
typedef struct {
...