ETSI ES V1.3.1 ( ) ETSI Standard. Open Service Access (OSA); Parlay X Web Services; Part 13: Address List Management (Parlay X 2)

Átírás

1 Standard Open Service Access (OSA); Parlay X Web Services; Part 13: Address List Management (Parlay X 2)

2 2 Reference RES/TISPAN OSA Keywords API, OSA, service 650 Route des Lucioles F Sophia Antipolis Cedex - FRANCE Tel.: Fax: Siret N 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: 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 printers of the PDF version kept on a specific network drive within 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 documents is available at If you find errors in the present document, please send your comment to one of the following services: 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 The Parlay Group All rights reserved. DECT TM, PLUGTESTS TM, UMTS TM, TIPHON TM, the TIPHON logo and the logo are Trade Marks of registered for the benefit of its Members. 3GPP TM is a Trade Mark of registered for the benefit of its Members and of the 3GPP Organizational Partners.

3 3 Contents Intellectual Property Rights...5 Foreword Scope References Normative references Definitions and abbreviations Definitions Abbreviations Detailed service description Group URI format Address list usage in services Namespaces Sequence diagrams Manage groups (Create, delete, query, set access and query access) Manage group members (AddMember, AddMembers, DeleteMember, DeleteMembers, QueryMembers) XML Schema data type definition AccessPermissions structure AttributeStatus enumeration SimpleAttribute structure Web Service interface definition Interface: GroupManagement Operation: creategroup Input message: creategrouprequest Output message: creategroupresponse Referenced faults Operation: deletegroup Input message: deletegrouprequest Output message: deletegroupresponse Referenced faults Operation: querygroups Input message: querygroupsrequest Output message: querygroupsresponse Referenced faults Operation: setaccess Input message: setaccessrequest Output message: setaccessresponse Referenced faults Operation: queryaccess Input message: queryaccessrequest Output message: queryaccessresponse Referenced faults Interface: Group Operation: addmember Input message: addmemberrequest Output message: addmemberresponse Referenced faults Operation: addmembers Input message: addmembersrequest Output message: addmembersresponse Referenced faults Operation: deletemember Input message: deletememberrequest...16

4 Output message: deletememberresponse Referenced faults Operation: deletemembers Input message: deletemembersrequest Output message: deletemembersresponse Referenced faults Operation: querymembers Input message: querymembersrequest Output message: querymembersresponse Referenced faults Operation: addgroupattribute Input message: addgroupattributerequest Output message: addgroupattributeresponse Referenced faults Operation: deletegroupattribute Input message: deletegroupattributerequest Output message: deletegroupattributeresponse Referenced faults Operation: querygroupattributes Input message: querygroupattributesrequest Output message: querygroupattributesresponse Referenced faults Operation: addgroupmemberattribute Input message: addgroupmemberattributerequest Output message: addgroupmemberattributeresponse Referenced faults Operation: deletegroupmemberattribute Input message: deletegroupmemberattributerequest Output message: deletegroupmemberattributeresponse Referenced faults Operation: querygroupmemberattributes Input message: querygroupmemberattributesrequest Output message: querygroupmemberattributesresponse Referenced faults Interface: Member Operation: addmemberattribute Input message: addmemberattributerequest Output message: addmemberattributeresponse Referenced faults Operation: querymemberattributes Input message: querymemberattributesrequest Output message: querymemberattributesresponse Referenced faults Operation: deletememberattribute Input message: deletememberattributerequest Output message: deletememberattributeresponse Referenced faults Fault definitions PolicyException POL0210: Too many members in group POL0211: Subgroups not supported POL0212: Group name too long POL0213: Group already exists Service policies...23 Annex A (normative): WSDL for Address List Management...24 Annex B (informative): Bibliography...25 History...26

