IMS Membership Management Services WSDL Binding Version 2.0 Public Draft (Supersedes the v1.0 Public Draft released on 12 January 2004)

Copyright © 2004 IMS Global Learning Consortium, Inc. All Rights Reserved.
The IMS Logo is a registered trademark of IMS Global Learning Consortium, Inc.
Document Name: IMS Membership Management Services WSDL Binding
Revision: 19 April 2004 

IPR and Distribution Notices

Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the specification set forth in this document, and to provide supporting documentation.

IMS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on IMS's procedures with respect to rights in IMS specifications can be found at the IMS Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf.

Copyright © IMS Global Learning Consortium 2006. All Rights Reserved.

If you wish to distribute this document or use this document to implement a product or service, you must complete a valid license registration with IMS and receive an email from IMS granting the license. To register, follow the instructions on the IMS website: http://www.imsglobal.org/specificationdownload.cfm.

This document may be copied and furnished to others by Licensee organizations registered on the IMS website provided that the above copyright notice and this paragraph are included on all such copies. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to IMS, except as needed for the purpose of developing IMS specifications, under the auspices of a chartered IMS work group.

Use of this specification to develop products or services is governed by the license with IMS found on the IMS website: http://www.imsglobal.org/es/esv2p0pd/esv2p0pdspeclicense.html.

The limited permissions granted above are perpetual and will not be revoked by IMS or its successors or assigns.

If you or your organization has a Membership Management Services implementation, please register it in the ES public forum: http://www.imsglobal.org/developers/ims/imsforum/categories.cfm?catid=20

Table of Contents

1. Introduction

1.1 Membership Management Services Overview

The Membership Management Services specification [MemberService, 04a] is the definition of how systems manage the exchange of information that describes people within the context of learning. The Membership Management Services specification is constructed following the recommendations documented in the IMS Abstract Framework (IAF) [AbsGloss, 03], [AbsASC, 03], [AbsWhite, 03]. This means that this specification is based upon the concepts of:

• Interoperability - Membership Management Services focuses on the exchange of Member(s) information between Enterprise systems. There are no assumptions in the specification on how the data is managed within the Enterprise systems;
• Service-oriented - Membership Management Services defines the exchange of information in terms of the services being supplied by the collaboration of the systems;
• Component-based - the Membership Management Services will be combined with the Group Management Services and Person Management Services to provide the Enterprise Service. Other services will be added to it in later releases;
• Layering - the Membership Management Service is a part of the Application Services layer but it interacts with the services available in the Common Services layer e.g. authentication;
• Behaviors and Data Models - the Membership Management Services are defined in terms of their behaviors and data models. The behaviors cause changes in the state of the data model and the state of the data model will only be altered as a result of a clearly defined behavior;
• Multiple Bindings - the Membership Management Services information model is to be defined using the Unified Modelling Language (UML). This enables reliable mapping of the information model into a range of different bindings. The bindings of immediate importance are to the Web Services Description Language (WSDL);
• Adoption - the Membership Management Services are based upon the original Enterprise specification data model. While there are significant changes the underlying data model has been maintained and the core Person structures remain.

1.2 Scope and Context

This document is the IMS Membership Management Services WSDL Binding v1.0 and as such it is used in conjunction with the following documents:

1. IMS Enterprise Services Core Use-cases v1.0 [EntService, 04a] - the set of use-cases that are the basis for the definition of the Person Management Services information model;
2. IMS Membership Management Services Information Model v1.0 [MemberService, 04] - the behavior and data model definition of the Membership Management Services;
3. IMS Enterprise Services Best Practice & Implementation Guide v1.0 [EntService, 04c] - this presents information that helps implementers adopt the specification;
4. IMS Enterprise Services Conformance Specification v1.0 [EntService, 04b] - the definition of the conformance criteria that must be followed by systems that wish to claim compliance to the Enterprise Services Information model.

As such the Membership Management Services specification supersedes the original Enterprise specifications:

1. IMS Enterprise Information Model Final Specification v1.1 [Enterprise, 02a].
2. IMS Enterprise XML Binding Final Specification v1.1 [Enterprise, 02b];
3. IMS Enterprise Services Best Practice & Implementation Guide Final Specification v1.1 [Enterprise, 02c].

This WSDL binding takes the Membership Management Service Information Model and produces an encoding of that description in WSDL. This WSDL binding is generated as recommended by the IMS General Web Services documents [GWS, 04a], [GWS, 04b].

1.3 Structure of this Document

The structure of this document is:

2. Application of the WSDL Binding Guidelines	A description of how the General Web Services WSDL binding guidelines have been applied to the Membership Management Services Information Model;
3. Data Model Binding	The description of the XML schemas that are created to reflect the data model of the Membership Management Services Information Model;
4. Synchronous WSDL Binding	The description of the SOAP messages and the corresponding XML schemas that are created as the synchronous WSDL binding;
5. Asynchronous WSDL Binding	The description of the SOAP messages and the corresponding XML schemas that are created as the asynchronous WSDL binding;
Appendix A - Binding Files Listings	The WSDL listings for the synchronous and asynchronous SOAP/http binding of the Membership Management Services Information Model.

1.4 Nomenclature

API	Application Programming Interface
IAF	IMS Abstract Framework
UML	Unified Modelling Language
W3C	World Wide Web Consortium
WSDL	Web Services Description Language
XML	Extensible Mark-up Language

1.5 References

[AbsASCs, 03]	IMS Abstract Framework: Applications, Services & Components v1.0, Ed. C.Smythe, IMS Global Learning Consortium, Inc., July 2003.
[AbsGloss, 03]	IMS Abstract Framework: Glossary v1.0, Ed. C.Smythe, IMS Global Learning Consortium, Inc., July 2003.
[AbsWhite, 03]	IMS Abstract Framework: White Paper v1.0, Ed. C.Smythe, IMS Global Learning Consortium, Inc., July 2003.
[Cockburn, 01]	Writing Effective Use-case, A.Cockburn, Addison-Wesley, 2001, ISBN 0-201-70225-8.
[CommonData, 04]	IMS Common Data Specification Public Draft v1.0, C.Smythe and C.Vento, IMS Global Learning Consortium, Inc. Version 1.0, January 2004.
[Enterprise, 02a]	IMS Enterprise Information Model Final Specification v1.1, G.Collier, C.Etesse, W.Veres and C.Smythe, IMS Global Learning Consortium, Inc., July 2002.
[Enterprise, 02b]	IMS Enterprise XML Binding Final Specification v1.1, G.Collier, C.Etesse, W.Veres and C.Smythe, IMS Global Learning Consortium, Inc., July 2002.
[Enterprise, 02c]	IMS Enterprise Best Practice & Implementation Guide Final Specification v1.1, G.Collier, C.Etesse, W.Veres and C.Smythe, IMS Global Learning Consortium, Inc., July 2002.
[EntServices, 04a]	IMS Enterprise Services Core Use Cases Description Public Draft v1.0, C.Smythe and C.Vento, IMS Global Learning Consortium, Inc., January 2004.
[EntServices, 04b]	IMS Enterprise Services Conformance Specification Public Draft v1.0, C.Smythe and C.Vento, IMS Global Learning Consortium, Inc., Version 1.0, January 2004.
[EntServices, 04c]	IMS Enterprise Services Best Practices & Implementation Guide Public Draft v1.0, C.Smythe and C.Vento, IMS Global Learning Consortium, Inc., January 2004.
[GWS, 04a]	IMS General Web Services Base Profiles Public Draft v1.0, C.Schroeder, R.Kleinman and C.Smythe, IMS Global Learning Consortium, Inc., Version 1.0, January 2004.
[GWS, 04b]	IMS General Web Services Binding Methodology & Recipes Public Draft v1.0, C.Schroeder, R.Kleinman and C.Smythe, IMS Global Learning Consortium, Inc., Version 1.0, January 2004.
[MemberService, 04]	IMS Member Management Services Information Model Public Draft v1.0, C.Smythe and C.Vento, IMS Global Learning Consortium, Inc., January 2004.

