![]() |
IMS Membership Management Services WSDL Binding Version 1.0 Final Specification |
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: 11 June 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 © 2004 IMS Global Learning Consortium. All Rights Reserved.
If you wish to copy or distribute this document, you must complete a valid Registered User license registration with IMS and receive an email from IMS granting the license to distribute the specification. 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 Registered Users who have 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 project 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/license.html.
The limited permissions granted above are perpetual and will not be revoked by IMS or its successors or assigns.
THIS SPECIFICATION IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NONINFRINGEMENT IS EXPRESSLY DISCLAIMED. ANY USE OF THIS SPECIFICATION SHALL BE MADE ENTIRELY AT THE IMPLEMENTER'S OWN RISK, AND NEITHER THE CONSORTIUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS SPECIFICATION.
The Membership Management Services specification [MemberServices, 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:
This document is the IMS Membership Management Services WSDL Binding v1.0 and as such it is used in conjunction with the following documents:
As such the Membership Management Services specification supersedes the original Enterprise specifications:
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].
The structure of this document is:
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 |
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:
The name spaces used within these bindings are listed in Table 2.1.
Note: At the time of publication the Asynchronous Binding had not been tested. The details for creating the Asynchronous Binding are available in the IMS Membership Management Service WSDL Binding V2.0 Public Draft document. The Asynchronous Binding details will be issued in V2.0 of this document once testing has been completed.
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 [MemberServices, 04].
See Table 4.1 and the OCL definitions in sub-section 4.1.4 [MemberServices, 04].
The XSD visualization of the <member> 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 [MemberServices, 04].
See Table 4.3 and the OCL definitions in sub-section 4.1.4 [MemberServices, 04].
See Table 4.3 and the OCL definitions in sub-section 4.1.4 [MemberServices, 04].
The XSD visualization of the <role> 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 [MemberServices, 04].
See Table 4.5 and the OCL definitions in sub-section 4.1.4 [MemberServices, 04].
See Table 4.5 and the OCL definitions in sub-section 4.1.4 [MemberServices, 04].
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 [MemberServices, 04].
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 [MemberServices, 04].
See Table 4.5 and the OCL definitions in sub-section 4.1.4 [MemberServices, 04].
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 [MemberServices, 04].
See Table 4.5 and the OCL definitions in sub-section 4.1.4 [MemberServices, 04].
See Table 4.5 and the OCL definitions in sub-section 4.1.4 [MemberServices, 04].
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 [MemberServices, 04].
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 [MemberServices, 04].
See Table 4.5 and the OCL definitions in sub-section 4.1.4 [MemberServices, 04].
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 [MemberServices, 04].
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 [MemberServices, 04].
The XSD visualization of the <membershipIdPair> 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 [MemberServices, 04].
The XSD visualization of the <membershipIdPairSet> 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 [MemberServices, 04].
The XSD visualization of the <sourcedIdSet> data model is shown in Figure 3.13.
The XSD visualization of the <pairSourcedIdSet> data model is shown in Figure 3.14. This is the XML equivalent of the UML description in Figure 4.2 [CommonData, 04].
The key properties of the Specific Service binding files are detailed in Table 4.1. The Service Specific filename is: 'imsMemberManServiceSyncv1p0.wsdl'.
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" |
This is the request message from the Reference Agent to the Sync Agent to invoke the 'createMembership()' operation. See 'createMembership()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'createMembership()' operation. See 'createMembership()' sub-section of [MemberServices, 04].
The <createMembershipResponse> element is empty.
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'createByProxyMembership()' operation. See 'createByProxyMembership()' sub-section of [MemberServices, 04].
Three parameters are supplied:
This is the response message from the Sync Agent to the Reference Agent to complete the 'createByProxyMembership()' operation. See 'createByProxyMembership()' sub-section of [MemberServices, 04].
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'deleteMembership()' operation. See 'deleteMembership()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'deleteMembership()' operation. See 'deleteMembership()' sub-section of [MemberServices, 04].
The <deleteMembershipResponse> element is empty.
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'readMembership()' operation. See 'readMembership()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'readMembership()' operation. See 'readMembership()' sub-section of [MemberServices, 04].
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'updateMembership()' operation. See 'updateMembership()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'updateMembership()' operation. See 'updateMembership()' sub-section of [MemberServices, 04].
The <updateMembershipResponse> element is empty.
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'replaceMembership()' operation. See 'replaceMembership()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'replaceMembership()' operation. See 'replaceMembership()' sub-section of [MemberServices, 04].
The <replaceMembershipResponse> element is empty.
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'changeMembershipIdentifier()' operation. See 'changeMembershipIdentifier()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'changeMembershipIdentifier()' operation. See 'changeMembershipIdentifier()' sub-section of [MemberServices, 04].
The <changeMembershipIdentifierResponse> element is empty.
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'createMemberships()' operation. See 'createMemberships()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'createMemberships()' operation. See 'createMemberships()' sub-section of [MemberServices, 04].
The <createMembershipsResponse> element is empty.
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'createByProxyMemberships()' operation. See 'createByProxyMemberships()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'createByProxyMemberships()' operation. See 'createByProxyMemberships()' sub-section of [MemberServices, 04].
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'deleteMemberships()' operation. See 'deleteMemberships()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'deleteMemberships()' operation. See 'deleteMemberships()' sub-section of [MemberServices, 04].
The <deleteMembershipsResponse> element is empty.
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'readMemberships()' operation. See 'readMemberships()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'readMemberships()' operation. See 'readMemberships()' sub-section of [MemberServices, 04].
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'readMembershipsForPerson()' operation. See 'readMembershipsForPerson()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'readMembershipsForPerson()' operation. See 'MembershipsForPerson()' sub-section of [MemberServices, 04].
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'readMembershipsForGroup()' operation. See 'readMembershipsForGroup()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'readMembershipsForGroup()' operation. See 'MembershipsForGroup()' sub-section of [MemberServices, 04].
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'updateMemberships()' operation. See 'updateMemberships()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'updateMemberships()' operation. See 'updateMemberships()' sub-section of [MemberServices, 04].
The <updateMembershipsResponse> element is empty.
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'updateMemberships()' operation. See 'updateMemberships()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'replaceMemberships()' operation. See 'replaceMemberships()' sub-section of [MemberServices, 04].
The <replaceMembershipsResponse> element is empty.
Note: The status information is returned in the header of the SOAP transport message.
This is the request message from the Reference Agent to the Sync Agent to invoke the 'changeMembershipsIdentifier()' operation. See 'changeMembershipsIdentifier()' sub-section of [MemberServices, 04].
This is the response message from the Sync Agent to the Reference Agent to complete the 'changeMembershipsIdentifier()' operation. See 'changeMembershipsIdentifier()' sub-section of [MemberServices, 04].
The <changeMembershipsIdentifierResponse> element is empty.
Note: The status information is returned in the header of the SOAP transport message.
The set of example SOAP/HTTP messages are described in Table 4.3. The 'Example File' entries are hot-text links to the files themselves.
Note: At the time of publication the Asynchronous Binding had not been tested. The details for creating the Asynchronous Binding are available in the IMS Membership Management Service WSDL Binding V2.0 Public Draft document. The Asynchronous Binding details will be issued in V2.0 of this document once testing has been completed.
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/imsMemberManServiceSync_v1p0.wsdl |
Abstract Definitions
File |
/mms/wsdl/imsMemberManAbstractSync_v1p0.wsdl |
Messages XSD |
/mms/xsd/imsMemberManMessSchema_v1p0.xsd |
Data Model XSD |
/mms/xsd/imsMemberManDataSchema_v1p0.xsd |
Enterprise Common
XSD |
/services/common/imsCommonSchema_v1p0.xsd |
Message Binding
XSD |
/services/common/imsMessBindSchema_v1p0.xsd |
Note: At the time of publication the Asynchronous Binding had not been tested. The details for creating the Asynchronous Binding are available in the IMS Membership Management Service WSDL Binding V2.0 Public Draft document. The Asynchronous Binding details will be issued in V2.0 of this document once testing has been completed.
Title |
IMS Membership
Management Services WSDL Binding |
Editor |
Colin Smythe (IMS) |
Team
Co-Lead |
Chris Vento (WebCT
Inc.) |
Version |
1.0 |
Version
Date |
11 June 2004 |
Status |
Final
Specification |
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 behavioural
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. |
Revision
Information |
11 June 2004 |
Purpose |
This document has been
approved by the IMS Technical Board and is made available for
adoption. |
Document
Location |
http://www.imsglobal.org/es/esv1p0/imsmembership_bindv1p0.html |
To register any
comments or questions about this specification please visit:
http://www.imsglobal.org/developers/ims/imsforum/categories.cfm?catid=20 |
The following individuals contributed to the development of this document:
A
Abstract Framework 1, 2
API 1
Attributes
Common
recordInfo 1
text 1 Member
idType 1 Membership
membership 1, 2, 3, 4, 5, 6, 7, 8
memberSourcedId 1, 2 Memebrship
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 UserId
authentication 1 Values
B
Binding technologies
SOAP 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
WSDL 1, 2, 3, 4, 5, 6, 7, 8
Description 1, 2, 3 Member 1, 2, 3, 4
Membership 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17
Person 1, 2, 3
Name 1 Common Services 1
Conformance 1, 2
E
Enterprise Service 1, 2, 3, 4, 5
G
Group Management Service 1
M
Membership Management Service 1, 2, 3, 4, 5, 6, 7, 8
Messages
Membership
changeMembershipIdentifierRequest 1, 2, 3
changeMembershipIdentifierResponse 1, 2
changeMembershipsIdentifierRequest 1, 2
changeMembershipsIdentifierResponse 1, 2
createByProxyMembershipRequest 1, 2
createByProxyMembershipResponse 1, 2
createByProxyMembershipsRequest 1, 2
createByProxyMembershipsResponse 1, 2
createMembershipResponse 1, 2, 3
createMembershipsResponse 1, 2, 3
deleteMembershipsResponse 1, 2, 3
readMembershipsForGroupRequest 1, 2
readMembershipsForGroupResponse 1, 2
readMembershipsForPersonRequest 1, 2
readMembershipsForPersonResponse 1, 2
replaceMembershipResponse 1, 2
replaceMembershipsRequest 1, 2
replaceMembershipsResponse 1, 2
updateMembershipsResponse 1, 2
O
OCL 1, 2, 3, 4
Operations
Membership
changeMembershipIdentifier 1, 2
changeMembershipsIdentifier 1, 2
createByProxyMembership 1
createByProxyMemberships 1
createMembership 1
createMemberships 1
deleteMemberships 1
readMembership 1
readMemberships 1
readMembershipsForGroup 1
replaceMemberships 1
P
Person Management Service 1, 2, 3
S
Services
Group Management 1
Membership Management 1, 2, 3, 4, 5, 6, 7, 8
Person Management 1, 2, 3
SOAP 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
IMS Global Learning Consortium, Inc.
("IMS") is publishing the information contained in this IMS
Membership Management Services WSDL Binding ("Specification")
for purposes of scientific, experimental, and scholarly
collaboration only.
IMS makes no warranty or representation regarding the accuracy or
completeness of the Specification.
This material is provided on an "As Is" and "As Available"
basis.
The Specification is at all times subject to change and revision
without notice.
It is your sole responsibility to evaluate the usefulness,
accuracy, and completeness of the Specification as it relates to
you.
IMS would appreciate receiving your comments and suggestions.
Please contact IMS through our website at http://www.imsglobal.org
Please refer to Document Name: IMS Membership Management
Services WSDL Binding Revision: 11 June 2004