5 5 Intellectual Property Rights IPRs essential or potentially essential to the present document may have been declared to. The information pertaining to these essential IPRs, if any, is publicly available for members and non-members, and can be found in SR : "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to in respect of standards", which is available from the Secretariat. Latest updates are available on the Web server ( Pursuant to the IPR Policy, no investigation, including IPR searches, has been carried out by. No guarantee can be given as to the existence of other IPRs not referenced in SR (or the updates on the Web server) which are, or may be, or may become, essential to the present document. Foreword This Standard (ES) has been produced by Technical Committee Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN). The present document is part 13 of a multi-part deliverable covering Open Service Access (OSA); Parlay X Web Services, as identified below: Part 1: Part 2: Part 3: Part 4: Part 5: Part 6: Part 7: Part 8: Part 9: Part 10: Part 11: Part 12: "Common"; "Third Party Call"; "Call Notification"; "Short Messaging"; "Multimedia Messaging"; "Payment"; "Account Management"; "Terminal Status"; "Terminal Location"; "Call Handling"; "Audio Call"; "Multimedia Conference"; Part 13: "Address List Management"; Part 14: "Presence". The present document has been defined jointly between, The Parlay Group ( 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 V6.5.0 (Release 6).

6 6 1 Scope The present document is part 13 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 Address List Management 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 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 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

7 7 [2] ES : "Open Service Access (OSA); Parlay X Web Services; Part 1: Common (Parlay X 2)". [3] IETF RFC 2396: "Uniform Resource Identifiers (URI): Generic Syntax". 3 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in ES [2] and the following apply: application managed group: group created and managed outside of the network, requiring the group members to be passed into the network for processing group: container for a set of addresses, it is not an address itself. When a group contain one or more groups, logically the group contains the set of addresses it holds, plus the set of addresses that any contained group holds (including any addresses contained in groups that a contained group holds) group resolution: when a group is processed by a service, it expands the group (and any nested groups) into a set of addresses. The resulting set of addresses contains no groups, and any duplicate addresses are removed. Thus, a resolved group may be considered an exclusive union of all of its contained members network managed group: group created and managed within a network, allowing Web Services to reference the members of a group using the group name 3.2 Abbreviations For the purposes of the present document, the abbreviations given in ES [2] apply. 4 Detailed service description The present document defines two related interfaces, one to manage the groups themselves - creation, deletion, query and access right management. The second interface manages the members within a group, supporting add, delete and query operations. Addresses are not created using this service, they must already exist. 4.1 Group URI format A group URI is consistent with the style defined in RFC 2396 [3], supporting the following URI style which is used in schemes such as sip and mailto: scheme:dept1294@mydivision.mycompany.serviceprovider.com The group URI consists of the following discrete elements: Scheme: selected by the provider of the group URI. Group name: following the conventions of RFC 2396 [3]. Suffix: may be added by Service Provider (if allowed by creation operation) to create a unique name when the Prefix + Group name already exists. Sub-domain: defined by the requester, this is contained within the domain provided by the service provider. Domain: defined by the Service Provider, and cannot be specified by the application.

8 8 This definition of a group URI enables flexibility on the part of the Service Provider and the Requester, while ensuring unique groups are created and providing transparency of implementation of group storage. The following are some group URI examples. sip:salesteam@sales.acme.anytelco.com sip:salesteam1@sales.acme.anytelco.com mailto:fieldservice@cityofaustin.anytelco.com group:mailroom@bldg001.acme.anytelco.com These examples show (1)(2) use of prefix to create unique names, (1)(3) use of different defined schemes, and (4) use of a service provider defined scheme. 4.2 Address list usage in services When a service has a requirement to support groups of address lists, it may satisfy this requirement by utilizing network managed groups. The group URI is passed to the service, and this group URI is resolved to the set of URIs contained within the group. If one or more group URIs are provided in a set of URIs to a service, the service will replace each group URI with its set of contained URIs, and the service processing will apply to the unique union of URIs generated. If supported by the service policy, zero or more of the set of URIs contained within a group may be themselves group URIs, which would also be resolved. Thus, in this case, the list of URIs that the service would process would be the union of individual URIs (as a set with no duplicates). Unless specifically defined in the semantics of a service, the expected semantic for the results of a service operation will be presented as the results for the set of URIs as processed (the union of non-group and group provided URIs), without group URIs included in the result. This eliminates a variety of complexity issues including duplicate URIs in multiple groups and the differences between a group URI and a URI referring to an endpoint. 5 Namespaces The GroupManagement interface uses the namespace: The Group interface uses the namespace: The GroupMember interface uses the namespace: The data types are defined in the namespace: 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.

9 9 6 Sequence diagrams 6.1 Manage groups (Create, delete, query, set access and query access) Pattern: Request / Response. The group management functions are shown in this diagram, showing a sequence including the creation of a group, setting access permissions to the group, querying those permissions, query of groups and finally deletion of a group. : Application : Address List Web Service Create group Verify or create name Create group Group URI Set access Query access Access permissions Query groups Groups Delete group Figure 1

10 Manage group members (AddMember, AddMembers, DeleteMember, DeleteMembers, QueryMembers) Pattern: Request / Response. The group membership functions are shown in this diagram, showing the two add, two delete, and the query function. : Application : Address List Web Service Add member Query members Members Delete member Figure 2 7 XML Schema data type definition 7.1 AccessPermissions structure List of access permissions that may be assigned to a requester associated with a group. Element name Element type Optional Description adminpermission xsd:boolean No Requester has admin permission for the group addpermission xsd:boolean No Requester can add members to a group deletepermission xsd:boolean No Requester can delete members from a group querypermission xsd:boolean No Requester can query members in a group 7.2 AttributeStatus enumeration Enumeration value Valid Unknown Denied Description Attribute is valid Attribute is not defined Access to the attribute is denied

11 SimpleAttribute structure Attribute representing a name and an associated value. Element name Element type Optional Description name xsd:string No Name of the attribute type xsd:string No Type of the attribute. The value is always a string, but this provides information on the format of the value value xsd:string No Value of the attribute status AttributeStatus No Status of the attribute 8 Web Service interface definition The Address List Management service consists of three interfaces: GroupManagement which manages creation and access to groups that hold the address lists. Group which manages the content of the address list. GroupMember which represents an address list entry and its associated properties. Together these provide the interfaces to create and manage address lists, enabling these groups to be used by other services through this common capability. 8.1 Interface: GroupManagement The GroupManagement interface provides the administration interface for creating, deleting, querying and managing access rights for groups. The format of the group name is specified in the Detailed Service Description (see clause 4) Operation: creategroup Create a new group. The requester provides the name for the group and the domain segment in which the group is to be stored. A domain segment is used, since the full domain will consist of the domain segment provided by the requester (e.g. "sales.mycompany") plus a period separator (".") per RFC 2396 [3] and the domain segment provided by the Service Provider (e.g. "serviceprovider.com"). To avoid name conflicts, since group URIs must be unique, an automatic naming capability is provided which will append a suffix to the name provided if the name is already used within the domain. If the AutoName is set to "true" and the fully qualified name is not unique, then the name will have a suffix added and the unique name will be provided in the result. For example, if the group "sales@mycompany.serviceprovider.com" was already defined, a suffix would be added and the result could be "sales1@mycompany.serviceprovider.com". If the AutoName is set to "false", then a PolicyException is thrown if the group URI is not unique Input message: creategrouprequest name xsd:string No Name of group to be included in group name domain xsd:string No Domain segment to be contained within the domain provided by the Service Provider. May be hierarchical using period separators (see RFC 2396 [3]) autoname xsd:boolean No If false, name must be unique or it will not be created. If true, a suffix will be added to the name if it is not unique

12 Output message: creategroupresponse result xsd:anyuri No Fully qualified group name Referenced faults POL0212: Group name too long. POL0213: Group already exists Operation: deletegroup Delete a group Input message: deletegrouprequest group xsd:anyuri No Name of group to delete Output message: deletegroupresponse None Referenced faults Operation: querygroups Group information can be retrieved from the network, with two types of search, one that retrieves groups only from a single sub-domain and one that returns groups from the sub-domain and its sub-domains. An example demonstrates the two search types. The following example data is used: Dept123@region1.sales.mycompany.serviceprovider.com Dept245@region2.sales.mycompany.serviceprovider.com Dept348@sales.mycompany.serviceprovider.com

13 13 For a search using the search domain "sales.mycompany", with the hierarchy set to "false", the result will contain: Dept348@sales.mycompany.serviceprovider.com Dept367@sales.mycompany.serviceprovider.com If the same search domain "sales.mycompany" is used, but the hierarchy set to "true", the result will contain: Dept123@region1.sales.mycompany.serviceprovider.com Dept245@region2.sales.mycompany.serviceprovider.com Dept348@sales.mycompany.serviceprovider.com Dept367@sales.mycompany.serviceprovider.com Input message: querygroupsrequest searchdomain xsd:string No Sub-domain to retrieve groups from hierarchy xsd:boolean No Follow hierarchy under search name Output message: querygroupsresponse result xsd:anyuri Yes Array of items matching search criteria [0..unbounded] Referenced faults Operation: setaccess Access to manage the elements within a group may be provided independently from the access to manage the group itself. This operation enables the group administrator to specify the requester and the operations the requester is permitted to perform through the Group interface. The access rights are absolute, if a requester has "query" access currently and "add" access is to be added, then the request requires both "add" and "query" rights to be set to "true". Likewise, any right that is set to "false" will be revoked.

14 Input message: setaccessrequest group xsd:anyuri No Group to grant access to requester xsd:string No Requester to grant access to adminpermission xsd:boolean No Permission to manage group addpermission xsd:boolean No Permission to add members to the group deletepermission xsd:boolean No Permission to delete members from the group querypermission xsd:boolean No Permission to query members in the group Output message: setaccessresponse None Referenced faults Operation: queryaccess Query the access permissions for a requester on a group Input message: queryaccessrequest group xsd:anyuri No Group to which permissions are to be granted requester xsd:string No Requester to retrieve access permissions for Output message: queryaccessresponse result AccessPermissions No List of permissions that a requester has Referenced faults

15 Interface: Group The Group interface provides the administration interface for creating, deleting, querying members within a group Operation: addmember Add a member to a group. If the new member is a group, and if nested group support is provided, this will add the group URI as a reference to the list of members (it will not expand the contents of the group within this group). A group may not be added recursively, an attempt to do so will result in a ServiceException. To add a group as a member of a group, the requester must have query permission on the group to be added Input message: addmemberrequest group xsd:anyuri No URI of group member xsd:anyuri No Member to add to the group Output message: addmemberresponse None Referenced faults POL0210: Too many members in group. POL0211: Subgroups not allowed Operation: addmembers Add an array of members to a group. If nested group support is provided, this will add any group URIs, as references, to the list of members (it will not expand the contents of any groups within this group). No group may be added recursively, an attempt to do so will result in a ServiceException, and none of the members will be added to the group. To add a group as a member of a group, the requester must have query permission on the group to be added Input message: addmembersrequest group xsd:anyuri No URI of group members xsd:anyuri [1..unbounded] No Member(s) to add to the group Output message: addmembersresponse None

16 Referenced faults POL0210: Too many members in group. POL0211: Subgroups not allowed Operation: deletemember Delete a member from a group. The member may only be removed from this group. If nested groups are supported, the member will not be removed from any nested group. Removal of a group URI will remove that group URI reference from this group, is will not delete the group Input message: deletememberrequest group xsd:anyuri No URI of group member xsd:anyuri No Member to delete from the group Output message: deletememberresponse None Referenced faults Operation: deletemembers Delete an array of members from a group. The members may only be removed from this group. If nested groups are supported, the members will not be removed from any nested group. Removal of a group URI will remove that group URI reference from this group, it will not delete the group. If the array contains URIs that are not in the group, they will be ignored and no fault will be generated Input message: deletemembersrequest group xsd:anyuri No URI of group members xsd:anyuri [1..unbounded] No Member(s) to delete from the group

17 Output message: deletemembersresponse None Referenced faults Operation: querymembers Get the list of members contained within a group. If nested groups are supported, then the member list may contain group URIs as members. Therefore, two manners are supported for retrieving the list of members - with members resolved and without. If resolvegroups is "true", then the exclusive union of all the members contained within the group, and any nested subgroups, is the result (exclusive union means that after retrieving all members, duplicate members are removed). If resolvegroups is "false", then the group members are returned including group URIs as members of the group. If members within nested groups are required, subsequent calls to this operation with those groups may be used to retrieve those members. If nested groups are not supported, the value of resolvegroups is ignored Input message: querymembersrequest group xsd:anyuri No URI of group resolvegroups xsd:boolean No If true, return set of members after resolving groups (including subgroups). If false, return members including group references Output message: querymembersresponse result xsd:anyuri Yes Members of group [0..unbounded] Referenced faults

18 Operation: addgroupattribute Groups may have attributes associated with the group. To avoid conflicts, attribute names that start with Group are reserved for use as defined within the present document: Group.Description. Group.ExpiryDate. Attributes may be added or updated by those with admin or add permission on the specified group Input message: addgroupattributerequest group xsd:anyuri No Group to set attribute for value SimpleAttribute No Attribute to add, or update Output message: addgroupattributeresponse None Referenced faults Operation: deletegroupattribute Groups may have attributes removed by those with admin or delete permission on the specified group Input message: deletegroupattributerequest group xsd:anyuri No Group to delete attribute from attributename xsd:string No Name of attribute to delete Output message: deletegroupattributeresponse None Referenced faults

19 Operation: querygroupattributes Query the attributes for a group by those with admin or read permission on the specified group Input message: querygroupattributesrequest group xsd:anyuri No Group to get attributes for Output message: querygroupattributesresponse result SimpleAttribute Yes Group attributes [0..unbounded] Referenced faults Operation: addgroupmemberattribute Group members may have attributes that are within the context of a group in which they belong. Group member attributes may be added or updated by those with admin or add permission on the specified group Input message: addgroupmemberattributerequest group xsd:anyuri No Group to set attribute for member xsd:anyuri No Member to set attribute for value SimpleAttribute No Attribute to add, or update Output message: addgroupmemberattributeresponse None Referenced faults

20 Operation: deletegroupmemberattribute Group members may have attributes removed by those with admin or delete permission on the specified group Input message: deletegroupmemberattributerequest group xsd:anyuri No Group to delete attribute from member xsd:anyuri No Member to delete attribute from attributename xsd:string No Name of attribute to remove Output message: deletegroupmemberattributeresponse None Referenced faults Operation: querygroupmemberattributes Query the attributes for a group member by those with admin or read permission on the specified group Input message: querygroupmemberattributesrequest group xsd:anyuri No Group to get attributes for member xsd:anyuri No Member to get attributes for Output message: querygroupmemberattributesresponse result SimpleAttribute Yes Group member attributes [0..unbounded] Referenced faults

21 Interface: Member The Member interface provides access to information related to a particular entity Operation: addmemberattribute Add member attribute. If an attribute with this name exists, its value will be replaced with the value provided in this operation Input message: addmemberattributerequest member xsd:anyuri No Member to add attribute to data SimpleAttribute No Attribute to add to member Output message: addmemberattributeresponse None Referenced faults Operation: querymemberattributes Query attributes of a member. If any attributes requested do not exist, they will not be included in the result Input message: querymemberattributesrequest member xsd:anyuri No Member to query attributes for attributenames xsd:string [1..unbounded] No List of attribute names to retrieve Output message: querymemberattributesresponse result SimpleAttribute [0..unbounded] Yes List of attributes

22 Referenced faults Operation: deletememberattribute Delete attribute from a member. If the attribute specified does not exist, it will be ignored Input message: deletememberattributerequest member xsd:anyuri No Member to remove attributes from attributename xsd:string No Name of attribute to delete Output message: deletememberattributeresponse None Referenced faults 9 Fault definitions 9.1 PolicyException POL0210: Too many members in group Number of members in a group exceeds the number allowed by the Service Policy (MaxGroupMembers). Name messageid text variables Description POL0210 Attempt to exceed maximum number of members in a group. Maximum number allowed is %1 %1 = Maximum number allowed by Service Policy

23 POL0211: Subgroups not supported Attempt to add a subgroup not permitted by Service Policy (SupportNestedGroups). Name messageid text variables Description POL0211 Attempted to add a group to an existing group. Subgroups are not supported None POL0212: Group name too long Length of group name exceeds the length allowed by the Service Policy (MaxGroupLength). Name Description messageid POL0212 text Group name is too long. Maximum length allowed is %1 variables %1 = Maximum length allowed by Service Policy POL0213: Group already exists If the group name is not unique and the autoname part value is set to "false", then a PolicyException is returned since the group name already exists. Name messageid text variables Description POL0213 Group URI %1 already exists. Group not created %1 = Group URI 10 Service policies Service policies for this service. Name Type Description MaxGroupLength xsd:int Maximum length of the group name (user portion) MaxGroupMembers xsd:int Maximum number of members in a group SupportNestedGroups xsd:boolean Can a group member be a group URI

24 24 Annex A (normative): WSDL for Address List Management The document/literal WSDL representation of this interface specification is compliant to ES [2] and is contained in text files (contained in archive es_ v010301p0.zip) which accompany the present document.

25 25 Annex B (informative): Bibliography TR : "Universal Mobile Telecommunications System (UMTS); Vocabulary for 3GPP Specifications (3GPP TR )".

26 26 History Document history V1.1.1 March 2005 Publication V1.2.1 December 2006 Publication V1.3.1 February 2008 Membership Approval Procedure MV : to V1.3.1 May 2008 Publication