2. Application of the WSDL Binding Guidelines

2.1 Synchronous Binding

The WSDL bindings have been generated using the methodology documented in [GWS 04a] and [GWS, 04b]. The composition of the synchronous WSDL binding is shown in Figure 2.1.

The binding files described in Figure 2.1 contain:

• 'imsMemberManServiceSyncv1p0.wsdl' - the service specific WSDL binding file. For the Membership Management Service this is based upon SOAP/http. This file imports the abstract definitions using the <wsdl:import> construct. The listing of this file is given in Appendix A;
• 'imsMemberManAbstractSyncv1p0.wsdl' - the abstract message definitions that represent the behavior of the Membership Management Service operations. This file imports the message XSD using the <xsd:import> construct. The listing of this file is given in Appendix A;
• 'imsMemberManMessSchemav1p0.xsd' - the XSD definitions for the synchronous and asynchronous messages. This file imports the Membership data model XSD using the <xsd:import> construct. The listing of this file is given in Appendix A;
• 'imsMemberManDataSchemav1p0.xsd' - the definition of the Membership data model. This is the file that was produced by the equivalent data model binding in Enterprise v1.1. The listing of this file is given in Appendix A;
• 'imsMessBindSchemav1p0.xsd' - the XSD binding of the message header parts. This includes the message headers for synchronous, polled and asynchronous message models;
• 'imsEnterpriseCommonSchemav1p0.xsd' - the XSD binding of the IMS Enterprise Service common data objects. This file is used by the Membership message and data model XSDs as well as the IMS message binding XSD;
• 'wsiwsdlv1p1.xsd' - this is the reference XSD for the WSDL definition. This file is the WS-I amended version of the original file from W3C;
• 'wsisoapv1p1.xsd' - this is the reference XSD for the SOAP extensions to WSDL. This file is from WS-I.

The name spaces used within these bindings are listed in Table 2.1.

Namespace	Prefix	Usage
-	"tns:"	The target namespace identifier.
http://www.w3.org/2001/XMLSchema	"xsd:"	The XML schema definition namespace.
/enterprise/xsd/imsEnterpriseCommonSchemav1p0	"iaf:"	The IMS Enterprise Service common data model definitions namespace.
/common/xsd/imsMessBindSchemav1p0	"isb:"	The IMS message header binding definitions namespace.
/mms/xsd/imsMemberManDataSchemav1p0	"mem:"	The data model namespace for the Membership class.
/mms/xsd/imsMemberManMessSchemav1p0	"imsmms:"	The IMS Membership Management Services message binding definitions namespace.
/mms/wsdl/imsMemberManAbstractSyncv1p0	"absm:"	The Membership Management Service abstract definitions file references.
wsisoapv1p1	"soap:"	The SOAP references used within the WSDL files.
wsiwsdlv1p1	"wsdl:"	The default WSDL files namespace for WSDL v1.1.

2.2 Asynchronous Binding

The WSDL bindings have been generated using the methodology documented in [GWS 04a] and [GWS, 04b]. The composition of the synchronous WSDL binding is shown in Figure 2.2. The binding files described in Figure 2.2 contain:

• 'imsMemberManServiceAsyncReqv1p0.wsdl' - the service specific WSDL binding file for the 'Request/Acknowledge' messages. For the Membership Management Service this is based upon SOAP/http. This file imports the abstract definitions using the <wsdl:import> construct. The listing of this file is given in Appendix A;
• 'imsMemberManServiceAsyncResv1p0.wsdl' - the service specific WSDL binding file for the 'Response/Acknowledge' messages. For the Membership Management Service this is based upon SOAP/http. This file imports the abstract definitions using the <wsdl:import> construct. The listing of this file is given in Appendix A;
• 'imsMemberManAbstractAyncReqv1p0.wsdl' - the abstract message definitions that represent the behavior of the Membership Management Service operations for the 'Request/Acknowledge' messages. This file imports the message XSD using the <xsd:import> construct. The listing of this file is given in Appendix A;
• 'imsMemberManAbstractAyncResv1p0.wsdl' - the abstract message definitions that represent the behavior of the Membership Management Service operations for the 'Response/Acknowledge' messages. This file imports the message XSD using the <xsd:import> construct. The listing of this file is given in Appendix A;

• 'imsMemberManMessSchemav1p0.xsd' - the XSD definitions for the synchronous and asynchronous messages. This file imports the Member data model XSD using the <xsd:import> construct. The listing of this file is given in Appendix A;
• 'imsMemberManDataSchemav1p0.xsd' - the definition of the Member data model. This is the file that was produced by the equivalent data model binding in Enterprise v1.1. The listing of this file is given in Appendix A;
• 'imsMessBindSchemav1p0.xsd' - the XSD binding of the message header parts. This includes the message headers for synchronous, polled and asynchronous message models;
• 'imsEnterpriseCommonSchemav1p0.xsd' - the XSD binding of the IMS Enterprise Service common data objects. This file is used by the Person message and data model XSDs as well as the IMS message binding XSD;
• 'wsiwsdlv1p1.xsd' - this is the reference XSD for the WSDL definition. This file is the WS-I amended version of the original file from W3C;
• 'wsisoapv1p1.xsd' - this is the reference XSD for the SOAP extensions to WSDL. This file is from WS-I.

The name spaces and prefixes used within these bindings are listed in Table 2.2.

Namespace	Prefix	Usage
-	"tns:"	The target namespace identifier.
http://www.w3.org/2001/XMLSchema	"xsd:"	The XML schema definition namespace.
/enterprise/xsd/imsEnterpriseCommonSchemav1p0	"iaf:"	The IMS Enterprise Service common data model definitions namespace.
/common/xsd/imsMessBindSchemav1p0	"isb:"	The IMS message header binding definitions namespace.
/mms/xsd/imsMemberManDataSchemav1p0	"mem:"	The data model namespace for the Member class.
/mms/xsd/imsMemberManMessSchemav1p0	"imsmms:"	The IMS Membership Management Services message binding definitions namespace.
/mms/wsdl/imsMemberManAbstractAsyncReqv1p0	"absm:"	The Membership Management Service asynchronous abstract definitions file references.
/mms/wsdl/imsMemberManAbstractAsyncResv1p0	"absm:"	The Membership Management Service asynchronous abstract definitions file references.
wsisoapv1p1	"soap:"	The SOAP references used within the WSDL files.
wsiwsdlv1p1	"wsdl:"	The default WSDL files namespace for WSDL v1.1.

3. Data Model XML Schemas Binding

3.1 <membership> Element

The XSD visualization of the <person> data model is shown in Figure 3.1. This is the XML equivalent of the UML description in Figure 4.1 and Tables 4.1 and 4.2 [MemberService, 04].

3.1.1 <sourcedId> Element

See Table 4.1 and the OCL definitions in sub-section 4.1.4 [MemberService, 04].

3.1.2 <groupSourcedId> Element

See Table 4.1 and the OCL definitions in sub-section 4.1.4 [MemberService, 04].

3.2 <member> Element

The XSD visualization of the <person> data model is shown in Figure 3.2. This is the XML equivalent of the UML description in Figure 4.1 and Tables 4.3 and 4.4 [MemberService, 04].

3.2.1 <memberSourcedId> Element

See Table 4.3 and the OCL definitions in sub-section 4.1.4 [MemberService, 04].

3.2.2 <idType> Element

See Table 4.3 and the OCL definitions in sub-section 4.1.4 [MemberService, 04].

3.3 <role> Element

The XSD visualization of the <person> data model is shown in Figure 3.3. This is the XML equivalent of the UML description in Figure 4.1 and Table 4.5 [MemberService, 04].

3.3.1 <roleType> Element

