|
1EdTech GLC Membership Management Service WSDL/XSD Binding
Version 2.0 Final Release Specification
Final 1.0
|
Date Issued: 30 June 2011
Latest version: /lis/
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.
1EdTech 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 1EdTech's procedures with respect to rights in 1EdTech specifications can be found at the 1EdTech Intellectual Property Rights web page: /imsipr_policyFinal.pdf.
Copyright © 2011 1EdTech Consortium. All Rights Reserved.
If you wish to copy or distribute this document, you must complete a valid Registered User license registration with 1EdTech and receive an email from 1EdTech granting the license to distribute the specification. To register, follow the instructions on the 1EdTech website: /specificationdownload.cfm
This document may be copied and furnished to others by Registered Users who have registered on the 1EdTech 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 1EdTech, except as needed for the purpose of developing 1EdTech specifications, under the auspices of a chartered 1EdTech project group.
Use of this specification to develop products or services is governed by the license with 1EdTech found on the 1EdTech website: /license.html
The limited permissions granted above are perpetual and will not be revoked by 1EdTech 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.
Table of Contents
- Introduction
- Scope and Context
- Structure of this Document
- Nomenclature
- References
- Platform Specific Model of the Binding
- Service Description
- Data for the Servce Operations
- Membership Data Model
- File-based Exchange Data Model
- Application of the Binding Guidelines
- WSDL File Documentation
- Overview
- Messages
- XSD File Documentation
- Service Data Model
- File Data Model
- Binding of the Vocabularies
- Appendix A - Listing of the WSDLs
- Appendix B - Listing of the XSDs
- Appendix C - Vocabulary VDEX Instance File Listings
- Appendix D - Example SOAP Messages
- About This Document
- Revision History
1. Introduction
This document is a part of the 1EdTech GLC Membership Management Service (MMS) v2.0 specification. The binding details how the Membership Management Service Information Model is realised as a Web Service; in the form of a Web Services Description Language (WSDL) file. The MMS binding is contained in a set of WSDL, XSD and vocabulary files. The vocabulary files are instances of the 1EdTech Vocabulary Definition Exchange specification [VDEX, 04a], [VDEX, 04b]. The 1EdTech GLC Learning Information Services (LIS) Best Practice and Implementation Guide [LIS, 11b] provides non-normative guidance on how to use the Binding and Information Model. For a conceptual overview of the LIS Specification, please see the overall services description [LIS, 11a]. For a discussion of potential applications, see the Best Practice Guide.
1.1 Scope and Context
The 1EdTech GLC MMS WSDL Binding v2.0 is used in conjunction with the following documents:
- 1EdTech GLC Membership Management Service Information Model v2.0 [MMS, 11] – the behaviour and data model definition of the Membership Management Service;
- 1EdTech GLC Learning Information Services Best Practice and Implementation Guide v1.0 [LIS, 11b] – key information on how to adopt and implement the specification.
As such the Membership Management Services specification supersedes the original Enterprise Services specifications:
- 1EdTech GLC Membership Management Services Information Model Final Specification v1.0 [MMS, 04a];
- 1EdTech GLC Membership Management Services WSDL Binding Final Specification v1.0 [MMS, 04b].
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 1EdTech GLC General Web Services documents [GWS, 06a], [GWS, 06b]. The WSDL is created using the IMC GLC Binding Auto-generation Tool-kit (I-BAT) [I-BAT, 06].
1.2 Structure of this Document
The structure of this document is:
2. Platform Specific Model of the Binding |
The description platform specific models in the form of the 1EdTech GLC UML-Profile service/data models representation of the 1EdTech GLC GMS specification information model. This representation is used by the 1EdTech GLC I-BAT tool to auto-generate the corresponding WSDL/XSDs; |
3. Application of the Binding Guidelines |
Explanation of how the platform specific model is realised as the WSDL/XSD binding. This addresses how the information model is realised as a Web Service; |
4. WSDL File Documentation |
The description of the Web Services used to realise the service model components of the binding. This part of the binding document was created using the schema documentation tool provided as part of the Oxygen 12.2 product; |
5. XSD File Documentation |
The description of the elements used within the data model components of the binding. This part of the binding document was created using the schema documentation tool provided as part of the Oxygen 12.2 product; |
6. Vocabulary Binding Using VDEX Instances |
Contains the description of how the set of external vocabulary files realised as VDEX files; |
Appendix A - Listing of the WSDL Files |
This is the full listing of the MMS WSDL files; |
Appendix B - Listing of the XSD Files |
This is the full listing of the MMS XSD files; |
Appendix C - Vocabulary VDEX Instance File Listings |
This is the full listing of the set of external vocabulary VDEX instance files; |
Appendix D - Examples SOAP Messages |
Examples of the SOAP messages that are exchanged to realise the service. |
1.3 Nomenclature
BDEMS |
Bulk Data Exchnage Management Service |
HTTP |
HyperText Transfer Protocol |
I-BAT |
1EdTech GLC Binding Auto-generation Tool-kit |
1EdTech GLC |
1EdTech Consortium |
LIS |
Learning Information Services |
MDA |
Model Driven Architecture |
MMS |
Membership Management Service |
PIM |
Protocol Independent Model |
PSM |
Platform Specific Model |
UML |
Unified Modelling Language |
VDEX |
Vocabulary Definition Exchange |
W3C |
World Wide Web Consortium |
WSDL |
Wed Services Description Language |
XMI |
XML Meta-data Interchange |
XML |
Extensible Mark-up Language |
XSD |
XML Schema Definition |
XSL |
Extensible Stylesheet Language |
XSLT |
XSL Transformations |
1.4 References
[GWS, 06a] |
1EdTech GLC General Web Services Base Profile Specification Final Release v1.0, C.Schroeder, J.Simon and C.Smythe, 1EdTech Consortium, January 2006. |
[GWS, 06b] |
1EdTech GLC General Web Services WSDL Binding Guidelines Final Release v1.0, C.Schroeder, J.Simon and C.Smythe, 1EdTech Consortium, January 2006. |
[I-BAT, 06] |
1EdTech Binding Auto-generation Toolkit Manual v1.0, C.Smythe, 1EdTech Consortium, July 2006. |
[LIS, 11a] |
1EdTech GLC Learning Information Services v2.0 Specification Final Release v1.0, L.Feng, B.Lee and C.Smythe, 1EdTech Consortium, June 2011. |
[LIS, 11b] |
1EdTech GLC Learning Information Services v2.0 Best Practice and Implementation Guide Final Release v1.0, L.Feng, B.Lee and C.Smythe, 1EdTech Consortium, June 2011. |
[MMS, 04a] |
1EdTech GLC Membership Management Services Information Model Specification Final Release v1.0, C.Vento and C.Smythe, 1EdTech Consortium, June 2004. |
[MMS, 04b] |
1EdTech GLC Membership Management Services WSDL Binding Specification Final Release v1.0, C.Vento and C.Smythe, 1EdTech Consortium, June 2004. |
[MMS, 11] |
1EdTech GLC Group Management Services v2.0 Information Model Specification Final Release v1.0, L.Feng, B.Lee and C.Smythe, 1EdTech Consortium, June 2011. |
[SDN11, 06] |
1EdTech GLC Specification Note 11: Vocabulary Definition, Registration & Maintenance Procedures, C.Smythe, 1EdTech Consortium, October 2006. |
[VDEX, 04a] |
1EdTech Vocabulary Definition Exchange Information Model Specification Final Release v1.0, A.Cooper, 1EdTech Consortium, February 2004. |
[VDEX, 04b] |
1EdTech Vocabulary Definition Exchange XML Binding Specification Final Release v1.0, A.Cooper, 1EdTech Consortium, February 2004. |
2. Platform Specific Model of the Binding
2.1 Service Description
Figure 2.1 is the PSM of the service group model description for the MMS. This information is used to establish the mapping to the binding flavors of WSDL.
Figure 2.1 The PSM representation of the service group model description for the GMS.
Figure 2.2 is the PSM of the service model description for the MMS. The PSM is derived from the Platform Independent Model that was documented within the information model for the MMS specification [MMS, 11].
Figure 2.2 The PSM representation of the service model description for the MMS.
2.2 Data for the Service Operations
The data model for the service operations is shown in Figure 2.3 and 2.4. Figure 2.3 shows the data models for the set of parameters. Figure 2.4 is the data model for the Status Information and other WSDL-specific binding data structures.
Figure 2.3 The PSM representation of the parameters data model description for the MMS.
Figure 2.4 The PSM representation of the status information data model description for the MMS.
2.3 Membership Data Model
The PSM for the Membership data models are shown in Figures 2.5 and 2.6. Figure 2.5 is the Group data model and Figure 2.6 contains the set of common data model classes.
Figure 2.5 The PSM representation of the Membership data model description for the MMS.
Figure 2.6 The PSM representation of the common data models description for the MMS.
2.4 File-based Data Exchange Data Model
The PSM for the file-based Membership data models are shown in Figures 2.7 and 2.8. Figure 2.7 is the MembershipRecord data model and Figure 2.8 contains the set of common data model classes.
Figure 2.7 The PSM representation of the MembershipRecord data model description for file storage in the MMS.
Figure 2.8 The PSM representation of the common data model descriptions for file storage in the MMS.
3. Application of the Binding Guidelines
The WSDL/XSD bindings have been generated using the methodology documented in [GWS 06a] and [GWS, 06b]. Only the synchronous service binding has been created. The binding files are available in two forms:
- A single combined WSDL/XSD – MembershipManagementServiceSyncSingle.wsdl;
- Separated WSDL and XSD files – MembershipManagementServiceSyncWSDL.wsdl and MembershipManagementServiceSyncXSD.xsd respectively.
It is recommended that only the combined form is used (many WSDL-based code generation tools do not process the 'import' instructions).
The mapping between the PIM and PSM descriptions is detailed in Table 3.1.
Table 3.1 Mapping between the PIM, PSM and XSD descriptions for the data models.
PSM Reference |
PIM Reference |
XSD Reference |
Name |
UML Type |
Figure |
Type |
Table |
Name |
Type |
MembershipRecordSet
|
Class |
2.5 |
MembershipRecordSet |
– |
MembershipRecordSet.Type |
ComplexType |
|
Attribute |
2.5 |
MembershipRecord |
5.3 |
membershipRecord |
Element |
MembershipRecord
|
Class |
2.5 |
– |
5.4 |
MembershipRecord.Type |
ComplexType |
|
Attribute |
2.5 |
SourcedGUID |
5.6 |
sourcedGUID |
Element |
|
Attribute |
2.5 |
Membership |
5.3 |
membership |
Element |
SourcedGUID |
Class |
2.5 |
– |
5.6 |
SourcedGUID.Type |
ComplexType |
|
Attribute |
2.5 |
NormalizedString |
5.7 |
refAgentInstanceID |
Element |
|
Attribute |
2.5 |
GUID |
5.8 |
sourcedId |
Element |
Membership
|
Class |
2.5 |
– |
5.15 |
Membership.Type |
ComplexType |
|
Attribute |
2.5 |
GUID |
5.16 |
collectionSourcedId |
Element |
|
Attribute |
2.5 |
Enumerated |
5.17 |
membershipIdType |
Element |
|
Attribute |
2.5 |
Member |
5.18 |
member |
Element |
|
Attribute |
2.5 |
GUID |
5.19 |
dataSource |
Element |
Member
|
Class |
2.5 |
– |
5.20 |
Member.Type |
ComplexType |
|
Attribute |
2.5 |
GUID |
5.21 |
personSourcedId |
Element |
|
Attribute |
2.5 |
Role |
5.22 |
role |
Element |
Role
|
Class |
2.5 |
– |
5.23 |
Role.Type |
ComplexType |
|
Attribute |
2.5 |
Enumerated |
5.24 |
roleType |
Element |
|
Attribute |
2.5 |
Enumerated |
5.25 |
subRole |
Element |
|
Attribute |
2.5 |
TimeFrame |
5.26 |
timeFrame |
Element |
|
Attribute |
2.5 |
Enumerated |
5.27 |
status |
Element |
|
Attribute |
2.5 |
DateTime |
5.28 |
dateTime |
Element |
|
Attribute |
2.5 |
Integer |
5.29 |
integer |
Element |
|
Attribute |
2.5 |
GUID |
5.30 |
dataSource |
Element |
|
Attribute |
2.5 |
Metadata |
5.31 |
recordInfo |
Element |
|
Attribute |
2.5 |
IMSExtension |
5.32 |
extension |
Element |
TimeFrame
|
Class |
2.6 |
– |
5.33 |
TimeFrame.Type |
ComplexType |
|
Attribute |
2.6 |
DateTime |
5.34 |
begin |
Element |
|
Attribute |
2.6 |
DateTime |
5.35 |
end |
Element |
|
Attribute |
2.6 |
Boolean |
5.36 |
restrict |
Element |
|
Attribute |
2.6 |
Text |
5.37 |
adminPeriod |
Element |
Metadata
|
Class |
2.6 |
– |
5.41 |
Metadata.Type |
ComplexType |
|
Attribute |
2.6 |
AnyURI |
5.42 |
metadataNameVocabulary |
Element |
|
Attribute |
2.6 |
AnyURI |
5.43 |
metadataTypeVocabulary |
Element |
|
Attribute |
2.6 |
ExtensionField |
5.44 |
metadataField |
Element |
IMSExtension
|
Class |
2.6 |
– |
5.45 |
IMSExtension.Type |
ComplexType |
|
Attribute |
2.6 |
AnyURI |
5.46 |
extensionNameVocabulary |
Element |
|
Attribute |
2.6 |
AnyURI |
5.47 |
extensionTypeVocabulary |
Element |
|
Attribute |
2.6 |
ExtensionField |
5.48 |
extensionField |
Element |
ExtensionField
|
Class |
2.6 |
– |
5.49 |
ExtensionField.Type |
ComplexType |
|
Attribute |
2.6 |
NormalisedString |
5.50 |
fieldName |
Element |
|
Attribute |
2.6 |
NormalisedString |
5.51 |
fieldType |
Element |
|
Attribute |
2.6 |
NormalisedString |
5.52 |
fieldValue |
Element |
Text
|
Class |
2.6 |
– |
5.38 |
Text.Type |
ComplexType |
|
Attribute |
2.6 |
NormalisedString |
5.39 |
language |
Element |
|
Attribute |
2.6 |
String |
5.40 |
textString |
Element |
imsx_StatusInfo
|
Class |
2.4 |
– |
See 1EdTech GWSv1.0 |
imsx_StatusInfo.Type |
ComplexType |
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_codeMajor |
Element |
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_severity |
Element |
- imsx_messageRefIdentifier
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_messageRefIdentifier |
Element |
- imsx_operationRefIdentifier
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_operationRefIdentifier |
Element |
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_description |
Element |
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_codeMinor |
Element |
imsx_CodeMinor
|
Class |
2.4 |
– |
See 1EdTech GWSv1.0 |
imsx_CodeMinor.Type |
ComplexType |
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_codeMinorField |
Element |
imsx_CodeMinorField
|
Class |
2.4 |
– |
See 1EdTech GWSv1.0 |
imsx_CodeMinorField.Type |
ComplexType |
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_codeMinorFieldName |
Element |
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_codeMinorFieldValue |
Element |
imsx_StatusBinding
|
Class |
2.4 |
– |
See 1EdTech GWSv1.0 |
imsx_StatusBinding.Type |
ComplexType |
- imsx_syncRequestHeaderInfo
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_syncRequestHeaderInfo |
Element |
- imsx_syncResponseHeaderInfo
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_syncResponseHeaderInfo |
Element |
imsx_RequestHeaderInfo
|
Class |
2.4 |
– |
See 1EdTech GWSv1.0 |
imsx_RequestHeaderInfo.Type |
ComplexType |
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_version |
Element |
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_messageIdentifier |
Element |
imsx_ResponseHeaderInfo
|
Class |
2.4 |
– |
See 1EdTech GWSv1.0 |
imsx_ResponseHeaderInfo.Type |
ComplexType |
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_version |
Element |
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_messageIdentifier |
Element |
|
Attribute |
2.4 |
n/a |
See 1EdTech GWSv1.0 |
imsx_statusInfo |
Element |
Key:
- The 'PSM Reference' field refers to information in the PSM description (Section 2 in this document). The sub-fields are:
- Name – the name of the data structure in the PSM and PIM
- UML Type – the type of UML construct i.e. either Class or Attribute
- Figure – the reference Figure number in this document;
- The 'PIM Reference' field refers to infomation in the MMS Information Model [MMS, 11]. The sub-fields are:
- Type – the type of the data structure in the Information Model
- Table – the reference number of Tabular description in the corresponding Information Model document;
- The 'XSD Reference' field refers to infrmation in the XSD descriptions (Section 5 in this document). The sub-fields are:
- Name – the name of the field in the XSD(s)
- Type – the type of XSD construct i.e. either a ComplexType or Element.
4. WSDL File Documentation
WSDL file: "MemberhipManagementServiceSyncSingle.wsdl"
Target namespace: /services/lis/mms2p0/wsdl11/sync/imsmms_v2p0
4.1 Overview
|
|
|
Messages |
createMembershipRequest, createMembershipResponse, createByProxyMembershipRequest, createByProxyMembershipResponse, deleteMembershipRequest, deleteMembershipResponse, readMembershipRequest, readMembershipResponse, readAllMembershipIdsRequest, readAllMembershipIdsResponse, readMembershipIdsFromSavePointRequest, readMembershipIdsFromSavePointResponse, readMembershipIdsForPersonRequest, readMembershipIdsForPersonResponse, readMembershipIdsForPersonWithRoleRequest, readMembershipIdsForPersonWithRoleResponse, readMembershipIdsForCollectionRequest, readMembershipIdsForCollectionResponse, readMembershipsRequest, readMembershipsResponse, readMembershipsFromSavePointRequest, readMembershipsFromSavePointResponse, updateMembershipRequest, updateMembershipResponse, replaceMembershipRequest, replaceMembershipResponse, discoverMembershipIdsRequest, discoverMembershipIdsResponse, changeMembershipIdentifierRequest, changeMembershipIdentifierResponse, |
|
WSDL Definition |
Name |
Documentation |
MembershipManagementServiceSyncServices |
WSDLv1.1 File Information
Services: MembershipManagementService (Synchronous Communications)
Author: Colin Smythe
Date: 30 June 2011
Version: 1.0
Status: Final Release
Description: The Membership Management Service. This forms a part of the 1EdTech Learning Information Services v2.0 specification.
History: Version 2.0: This is the first formal release of this service. This supercedes the MMSv1.0 which was produced as part of the Enterprise Services v1.0 specification.
WSDL Binding: WSDL Binding is based upon the 1EdTech GLC General Web Services Base Profile v1.0 The 1EdTech GLC GWS Basic Profile is derived from the WS-I Basic Profile v1.1. This profile uses: WSDL 1.1, SOAP 1.1, HTTP 1.1 and XML 1.0. Extension profiles to the 1EdTech GLC GWS Base Profile are available but are not supported using this tool version.
License: IPR, License and Distribution Notices
This machine readable file is derived from 1EdTech Consortium (GLC) specification 1EdTech GLC Membership Management Service Version 2.0 found at /lis/mmsv2p0/imsmmsv2p0_Infov1.pdf and the original 1EdTech schema binding or code base /lis/mmsv2p0/immsv2p0_Bindv1.html.
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 the schema binding contained in this document. 1EdTech GLC 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 1EdTech GLCs procedures with respect to rights in 1EdTech GLC specifications can be found at the 1EdTech GLC Intellectual Property Rights web page: /ipr/imsipr_policyFinal.pdf.
Copyright (c) 1EdTech Consortium 1999-2011. All Rights Reserved.
License Notice for Users
Users of products or services that include this document are hereby granted a worldwide, royalty-free, non-exclusive license to use this document.
Distribution Notice for Developers
Developers of products or services that are not original incorporators of this document and have not changed this document, that is, are distributing a software product that incorporates this document as is from a third-party source other than 1EdTech, are hereby granted permission to copy, display and distribute the contents of this document in any medium for any purpose without fee or royalty provided that you include this IPR, License and Distribution notice in its entirety on ALL copies, or portions thereof.
Developers of products or services that are original incorporators of this document and wish to provide distribution of this document as is or with modifications and developers of products and services that are not original incorporators of this document and have changed this document, are required to register with the 1EdTech GLC community on the 1EdTech GLC website as described in the following two paragraphs:-
- If you wish to distribute this document as is, with no modifications, you are hereby granted permission to copy, display and distribute the contents of this document in any medium for any purpose without fee or royalty provided that you include this IPR, License and Distribution notice in its entirety on ALL copies, or portions thereof, that you make and you complete a valid license registration with 1EdTech and receive an email from 1EdTech granting the license. To register, follow the instructions on the 1EdTech website: /specificationdownload.cfm. Once registered you are granted permission to transfer unlimited distribution rights of this document for the purposes of third-party or other distribution of your product or service that incorporates this document as long as this IPR, License and Distribution notice remains in place in its entirety;
- If you wish to create and distribute a derived work from this document, you are hereby granted permission to copy, display and distribute the contents of the derived work in any medium for any purpose without fee or royalty provided that you include this IPR, License and Distribution notice in its entirety on ALL copies, or portions thereof, that you make and you complete a valid profile registration with 1EdTech GLC and receive an email from 1EdTech GLC granting the license. To register, follow the instructions on the 1EdTech GLC website: /profile/. Once registered you are granted permission to transfer unlimited distribution rights of the derived work for the purposes of third-party or other distribution of your product or service that incorporates the derived work as long as this IPR, License and Distribution notice remains in place in its entirety.
The limited permissions granted above are perpetual and will not be revoked by 1EdTech GLC 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 IMPLEMENTERS 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.
UML Source File Information
Choreography: Sync
Transport: SOAPv1.1
Source UML File Information
The source file information must be supplied as an XMI file (without diagram layout information). The supported UML authoring tools are: (a) Poseidon – v6 (and later)
Source XSLT File Information
XSL Generator: UMLtoWSDLv1.1Transformv0p9p5.xsl
XSLT Processor: Xalan
Release: 1.0 Beta 4
Date: 31st March, 2011
1EdTech GLC Auto-generation Binding Tool-kit (I-BAT)
This file was auto-generated using the 1EdTech GLC Binding Auto-generation Tool-kit (I-BAT). While every attempt has been made to ensure that this tool auto-generates the files correctly, users should be aware that this is an experimental tool. Permission is given to make use of this tool. 1EdTech GLC makes no claim on the materials created by third party users of this tool. Details on how to use this tool are contained in the 1EdTech GLC "I-BAT" Documentation available at the 1EdTech GLC web-site.
Tool Copyright: 2005-2011 (c) 1EdTech Consortium Inc. All Rights Reserved.
|
Services |
Name |
Documentation |
MembershipManagementServiceSyncService |
Service Information
Author: Colin Smythe
Date: 30 June 2011
Version: 2.0
Status: Final Release
Description: The Membership Management Service is composed of a single interface.
History: Version 2.0: This is the first formal release of this service. This replaces the 1EdTech MMSv1.0 specification.
|
|
Service : MembershipManagementServiceSyncService |
Port Name |
Binding |
Address Extensibility |
Documentation |
MembershipManagerSyncSoapPort |
MembershipManagerSyncSoapBinding |
<soap11:address location="/lis/mms2p0/MembershipManagerSyncSoap/"/> |
|
Binding : MembershipManagerSyncSoapBinding |
Port Type |
MembershipManagerSyncPortType |
Extensibility |
<soap11:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/> |
Operations |
createMembership, createByProxyMembership, deleteMembership, readMembership, readAllMembershipIds, readMembershipIdsFromSavePoint, readMembershipIdsForPerson, readMembershipIdsForPersonWithRole, readMembershipIdsForCollection, readMemberships, readMembershipsFromSavePoint, updateMembership, replaceMembership, discoverMembershipIds, changeMembershipIdentifier. |
4.2 Messages
createMembershipRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:createMembershipRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
createMembershipResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:createMembershipResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
createByProxyMembershipRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:createByProxyMembershipRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
createByProxyMembershipResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:createByProxyMembershipResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
deleteMembershipRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:deleteMembershipRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
deleteMembershipResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:deleteMembershipResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
readMembershipRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:readMembershipRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
readMembershipResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:readMembershipResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
readAllMembershipIdsRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:readAllMembershipIdsRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
readAllMembershipIdsResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:readAllMembershipIdsResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
readMembershipIdsFromSavePointRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:readMembershipIdsFromSavePointRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
readMembershipIdsFromSavePointResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:readMembershipIdsFromSavePointResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
readMembershipIdsForPersonRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:readMembershipIdsForPersonRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
readMembershipIdsForPersonResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:readMembershipIdsForPersonResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
readMembershipIdsForPersonWithRoleRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:readMembershipIdsForPersonWithRoleRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
readMembershipIdsForPersonWithRoleResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:readMembershipIdsForPersonWithRoleResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
readMembershipIdsForCollectionRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:readMembershipIdsForCollectionRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
readMembershipIdsForCollectionResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:readMembershipIdsForCollectionResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
readMembershipsRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:readMembershipsRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
readMembershipsResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:readMembershipsResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
readMembershipsFromSavePointRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:readMembershipsFromSavePointRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
readMembershipsFromSavePointResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:readMembershipsFromSavePointResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
updateMembershipRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:updateMembershipRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
updateMembershipResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:updateMembershipResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
replaceMembershipRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:replaceMembershipRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
replaceMembershipResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:replaceMembershipResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
discoverMembershipIdsRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:discoverMembershipIdsRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
discoverMembershipIdsResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:discoverMembershipIdsResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
changeMembershipIdentifierRequest
Part Name |
Element |
Type |
Documentation |
Parameters |
tns:changeMembershipIdentifierRequest |
N/A |
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
changeMembershipIdentifierResponse
Part Name |
Element |
Type |
Documentation |
Response |
tns:changeMembershipIdentifierResponse |
N/A |
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
5. XSD File Documentation
The XSD file documentation has been produced by the Oxygen XML Editing tool.
Click on the Section header to access this documentation for the data models in the service description.
Click on the Section header to access this documentation for the data models for the exchange of Group objects in an external file.
6. Binding of the Vocabularies
The vocabularies in the MMS are:
- Roletype vocabulary – the set of roles that are permitted for the Membership of a Person in a Group. The PSM for this vocabulary is shown in Figure 6.1;
- Subroletype vocabulary – the set of sub-roles that are permitted for the Membership of a Person in a Group. The PSM for this vocabulary is shown in Figures 6.2, 6.3 and 6.4;
- Extension data-type vocabulary – the set of data-types that are permitted for extensions in the Membership data model. The PSM for this vocabulary is shown in Figure 6.5.
These vocabularies are the default set maintained under the 1EdTech GLC Vocabulary Registry [SDN11, 06]. It is the responsibility of an implementation to ensure that it is using the correct and latest versions of the vocabulary files. Changes to the default vocabularies are permitted; this results in the creation of a new vocabulary that should be registered with 1EdTech GLC. As part of a profiling process entirely new vocabularies may be defined to replace the default set.
Figure 6.1 The PSM representation of the roletype vocabulary for the MMS.
Figure 6.2 The PSM representation of the subroletype vocabulary for the role teaching assistant and officer for the MMS.
Figure 6.3 The PSM representation of the subroletype vocabulary for the role administrator for the MMS.
Figure 6.4 The PSM representation of the subroletype vocabulary for the role mentor for the MMS.
Figure 6.5 The PSM representation of the extension data-type vocabulary for the MMS.
Appendix A - Listing of the WSDLs
The WSDL bindings are for a Synchronous SOAP implementation only. The WSDL files, expressed using WSDLv1.1, are:
These files were generated by the I-BATv0.9.5 tool using the PSM representation described in Section 2.
Appendix B - Listing of the XSDs
The XSD files are:
This file was generated by the I-BATv0.9.5 tool using the PSM representation described in Section 2. Documentation of the XSDs is supplied in Section 5.
Appendix C - Vocabulary VDEX Instance File Listings
The MMS vocabularies are:
These vocabularies are expressed as instances of the 1EdTech GLC Vocabulary Data Exchange (VDEX) v1.0 specification. Documentation of these vocabularies is supplied in Section 6.
Appendix D - Example SOAP Messages
The set of examples for the SOAP messages are listed in Table D.1. The messaging pattern is a Request/Response exchange to support the Synchronous Service definition.
Table D.1 The set of SOAP message examples for each operation.
About This Document
Title |
1EdTech GLC Membership Management Service WSDL/XSD Binding |
Editor |
Colin Smythe (1EdTech GLC) |
Co-Chairs |
Linda Feng (Oracle), Bill Lee (Desire2learn) |
Version |
2.0 |
Version Date |
30 June 2011 |
Release |
Final 1.0 |
Status |
Final Release |
Summary |
This document contains the description of the 1EdTech GLC Membership Management Service v2.0 WSDL/XSD binding. This service is used to exchange information about Memberships. The business transactions include the simple create, read, update and delete of the Group data model for a single instance. This document contains the definition of the corresponding Web Service based upon SOAP/HTTP messaging. |
Revision Information |
This version supersedes the 1EdTech GLC Membership Management Service v1.0 specification. |
Purpose |
This document is made available for adoption by the public community at large. |
Document Location |
/lis/ |
List of Contributors
The following individuals contributed to the development of this document:
Name |
Organization |
Kerry Blinco |
DEEWR (Australia) |
Kirk Bunte |
SungardHE (USA) |
Angus Chan |
Desire2learn (Canada) |
Adam Cooper |
JISC (UK) |
Michael Feldstein |
Cengage (USA) |
Linda Feng |
Oracle (USA) |
Jon Fontaine |
Blackboard (USA) |
Chris Hatton |
Pearson (USA) |
Karen Kuffner |
University of Michigan (USA) |
Zack Leavitt |
eCollege (USA) |
Bill Lee |
Desire2learn (Canada) |
Richard Moon |
SungardHE (USA) |
Mike Parkhill |
Desire2learn (Canada) |
Colin Smythe |
1EdTech Consortium, Inc. |
Reihold Staudinger |
Blackboard (USA) |
Nick Terrible |
University of Wisconsin (USA) |
Jason Zhong |
SungardHE (USA) |
Revision History
Version No. |
Release Date |
Comments |
Final Release 1.0 |
30 June 2011 |
The first formal release of the Final Release version of this document. |
|
|
|
|
|
|
1EdTech Consortium, Inc. (“1EdTech GLC”) is publishing the information contained in this document (“Specification”) for purposes of scientific, experimental, and scholarly collaboration only.
1EdTech GLC 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.
1EdTech GLC would appreciate receiving your comments and suggestions.
Please contact 1EdTech GLC through our website at .
Please refer to Document Name: 1EdTech GLC MMS v2.0 WSDL/XSD Binding Final Release v1.0
Date: 30 June 2011.