See Table 4.5 and the OCL definitions in sub-section 4.1.4 [MemberService, 04].

3.3.2 <subRole> Element

See Table 4.5 and the OCL definitions in sub-section 4.1.4 [MemberService, 04].

3.3.3 <recordInfo> Element

The XSD visualization of the <recordInfo> data model is shown in Figure 3.4. This is the XML equivalent of the UML description in Figure 4.1 and Table 4.5 [MemberService, 04].

3.3.4 <userId> Element

The XSD visualization of the <userId> data model is shown in Figure 3.5. This is the XML equivalent of the UML description in Figure 4.1 and Table 4.5 [MemberService, 04].

3.3.5 <email> Element

See Table 4.5 and the OCL definitions in sub-section 4.1.4 [MemberService, 04].

3.3.6 <timeFrame> Element

The XSD visualization of the <timeFrame> data model is shown in Figure 3.6. This is the XML equivalent of the UML description in Figure 4.1 and Table 4.5 [MemberService, 04].

3.3.7 <status> Element

See Table 4.5 and the OCL definitions in sub-section 4.1.4 [MemberService, 04].

3.3.8 <dateTime> Element

See Table 4.5 and the OCL definitions in sub-section 4.1.4 [MemberService, 04].

3.3.9 <interimResult> Element

The XSD visualization of the <timeFrame> data model is shown in Figure 3.7. This is the XML equivalent of the UML description in Figure 4.1 and Tables 4.6, 4.7, 4.8, 4.9 and 4.10 [MemberService, 04].

3.3.10 <finalResult> Element

The XSD visualization of the <timeFrame> data model is shown in Figure 3.8. This is the XML equivalent of the UML description in Figure 4.1 and Tables 4.6, 4.7, 4.8, 4.9 and 4.10 [MemberService, 04].

3.3.11 <dataSource> Element

See Table 4.5 and the OCL definitions in sub-section 4.1.4 [MemberService, 04].

3.3.12 <extension> Element

The XSD visualization of the <timeFrame> data model is shown in Figure 3.9. This is the XML equivalent of the UML description in Figure 4.1 and Table 4.5 [MemberService, 04].

3.3.13 <membershipSet> Element

The XSD visualization of the <membershipSet> data model is shown in Figure 3.10. This is the XML equivalent of the UML description in Figure 4.2 and Table 4.11 [MemberService, 04].

3.3.14 <membershipId3tuple> Element

The XSD visualization of the <membershipId3tuple> data model is shown in Figure 3.11. This is the XML equivalent of the UML description in Figure 4.3 and Table 4.13 [MemberService, 04].

3.3.15 <membershipId3tupleSet> Element

The XSD visualization of the <membershipId3tupleSet> data model is shown in Figure 3.12. This is the XML equivalent of the UML description in Figure 4.3 and Table 4.12 [MemberService, 04].

3.3.16 <membershipId2tuple> Element

The XSD visualization of the <membershipId2tuple> data model is shown in Figure 3.13. This is the XML equivalent of the UML description in Figure 4.4 and Table 4.15 [MemberService, 04].

3.3.17 <membershipId2tupleSet> Element

The XSD visualization of the <membershipId2tupleSet> data model is shown in Figure 3.14. This is the XML equivalent of the UML description in Figure 4.4 and Table 4.14 [MemberService, 04].

3.3.18 <membershipIdPair> Element

The XSD visualization of the <membershipIdPair> data model is shown in Figure 3.15. This is the XML equivalent of the UML description in Figure 4.3 and Table 4.13 [MemberService, 04].

3.3.19 <membershipIdPairSet> Element

The XSD visualization of the <membershipIdPairSet> data model is shown in Figure 3.16. This is the XML equivalent of the UML description in Figure 4.3 and Table 4.12 [MemberService, 04].

3.3.20 <sourcedIdSet> Element

The XSD visualization of the <sourcedIdSet> data model is shown in Figure 3.17.

3.3.21 <pairSourcedIdSet> Element

The XSD visualization of the <pairSourcedIdSet> data model is shown in Figure 3.18. This is the XML equivalent of the UML description in Figure 4.2 [CommonData, 04].

4. Synchronous WSDL Binding

4.1 SOAP Specific Service Binding

The key properties of the Specific Service binding files are detailed in Table 4.1. The Service Specific filename is: 'imsMemberManServiceSyncv1p0.wsdl'.

Property	Value
Transport Mechanism	SOAPv1.1/HTTPv1.1
Service Name	"MembershipManagementServiceSync"
Service Port Name	"MembershipManagementServiceSyncSoap"
Service Binding Name	"MembershipManagementServiceSyncSoap"
Binding Port Type	"MembershipManagementServiceSync"

4.2 Abstract Definition Binding

The key properties of the Specific Service binding files are detailed in Table 4.2. The Abstract Definitions filename is: 'imsMemberManAbstractSyncv1p0.wsdl'.

Property	Value
Port Type Name	"MembershipManagamentServiceSync"

4.3 Message XML Schemas

4.3.1 'createMembershipRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'createMembership()' operation. See 'createMembership()' sub-section of [MemberService, 04].

Four parameters are supplied:

• sourcedId - the unique identifier to be assigned to the new Membership record;
• groupSourcedId - the unique identifier for the Group of the new Membership record;
• memberSourcedId - the unique identifier for the Member of the new Membership record;
• membership - the Membership data to be stored in the new record.

4.3.2 'createMembershipResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'createMembership()' operation. See 'createMembership()' sub-section of [MemberService, 04].

The <createMembershipResponse> element is empty.

Note: The status information is returned in the header of the SOAP transport message.

4.3.3 'createByProxyMembershipRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'createByProxyMembership()' operation. See 'createByProxyMembership()' sub-section of [MemberService, 04].

Three parameters are supplied:

• groupSourcedId - the unique identifier for the Group of the new Membership record;
• memberSourcedId - the unique identifier for the Member of the new Membership record;
• membership - the Membership data to be stored in the new record.

4.3.4 'createByProxyMembershipResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'createByProxyMembership()' operation. See 'createByProxyMembership()' sub-section of [MemberService, 04].

The returned information is:

• sourcedId - the unique identifier assigned by the Sync Agent to the new record.

Note: The status information is returned in the header of the SOAP transport message.

4.3.5 'deleteMembershipRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'deleteMembership()' operation. See 'deleteMembership()' sub-section of [MemberService, 04].

One parameter is supplied:

• sourcedId - the identifier of the Membership record to be deleted;

4.3.6 'deleteMembershipResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'deleteMembership()' operation. See 'deleteMembership()' sub-section of [MemberService, 04].

The <deleteMembershipResponse> element is empty.

Note: The status information is returned in the header of the SOAP transport message.

4.3.7 'readMembershipRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'readMembership()' operation. See 'readMembership()' sub-section of [MemberService, 04].

One parameter is supplied:

• sourcedId - the identifier of the Membership record to be read.

4.3.8 'readMembershipResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'readMembership()' operation. See 'readMembership()' sub-section of [MemberService, 04].

The returned information is:

• membership - the returned Membership record.

Note: The status information is returned in the header of the SOAP transport message.

4.3.9 'updateMembershipRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'updateMembership()' operation. See 'updateMembership()' sub-section of [MemberService, 04].

Two parameters are supplied:

• sourcedId - the identifier of the Membership record to be changed;
• membership - the Membership data to be stored in the new record.

4.3.10 'updateMembershipResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'updateMembership()' operation. See 'updateMembership()' sub-section of [MemberService, 04].

The <updateMembershipResponse> element is empty.

Note: The status information is returned in the header of the SOAP transport message.

4.3.11 'replaceMembershipRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'replaceMembership()' operation. See 'replaceMembership()' sub-section of [MemberService, 04].

Two parameters are supplied:

• sourcedId - the identifier of the Membership record to be changed;
• membership - the Membership data to be stored in the new record.

4.3.12 'replaceMembershipResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'replaceMembership()' operation. See 'replaceMembership()' sub-section of [MemberService, 04].

The <replaceMembershipResponse> element is empty.

Note: The status information is returned in the header of the SOAP transport message.

4.3.13 'changeMembershipIdentifierRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'changeMembershipIdentifier()' operation. See 'changeMembershipIdentifier()' sub-section of [MemberService, 04].

Two parameters are supplied:

• sourcedId - the identifier of the Membership whose identifier is to be changed;
• newSourcedId - the new identifier for the Membership record.

4.3.14 'changeMembershipIdentifierResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'changeMembershipIdentifier()' operation. See 'changeMembershipIdentifier()' sub-section of [MemberService, 04].

The <changeMembershipIdentifierResponse> element is empty.

Note: The status information is returned in the header of the SOAP transport message.

4.3.15 'createMembershipsRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'createMemberships()' operation. See 'createMemberships()' sub-section of [MemberService, 04].

One parameter is supplied:

• membershipId3tupleSet - the list of identifiers (Membership, source Group and source Member) and membership tuples for the new Membership records.

4.3.16 'createMembershipsResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'createMemberships()' operation. See 'createMemberships()' sub-section of [MemberService, 04].

The <createMembershipsResponse> element is empty.

Note: The status information is returned in the header of the SOAP transport message.

4.3.17 'createByProxyMembershipsRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'createByProxyMemberships()' operation. See 'createByProxyMemberships()' sub-section of [MemberService, 04].

One parameter is supplied:

• membershipId2tupleSet - the list of identifiers (source Group and source Member) and membership tuples for the new Membership records

4.3.18 'createByProxyMembershipsResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'createByProxyMemberships()' operation. See 'createByProxyMemberships()' sub-section of [MemberService, 04].

The returned information is:

• sourcedIdSet - the set of unique identifiers that have been allocated by the Sync Agent to the newly created records.

Note: The status information is returned in the header of the SOAP transport message.

4.3.19 'deleteMembershipsRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'deleteMemberships()' operation. See 'deleteMemberships()' sub-section of [MemberService, 04].

One parameter is supplied:

• sourcedIdSet - the set of unique identifiers for the Membership records that are to be deleted.

4.3.20 'deleteMembershipsResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'deleteMemberships()' operation. See 'deleteMemberships()' sub-section of [MemberService, 04].

The <deleteMembershipsResponse> element is empty.

Note: The status information is returned in the header of the SOAP transport message.

4.3.21 'readMembershipsRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'readMemberships()' operation. See 'readMemberships()' sub-section of [MemberService, 04].

One parameter is supplied:

• sourcedIdSet - the set of unique identifiers for the Membership records that are to be read.

4.3.22 'readMembershipsResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'readMemberships()' operation. See 'readMemberships()' sub-section of [MemberService, 04].

The returned information is:

• membershipSet - the set of Membership records that have been read.

Note: The status information is returned in the header of the SOAP transport message.

4.3.23 'readMembershipsForPersonRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'readMembershipsForPerson()' operation. See 'readMembershipsForPerson()' sub-section of [MemberService, 04].

One parameter is supplied:

• personSourcedIdSet - the identifier of the Person whose Membership records are to be returned.

4.3.24 'readMembershipsForPersonResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'readMembershipsForPerson()' operation. See 'MembershipsForPerson()' sub-section of [MemberService, 04].

The returned information is:

• membershipSet - the set of Membership records that have been read.

Note: The status information is returned in the header of the SOAP transport message.

4.3.25 'readMembershipsForGroupRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'readMembershipsForGroup()' operation. See 'readMembershipsForGroup()' sub-section of [MemberService, 04].

One parameter is supplied:

• groupSourcedIdSet - the identifier of the Group whose Membership records are to be returned.

4.3.26 'readMembershipsForGroupResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'readMembershipsForGroup()' operation. See 'MembershipsForGroup()' sub-section of [MemberService, 04].

The returned information is:

• membershipSet - the set of Membership records that have been read.

Note: The status information is returned in the header of the SOAP transport message.

4.3.27 'updateMembershipsRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'updateMemberships()' operation. See 'updateMemberships()' sub-section of [MemberService, 04].

One parameter is supplied:

• membershipIdPairSet - the list of identifier and membership tuples for the Membership records to be changed.

4.3.28 'updateMembershipsResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'updateMemberships()' operation. See 'updateMemberships()' sub-section of [MemberService, 04].

The <updateMembershipsResponse> element is empty.

Note: The status information is returned in the header of the SOAP transport message.

4.3.29 'replaceMembershipsRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'updateMemberships()' operation. See 'updateMemberships()' sub-section of [MemberService, 04].

One parameter is supplied:

• membershipIdPairSet - the list of identifier and membership tuples for the Membership records to be changed.

4.3.30 'replaceMembershipsResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'replaceMemberships()' operation. See 'replaceMemberships()' sub-section of [MemberService, 04].

The <replaceMembershipsResponse> element is empty.

Note: The status information is returned in the header of the SOAP transport message.

4.3.31 'changeMembershipsIdentifierRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'changeMembershipsIdentifier()' operation. See 'changeMembershipsIdentifier()' sub-section of [MemberService, 04].

One parameter is supplied:

• pairSourcedIdSet - the list of paired old and new identifier.

4.3.32 'changeMembershipsIdentifierResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'changeMembershipsIdentifier()' operation. See 'changeMembershipsIdentifier()' sub-section of [MemberService, 04].

The <changeMembershipsIdentifierResponse> element is empty.

Note: The status information is returned in the header of the SOAP transport message.

4.4 SOAP Messages

The set of example SOAP/HTTP messages are described in Table 4.3.

Message	Example File
'createMembershipRequest' Message	/examples/createMembershipRequestSync.txt
'createMembershipResponse' Message	/examples/createMembershipResponseSync.txt
'createByProxyMembershipRequest' Message	/examples/createByProxyMembershipRequestSync.txt
'createByProxyMembershipResponse' Message	/examples/createByProxyMembershipResponseSync.txt
'deleteMembershipRequest' Message	/examples/deleteMembershipRequestSync.txt
'deleteMembershipResponse' Message	/examples/deleteMembershipResponseSync.txt
'readMembershipRequest' Message	/examples/readMembershipRequestSync.txt
'readMembershipResponse' Message	/examples/readMembershipResponseSync.txt
'updateMembershipRequest' Message	/examples/updateMembershipRequestSync.txt
'updateMembershipResponse' Message	/examples/updateMembershipResponseSync.txt
'replaceMembershipRequest' Message	/examples/replaceMembershipRequestSync.txt
'replaceMembershipResponse' Message	/examples/replaceMembershipResponseSync.txt
'changeMembershipIdentifierRequest' Message	/examples/changeMembershipIdentifierRequestSync.txt
'changeMembershipIdentifierResponse' Message	/examples/changeMembershipIdentifierResponseSync.txt
'createMembershipsRequest' Message	/examples/createMembershipsRequestSync.txt
'createMembershipsResponse' Message	/examples/createMembershipsResponseSync.txt
'createByProxyMembershipsRequest' Message	/examples/createByProxyMembershipsRequestSync.txt
'createByProxyMembershipsResponse' Message	/examples/createByProxyMembershipsResponseSync.txt
'deleteMembershipsRequest' Message	/examples/deleteMembershipsRequestSync.txt
'deleteMembershipsResponse' Message	/examples/deleteMembershipsResponseSync.txt
'readMembershipsRequest' Message	/examples/readMembershipsRequestSync.txt
'readMembershipsResponse' Message	/examples/readMembershipsResponseSync.txt
'readMembershipsForPersonRequest' Message	/examples/readMembershipsForPersonRequestSync.txt
'readMembershipsForPersonResponse' Message	/examples/readMembershipsForPersonResponseSync.txt
'readMembershipsForGroupRequest' Message	/examples/readMembershipsForGroupRequestSync.txt
'readMembershipsForGroupResponse' Message	/examples/readMembershipsForGroupResponseSync.txt
'updateMembershipsRequest' Message	/examples/updateMembershipsRequestSync.txt
'updateMembershipsResponse' Message	/examples/updateMembershipsResponseSync.txt
'replaceMembershipsRequest' Message	/examples/replaceMembershipsRequestSync.txt
'replaceMembershipsResponse' Message	/examples/replaceMembershipsResponseSync.txt
'changeMembershipsIdentifierRequest' Message	/examples/changeMembershipsIdentifierRequestSync.txt
'changeMembershipsIdentifierResponse' Message	/examples/changeMembershipsIdentifierResponseSync.txt

5. Asynchronous WSDL Binding

5.1 SOAP Specific Service Binding

The key properties of the Specific Service binding files are detailed in Table 5.1. The Service Specific filenames are: 'imsMemberManServiceAsyncReqv1p0.wsdl' (request/acknowledge file) and 'imsMemberManServiceAsyncResv1p0.wsdl' (response/acknowledge file).

Property	Value
Transport Mechanism	SOAPv1.1/HTTPv1.1
Service Name	"PersonManagementServiceAsync"
Service Port Name - Request/acknowledge binding file - Response/acknowledge binding file	"MembershipManagementServiceAsyncReqSoap" "MembershipManagementServiceAsyncResSoap"
Service Binding Name - Request/acknowledge binding file - Response/acknowledge binding file	"MembershipManagementServiceAsyncReqSoap" "MembershipManagementServiceAsyncResSoap"
Binding Type - Request/acknowledge binding file - Response/acknowledge binding file	"MembershipManagementServiceAsyncReq" "MembershipManagementServiceAsyncRes"

5.2 Abstract Definition Binding

The key properties of the Specific Service binding files are detailed in Table 5.2. The Abstract Definitions filenames are: 'imsMemberManAbstractAyncReqv1p0.wsdl' (request/acknowledge file) and 'imsMemberManAbstractAyncResv1p0.wsdl' (response/acknowledge file).

Property	Value
Port Type Name - Request/acknowledge binding file - Response/acknowledge binding file	"MemberManagementServiceAsyncReq" "MemberManagementServiceAsyncRes"

5.3 Message XML Schemas

5.3.1 'createMembershipRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'createMembership()' operation. See 'createMembership()' sub-section of [MemberService, 04].

See sub-section 4.3.1 for the detailed description.

5.3.2 'createMembershipReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'createMembership()' operation request. See 'createMembership()' sub-section of [MemberService, 04].

The <createMembershipReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.3 'createMembershipResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'createMembership()' operation. See 'createMembership()' sub-section of [MemberService, 04].

See sub-section 4.3.2 for the detailed description.

5.3.4 'createMembershipResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'createMembership()' operation request. See 'createMembership()' sub-section of [MemberService, 04].

The <createMembershipResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.5 'createByProxyMembershipRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'createByProxyMembership()' operation. See 'createByProxyMembership()' sub-section of [MemberService, 04].

See sub-section 4.3.3 for the detailed description.

5.3.6 'createByProxyMembershipReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'createByProxyMembership()' operation request. See 'createByProxyMembership()' sub-section of [MemberService, 04].

The <createByProxyMembershipReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.7 'createByProxyMembershipResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'createByProxyMembership()' operation. See 'createByProxyMembership()' sub-section of [MemberService, 04].

See sub-section 4.3.4 for the detailed description.

5.3.8 'createByProxyMembershipResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'createByProxyMembership()' operation request. See 'createByProxyMembership()' sub-section of [MemberService, 04].

The <createByProxyMembershipResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.9 'deleteMembershipRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'deleteMembership()' operation. See 'deleteMembership()' sub-section of [MemberService, 04].

See sub-section 4.3.5 for the detailed description.

5.3.10 'deleteMembershipReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'deleteMembership()' operation request. See 'deleteMembership()' sub-section of [MemberService, 04].

The <deleteMembershipReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.11 'deleteMembershipResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'deleteMembership()' operation. See 'deleteMembership()' sub-section of [MembershipService, 04].

See sub-section 4.3.6 for the detailed description.

5.3.12 'deleteMembershipResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'deleteMembership()' operation request. See 'deleteMembership()' sub-section of [MemberService, 04].

The <deleteMembershipResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.13 'readMembershipRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'readMembership()' operation. See 'readMembership()' sub-section of [MemberService, 04].

See sub-section 4.3.7 for the detailed description.

5.3.14 'readMembershipReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'readMembership()' operation request. See 'readMembership()' sub-section of [MemberService, 04].

The <readMembershipReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.15 'readMembershipResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'readMembership()' operation. See 'readMembership()' sub-section of [MemberService, 04].

See sub-section 4.3.8 for the detailed description.

5.3.16 'readMembershipResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'readMembership()' operation request. See 'readMembership()' sub-section of [MemberService, 04].

The <readMembershipResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.17 'updateMembershipRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'updateMembership()' operation. See 'updateMembership()' sub-section of [MemberService, 04].

See sub-section 4.3.9 for the detailed description.

5.3.18 'updateMembershipReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'updateMembership()' operation request. See 'updateMembership()' sub-section of [MemberService, 04].

The <updateMembershipReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.19 'updateMembershipResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'updateMembership()' operation. See 'updateMembership()' sub-section of [MemberService, 04].

See sub-section 4.3.10 for the detailed description.

5.3.20 'updateMembershipResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'updateMembership()' operation request. See 'updateMembership()' sub-section of [MemberService, 04].

The <updateMembershipResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.21 'replaceMembershipRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'replaceMembership()' operation. See 'replaceMembership()' sub-section of [MemberService, 04].

See sub-section 4.3.11 for the detailed description.

5.3.22 'replaceMembershipReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'replaceMembership()' operation request. See 'replaceMembership()' sub-section of [MemberService, 04].

The <replaceMembershipReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.23 'replaceMembershipResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'replaceMembership()' operation. See 'replaceMembership()' sub-section of [MemberService, 04].

See sub-section 4.3.12 for the detailed description.

5.3.24 'replaceMembershipResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'replaceMembership()' operation request. See 'replaceMembership()' sub-section of [MemberService, 04].

The <replaceMembershipResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.25 'changeMembershipIdentifierRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'changeMembershipIdentifier()' operation. See 'changeMembershipIdentifier()' sub-section of [MemberService, 04].

See sub-section 4.3.13 for the detailed description.

5.3.26 'changeMembershipIdentifierReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'changeMembershipIdentifier()' operation request. See 'changeMembershipIdentifier()' sub-section of [MemberService, 04].

The <changeMembershipIdentifierReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.27 'changeMembershipIdentifierResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'changeMembershipIdentifier()' operation. See 'changeMembershipIdentifier()' sub-section of [MemberService, 04].

See sub-section 4.3.14 for the detailed description.

5.3.28 'changeMembershipIdentifierResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'changeMembershipIdentifier()' operation request. See 'changeMembershipIdentifier()' sub-section of [MemberService, 04].

The <changeMembershipIdentifierResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.29 'createMembershipsRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'createMemberships()' operation. See 'createMemberships()' sub-section of [MemberService, 04].

See sub-section 4.3.15 for the detailed description.

5.3.30 'createMembershipsReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'createMemberships()' operation request. See 'createMemberships()' sub-section of [MemberService, 04].

The <createMembershipsReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.31 'createMembershipsResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'createMemberships()' operation. See 'createMemberships()' sub-section of [MemberService, 04].

See sub-section 4.3.16 for the detailed description.

5.3.32 'createMembershipsResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'createMemberships()' operation request. See 'createMemberships()' sub-section of [MemberService, 04].

The <createMembershipsResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.33 'createByProxyMembershipsRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'createByProxyMemberships()' operation. See 'createByProxyMemberships()' sub-section of [MemberService, 04].

See sub-section 4.3.17 for the detailed description.

5.3.34 'createByProxyMembershipsReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'createByProxyMemberships()' operation request. See 'createByProxyMemberships()' sub-section of [MemberService, 04].

The <createByProxyMembershipsReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.35 'createByProxyMembershipsResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'createByProxyMemberships()' operation. See 'createByProxyMemberships()' sub-section of [MemberService, 04].

See sub-section 4.3.18 for the detailed description.

5.3.36 'createByProxyMembershipsResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'createByProxyMemberships()' operation request. See 'createByProxyMemberships()' sub-section of [MemberService, 04].

The <createByProxyMembershipsResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.37 'deleteMembershipsRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'deleteMemberships()' operation. See 'deleteMemberships()' sub-section of [MemberService, 04].

See sub-section 4.3.19 for the detailed description.

5.3.38 'deleteMembershipsReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'deletesMembership()' operation request. See 'deleteMemberships()' sub-section of [MemberService, 04].

The <deleteMembershipsReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.39 'deleteMembershipsResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'deleteMemberships()' operation. See 'deleteMemberships()' sub-section of [MemberService, 04].

See sub-section 4.3.20 for the detailed description.

5.3.40 'deleteMembershipsResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'deleteMemberships()' operation request. See 'deleteMemberships()' sub-section of [MemberService, 04].

The <deleteMembershipsResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.41 'readMembershipsRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'readMemberships()' operation. See 'readMemberships()' sub-section of [MemberService, 04].

See sub-section 4.3.21 for the detailed description.

5.3.42 'readMembershipsReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'readMemberships()' operation request. See 'readMemberships()' sub-section of [MemberService, 04].

The <readMembershipsReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.43 'readMembershipsResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'readMemberships()' operation. See 'readMemberships()' sub-section of [MemberService, 04].

See sub-section 4.3.22 for the detailed description.

5.3.44 'readMembershipsResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'readMemberships()' operation request. See 'readMemberships()' sub-section of [MemberService, 04].

The <readMembershipsResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.45 'readMembershipsForPersonRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'readMembershipsForPerson()' operation. See 'readMembershipsForPerson()' sub-section of [MemberService, 04].

See sub-section 4.3.23 for the detailed description.

5.3.46 'readMembershipsForPersonReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'readMembershipsForPerson()' operation request. See 'readMembershipsForPerson()' sub-section of [MemberService, 04].

The <readMembershipsForPersonReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.47 'readMembershipsForPersonResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'readMembershipsForPerson()' operation. See 'MembershipsForPerson()' sub-section of [MemberService, 04].

See sub-section 4.3.24 for the detailed description.

5.3.48 'readMembershipsForPersonResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'readMembershipsForPerson()' operation request. See 'readMembershipsForPerson()' sub-section of [MemberService, 04].

The <readMembershipsForPersonResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.49 'readMembershipsForGroupRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'readMembershipsForGroup()' operation. See 'readMembershipsForGroup()' sub-section of [MemberService, 04].

See sub-section 4.3.25 for the detailed description.

5.3.50 'readMembershipsForGroupReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'readMembershipsForGroup()' operation request. See 'readMembershipsForGroup()' sub-section of [MemberService, 04].

The <readMembershipsForGroupReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.51 'readMembershipsForGroupResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'readMembershipsForGroup()' operation. See 'MembershipsForGroup()' sub-section of [MemberService, 04].

See sub-section 4.3.26 for the detailed description.

5.3.52 'readMembershipsForGroupResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'readMembershipsForGroup()' operation request. See 'readMembershipsForGroup()' sub-section of [MemberService, 04].

The <readMembershipsForGroupResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.53 'updateMembershipsRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'updateMemberships()' operation. See 'updateMemberships()' sub-section of [MemberService, 04].

See sub-section 4.3.27 for the detailed description.

5.3.54 'updateMembershipsReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'updateMemberships()' operation request. See 'updateMemberships()' sub-section of [MemberService, 04].

The <updateMembershipsReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.55 'updateMembershipsResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'updateMemberships()' operation. See 'updateMemberships()' sub-section of [MemberService, 04].

See sub-section 4.3.28 for the detailed description.

5.3.56 'updateMembershipsResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'updateMemberships()' operation request. See 'updateMemberships()' sub-section of [MemberService, 04].

The <updateMembershipsResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.57 'replaceMembershipsRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'updateMemberships()' operation. See 'updateMemberships()' sub-section of [MemberService, 04].

See sub-section 4.3.29 for the detailed description.

5.3.58 'replaceMembershipsReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'replaceMemberships()' operation request. See 'replaceMemberships()' sub-section of [MemberService, 04].

The <replaceMembershipsReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.59 'replaceMembershipsResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'replaceMemberships()' operation. See 'replaceMemberships()' sub-section of [MemberService, 04].

See sub-section 4.3.30 for the detailed description.

5.3.60 'replaceMembershipsResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'replaceMemberships()' operation request. See 'replaceMemberships()' sub-section of [MemberService, 04].

The <replaceMembershipsResAcknowledge> element is empty.

Note: Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.61 'changeMembershipsIdentifierRequest' Message

This is the request message from the Reference Agent to the Sync Agent to invoke the 'changeMembershipsIdentifier()' operation. See 'changeMembershipsIdentifier()' sub-section of [MemberService, 04].

See sub-section 4.3.31 for the detailed description.

5.3.62 'changeMembershipsIdentifierReqAcknowledge' Message

This is the request acknowledgement message from the Sync Agent to the Reference Agent to acknowledge the receipt of the 'changeMembershipsIdentifier()' operation request. See 'changeMembershipsIdentifier()' sub-section of [MemberService, 04].

The <changeMembershipsIdentifierReqAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.3.63 'changeMembershipsIdentifierResponse' Message

This is the response message from the Sync Agent to the Reference Agent to complete the 'changeMembershipsIdentifier()' operation. See 'changeMembershipsIdentifier()' sub-section of [MemberService, 04].

See sub-section 4.3.32 for the detailed description.

5.3.64 'changeMembershipsIdentifierResAcknowledge' Message

This is the request acknowledgement message from the Reference Agent to the Sync Agent to acknowledge the receipt of the 'changeMembershipsIdentifier()' operation request. See 'changeMembershipsIdentifier()' sub-section of [MemberService, 04].

The <changeMembershipsIdentifierResAcknowledge> element is empty.

Note: The acknowledge information is returned in the header of the SOAP transport message.

5.4 Example SOAP Messages

The set of example SOAP/HTTP messages are described in Table 5.3.

Property	Value
'createMembershipRequest' Message	/examples/createMembershipRequestAsync.txt
'createMembershipReqAcknowledge' Message	/examples/createMembershipReqAckAsync.txt
'createMembershipResponse' Message	/examples/createMembershipResponseAsync.txt
'createMembershipResAcknowledge' Message	/examples/createMembershipResAckAsync.txt
'createByProxyMembershipRequest' Message	/examples/createByProxyMembershipRequestAsync.txt
'createByProxyMembershipReqAcknowledge' Message	/examples/createByProxyMembershipReqAckAsync.txt
'createByProxyMembershipResponse' Message	/examples/createByProxyMembershipResponseAsync.txt
'createByProxyMembershipResAcknowledge' Message	/examples/createByProxyMembershipResAckAsync.txt
'deleteMembershipRequest' Message	/examples/deleteMembershipRequestAsync.txt
'deleteMembershipReqAcknowledge' Message	/examples/deleteMembershipReqAckAsync.txt
'deleteMembershipResponse' Message	/examples/deleteMembershipResponseAsync.txt
'deleteMembershipResAcknowledge' Message	/examples/deleteMembershipResAckAsync.txt
'readMembershipRequest' Message	/examples/readMembershipRequestAsync.txt
'readMembershipReqAcknowledge' Message	/examples/readMembershipReqAckAsync.txt
'readMembershipResponse' Message	/examples/readMembershipResponseAsync.txt
'readMembershipResAcknowledge' Message	/examples/readMembershipResAckAsync.txt
'updateMembershipRequest' Message	/examples/updateMembershipRequestAsync.txt
'updateMembershipReqAcknowledge' Message	/examples/updateMembershipReqAckAsync.txt
'updateMembershipResponse' Message	/examples/updateMembershipResponseAsync.txt
'updateMembershipResAcknowledge' Message	/examples/updateMembershipResAckAsync.txt
'replaceMembershipRequest' Message	/examples/replaceMembershipRequestAsync.txt
'replaceMembershipReqAcknowledge' Message	/examples/replaceMembershipReqAckAsync.txt
'replaceMembershipResponse' Message	/examples/replaceMembershipResponseAsync.txt
'replaceMembershipResAcknowledge' Message	/examples/replaceMembershipResAckAsync.txt
'changeMembershipIdentifierRequest' Message	/examples/changeMembershipIdentifierRequestAsync.txt
'changeMembershipIdentifierReqAcknowledge' Message	/examples/changeMembershipIdentifierReqAckAsync.txt
'changeMembershipIdentifierResponse' Message	/examples/changeMembershipIdentifierResponseAsync.txt
'changeMembershipIdentifierResAcknowledge' Message	/examples/changeMembershipIdentifierResAckAsync.txt
'createMembershipsRequest' Message	/examples/createMembershipsRequestAsync.txt
'createMembershipsReqAcknowledge' Message	/examples/createMembershipsReqAckAsync.txt
'createMembershipsResponse' Message	/examples/createMembershipsResponseAsync.txt
'createMembershipsResAcknowledge' Message	/examples/createMembershipsResAckAsync.txt
'createByProxyMembershipsRequest' Message	/examples/createByProxyMembershipsRequestAsync.txt
'createByProxyMembershipsReqAcknowledge' Message	/examples/createByProxyMembershipsReqAckAsync.txt
'createByProxyMembershipsResponse' Message	/examples/createByProxyMembershipsResponseAsync.txt
'createByProxyMembershipsResAcknowledge' Message	/examples/createByProxyMembershipsResAckAsync.txt
'deleteMembershipsRequest' Message	/examples/deleteMembershipsRequestAsync.txt
'deleteMembershipsReqAcknowledge' Message	/examples/deleteMembershipsReqAckAsync.txt
'deleteMembershipsResponse' Message	/examples/deleteMembershipsResponseAsync.txt
'deleteMembershipsResAcknowledge' Message	/examples/deleteMembershipsResAckAsync.txt
'readMembershipsRequest' Message	/examples/readMembershipsRequestAsync.txt
'readMembershipsReqAcknowledge' Message	/examples/readMembershipsReqAckAsync.txt
'readMembershipsResponse' Message	/examples/readMembershipsResponseAsync.txt
'readMembershipsResAcknowledge' Message	/examples/readMembershipsResAckAsync.txt
'readMembershipsForPersonRequest' Message	/examples/readMembershipsForPersonRequestAsync.txt
'readMembershipsForPersonReqAcknowledge' Message	/examples/readMembershipsForPersonReqAckAsync.txt
'readMembershipsForPersonResponse' Message	/examples/readMembershipsForPersonResponseAsync.txt
'readMembershipsForPersonResAcknowledge' Message	/examples/readMembershipsForPersonResAckAsync.txt
'readMembershipsForGroupRequest' Message	/examples/readMembershipsForGroupRequestAsync.txt
'readMembershipsForGroupReqAcknowledge' Message	/examples/readMembershipsForGroupReqAckAsync.txt
'readMembershipsForGroupResponse' Message	/examples/readMembershipsForGroupResponseAsync.txt
'readMembershipsForGroupResAcknowledge' Message	/examples/readMembershipsForGroupResAckAsync.txt
'updateMembershipsRequest' Message	/examples/updateMembershipsRequestAsync.txt
'updateMembershipsReqAcknowledge' Message	/examples/updateMembershipsReqAckAsync.txt
'updateMembershipsResponse' Message	/examples/updateMembershipsResponseAsync.txt
'updateMembershipsResAcknowledge' Message	/examples/updateMembershipsResAckAsync.txt
'replaceMembershipsRequest' Message	/examples/replaceMembershipsRequestAsync.txt
'replaceMembershipsReqAcknowledge' Message	/examples/replaceMembershipsReqAckAsync.txt
'replaceMembershipsResponse' Message	/examples/replaceMembershipsResponseAsync.txt
'replaceMembershipsResAcknowledge' Message	/examples/replaceMembershipsResAckAsync.txt
'changeMembershipsIdentifierRequest' Message	/examples/changeMembershipsIdentifierRequestAsync.txt
'changeMembershipsIdentifierReqAcknowledge' Message	/examples/changeMembershipsIdentifierReqAckAsync.txt
'changeMembershipsIdentifierResponse' Message	/examples/changeMembershipsIdentifierResponseAsync.txt
'changeMembershipsIdentifierResAcknowledge' Message	/examples/changeMembershipsIdentifierResAckAsync.txt

Appendix A - Binding WSDL Listings

A1 - Synchronous Binding

The bindings listed below are for the synchronous SOAPv1.1/HTTPv1.1 based implementation. The set of binding files are given in Table A.1. These files can be accessed by 'clicking' on the appropriate file name.

Property	Value
Service Specific File	/mms/wsdl/imsMembershipManServiceSyncv1p0.wsdl
Abstract Definitions File	/mms/wsdl/imsMembershipManAbstractSyncv1p0.wsdl
Messages XSD	/mms/xsd/imsMembershipManMessSchemav1p0.xsd
Data Model XSD	/mms/xsd/imsMembershipManDataSchemav1p0.xsd
Enterprise Common XSD	/enterprise/xsd/imsEnterpriseCommon/Schemav1p0.xsd
Message Binding XSD	/common/xsd/imsMessBindSchemaSchemav1p0.xsd

The bindings listed below are for the asynchronous SOAPv1.1/HTTPv1.1 based implementation. The set of binding files are given in Table A.2. These files can be accessed by 'clicking' on the appropriate file name.

Property	Value
Service Specific File - Request/acknowledge messages - Response/acknowledge messages	/mms/wsdl/imsMembershipManServiceAsyncReqv1p0.wsdl /mms/wsdl/imsMembershipManServiceAsyncResv1p0.wsdl
Abstract Definitions File - Request/acknowledge messages - Response/acknowledge messages	/mms/wsdl/imsMembershipManAbstractAsyncReqv1p0.wsdl /mms/wsdl/imsMembershipManAbstractAsyncResv1p0.wsdl
Messages XSD	/mms/xsd/imsMembershipManMessSchemav1p0.xsd
Data Model XSD	/mms/xsd/imsMembershipManDataSchemav1p0.xsd
Enterprise Common XSD	/enterprise/xsd/imsEnterpriseCommon/Schemav1p0.xsd
Message Binding XSD	/common/xsd/imsMessBindSchemaSchemav1p0.xsd

About This Document

Title	IMS Membership Management Services WSDL Binding
Editor	Colin Smythe (IMS)
Team Co-Lead	Chris Vento (WebCT Inc.)
Version	2.0
Version Date	19 April 2004
Status	Public Draft
Summary	This document presents the IMS Membership Management Services WSDL Binding. The original Enterprise specification was based upon the description of the data model for the information to be exchanged between communicating enterprise systems. The Enterprise Services specification extends this work by adding a series of behavioral models that define how the data models are to be manipulated. The material in this document describes the Web Services Description Language binding of the Membership Management Services Information Model using SOAPv1.1/HTTPv1.1 as the underlying messaging and transport mechanism. This version supersedes the IMS Enterprise v1.1 specifications. The version supersedes v1.0 Public Draft of the IMS Membership Management Services WSDL Binding document.
Revision Information	19 April 2004
Purpose	This document has been approved by the IMS Technical Board is made available for pubic review and comment.
Document Location	http://www.imsglobal.org/es/esv2p0pd/imsmembership_bindv2p0pd.html

To register any comments to the Enterprise Services Project Team about this Public Draft release, please visit: http://www.imsglobal.org/developers/ims/imsforum/categories.cfm?catid=20

List of Contributors

The following individuals contributed to the development of this document:

Name	Organization	Name	Organization
Scott Baker	Oracle Inc.	Les Smith	SCT Inc.
Fred Beshears	UC Berkeley, USA	Colin Smythe	Dunelm Services Ltd.
Kerry Blinco	IMS Australia	Chris Vento	WebCT Inc.
Chris Etesse	Blackboard Inc.	Kimberley Voltero	WebCT Inc.
John Hallet	WebCT Inc.	Scott Wilson	JISC (CETIS), UK
Cathy Schroeder	Microsoft Inc.	Nathaniel Zinn	Blackboard Inc.

Revision History

Version No.	Release Date	Comments
Public Draft 1.0	12 January 2004	The final approved Public Draft Document for the IMS Person Management Services Specification.
Public Draft 2.0	19 April 2004	This is the second formal release of the Public Draft document for the IMS Membership Management Services Specification. The differences to the first release are: a) The asynchronous binding information has been added; b) In the synchronous binding section the example SOAP messages have been replaced by hot text links to external files that contain the examples. There is one file per example; c) The data model descriptions have been placed in their own section; d) Appendix A and B have been combined. The actual listing has been removed and hot text links are used to reference the listing.

Index

A
Abstract Framework 1, 2
API 1
Attributes
     Common

extension 1, 2

recordInfo 1

sourcedId 1, 2, 3, 4, 5, 6

timeFrame 1, 2

userId 1, 2      LangString

text 1      Member

idType 1      Membership

membership 1, 2, 3, 4, 5, 6, 7

memberSourcedId 1, 2, 3      Memebrship

groupSourcedId 1, 2, 3      Person

dataSource 1

email 1      Result

result 1      Role

dateTime 1

roleType 1

status 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

subRole 1      StatusInfo

description 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22      UserId

authentication 1      Values

list 1, 2, 3, 4

B
Binding technologies
     SOAP 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30
     WSDL 1, 2, 3, 4, 5, 6, 7

C
Classes
     Group 1, 2, 3, 4, 5, 6

Description 1, 2, 3, 4      Member 1, 2, 3, 4, 5, 6, 7
     Membership 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16
     Person 1, 2, 3, 4

Name 1, 2 Common Services 1
Conformance 1, 2

E
Enterprise Service 1, 2, 3, 4, 5, 6

G
Group Management Service 1

M
Membership Management Service 1, 2, 3, 4, 5, 6, 7
Messages
     Membership

changeMembershipIdentifierReqAcknowledge 1, 2

changeMembershipIdentifierRequest 1, 2, 3, 4

changeMembershipIdentifierResAcknowledge 1, 2

changeMembershipIdentifierResponse 1, 2, 3, 4

changeMembershipsIdentifierReqAcknowledge 1, 2

changeMembershipsIdentifierRequest 1, 2, 3, 4

changeMembershipsIdentifierResAcknowledge 1, 2

changeMembershipsIdentifierResponse 1, 2, 3, 4

createByProxyMembershipReqAcknowledge 1, 2

createByProxyMembershipRequest 1, 2, 3, 4

createByProxyMembershipResAcknowledge 1, 2

createByProxyMembershipResponse 1, 2, 3, 4

createByProxyMembershipsReqAcknowledge 1, 2, 3

createByProxyMembershipsRequest 1, 2, 3, 4

createByProxyMembershipsResAcknowledge 1, 2

createByProxyMembershipsResponse 1, 2, 3, 4

createMembershipReqAcknowledge 1, 2, 3

createMembershipRequest 1, 2, 3, 4

createMembershipResAcknowledge 1, 2

createMembershipResponse 1, 2, 3, 4

createMembershipsReqAcknowledge 1, 2

createMembershipsRequest 1, 2, 3, 4

createMembershipsResAcknowledge 1, 2

createMembershipsResponse 1, 2, 3, 4

deleteMembershipReqAcknowledge 1, 2

deleteMembershipRequest 1, 2, 3, 4, 5

deleteMembershipResAcknowledge 1, 2

deleteMembershipResponse 1, 2, 3, 4

deleteMembershipsReqAcknowledge 1, 2

deleteMembershipsRequest 1, 2, 3, 4

deleteMembershipsResAcknowledge 1, 2

deleteMembershipsResponse 1, 2, 3, 4

readMembershipReqAcknowledge 1, 2

readMembershipRequest 1, 2, 3, 4

readMembershipResAcknowledge 1, 2

readMembershipResponse 1, 2, 3, 4

readMembershipsForGroupReqAcknowledge 1, 2, 3

readMembershipsForGroupRequest 1, 2, 3, 4

readMembershipsForGroupResAcknowledge 1, 2

readMembershipsForGroupResponse 1, 2, 3, 4

readMembershipsForPersonReqAcknowledge 1, 2

readMembershipsForPersonRequest 1, 2, 3, 4

readMembershipsForPersonResAcknowledge 1, 2

readMembershipsForPersonResponse 1, 2, 3, 4

readMembershipsReqAcknowledge 1, 2

readMembershipsRequest 1, 2, 3, 4

readMembershipsResAcknowledge 1, 2

readMembershipsResponse 1, 2, 3, 4

replaceMembershipReqAcknowledge 1, 2

replaceMembershipRequest 1, 2, 3, 4

replaceMembershipResAcknowledge 1, 2

replaceMembershipResponse 1, 2, 3, 4, 5

replaceMembershipsReqAcknowledge 1, 2

replaceMembershipsRequest 1, 2, 3, 4

replaceMembershipsResAcknowledge 1, 2

replaceMembershipsResponse 1, 2, 3, 4

updateMembershipReqAcknowledge 1, 2, 3

updateMembershipRequest 1, 2, 3, 4

updateMembershipResAcknowledge 1, 2

updateMembershipResponse 1, 2, 3, 4

updateMembershipsReqAcknowledge 1, 2

updateMembershipsRequest 1, 2, 3, 4, 5

updateMembershipsResAcknowledge 1, 2

updateMembershipsResponse 1, 2, 3, 4

O
OCL 1, 2, 3, 4
Operations
     Membership

changeMembershipIdentifier 1, 2

changeMembershipsIdentifier 1, 2, 3

createByProxyMembership 1, 2, 3

createByProxyMemberships 1, 2, 3

createMembership 1, 2, 3, 4

createMemberships 1, 2, 3

deleteMembership 1, 2, 3

deleteMemberships 1, 2, 3, 4

readMembership 1, 2

readMemberships 1, 2

readMembershipsForGroup 1, 2, 3

readMembershipsForPerson 1, 2, 3

replaceMembership 1, 2, 3, 4, 5, 6, 7

replaceMemberships 1, 2

updateMembership 1, 2, 3

updateMemberships 1, 2, 3, 4

P
Person Management Service 1, 2, 3

S
Services
     Group Management 1
     Membership Management 1, 2, 3, 4, 5, 6, 7
     Person Management 1, 2, 3
SOAP 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30

W
WDSL 1, 2, 3, 4, 5, 6, 7