Date Issued: 30
September 2013
Latest version:
http://www.imsglobal.org/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.
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 IMSs 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 ©
2013 IMS Global Learning Consortium. All Rights Reserved.
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.
Permission is
granted to all parties to use excerpts from this document as needed in
producing requests for proposals.
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.
c.
Nomenclature
d.
References
b.
Data for the Servce Operations
c.
File-based Exchange Data Model
a.
Overview
b.
Messages
This document
is a part of the IMS Global Bulk Data Exchange Management Service (BDEMS) v1.0.1
specification. The binding details how the Bulk Data Management Service Information
Model is realised as a Web Service; in the form of a Web Services Description
Language (WSDL) file. The BDEMS binding is contained in a set of WSDL, XSD and
vocabulary files. The vocabulary files are instances of the IMS Vocabulary
Definition Exchange specification [VDEX, 04a], [VDEX, 04b]. The IMS Global Learning Information Services
(LIS) Best Practice and Implementation Guide [LIS, 13b]
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, 13a]. For a
discussion of potential applications, see the Best Practice Guide.
The IMS Global
BDEMS WSDL Binding v1.0.1 is used in conjunction with the following documents:
This WSDL
binding takes the Bulk Data Exchange Management Service Information Model and
produces an encoding of that description in WSDL. This WSDL binding is
generated as recommended by the IMS Global 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].
The structure of
this document is:
2. Platform Specific Model of the Binding |
The description platform specific models in the form of the IMS
GLC UML-Profile service/data models representation of the IMS Global GMS
specification information model. This representation is used by the IMS Global
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
WDSDL/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. Binding of the Vocabularies |
Contains the description of how the set of external vocabulary
files are realised as VDEX files; |
Appendix A - Listing of the WSDL Files |
This is the full listing of the BDEMS WSDL files; |
Appendix B - Listing of the XSD Files |
This is the full listing of the BDEMS 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. |
BDEMS |
Bulk Data Exchange Management Service |
CMS |
Course Management Service |
GMS |
Group Management Service |
HTTP |
HyperText Transfer Protocol |
I-BAT |
IMS Global Binding Auto-generation Tool-kit |
IMS Global |
IMS Global Learning Consortium |
LIS |
Learning Information Services |
MDA |
Model Driven Architecture |
MMS |
Membership Management Service |
OMS |
Outcomes Management Service |
PIM |
Platform Independent Model |
PMS |
Person Management Service |
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 |
IMS Global Bulk Data Exchange Management Services v1.0.1 Information Model
Specification Final Release, L.Feng, B.Lee and C.Smythe, IMS Global
Learning Consortium, September 2013. |
|
IMS Global General Web Services Base Profile Specification Final
Release v1.0, C.Schroeder, J.Simon and C.Smythe, IMS Global Learning
Consortium, January 2006. |
|
IMS Global General Web Services WSDL Binding Guidelines Final
Release v1.0, C.Schroeder, J.Simon and C.Smythe, IMS Global Learning
Consortium, January 2006. |
|
IMS Binding Auto-generation Toolkit Manual v1.0, C.Smythe, IMS
Global Learning Consortium, July 2006. |
|
IMS Global Learning Information Services Specification v2.0.1 Final
Release , L.Feng, B.Lee and C.Smythe, IMS Global Learning Consortium,
September 2013. |
|
IMS Global Learning Information Services Best Practice and Implementation
Guide v2.0.1 Final Release , L.Feng, B.Lee and C.Smythe, IMS Global Learning
Consortium, September 2013. |
|
[SDN11, 06] |
IMS Global Specification Note 11: Vocabulary Definition,
Registration & Maintenance Procedures, C.Smythe, IMS Global Learning Consortium,
October 2006. |
IMS Vocabulary Definition Exchange Information Model
Specification Final Release v1.0, A.Cooper, IMS Global Learning Consortium,
February 2004. |
|
IMS Vocabulary Definition Exchange XML Binding Specification
Final Release v1.0, A.Cooper, IMS Global Learning Consortium, February
2004. |
Figure 2.1 is
the PSM of the service group model description for the BDEMS. This information is
used to establish the mapping to the binding flavors of WSDL.
Figure 2.2 is
the PSM of the service model description for the BDEMS. The PSM is derived from
the Platform Independent Model that was documented within the information model
for the BDEMS specification [BDEMS, 13].
NOTE: In Figure
2.2 it can be seen that the BDEMS uses an extra SOAP Header (this is supplied
as part of the IMS GWS v1.0 specification). This header is used to support
ansynchronous messaging uses end-point addressing provided as part of the SOAP
request message (this is similar to the use of WS-Addressing which may replace
this approach in later versions of the BDEMS).
The data model
for the service opertaions is shown in Figure 2.3, 2.4 and 2.5. Figures 2.3 and
2.4 show the data models for the set of parameters. Figure 2.5 is the data
model for the Status Information and other WSDL-specific binding data
structures.
The PSM for the
file-based bulk data exchange data models are shown in Figures 2.6 and 2.7.
Figure 2.6 is the BulkDataRecord data model and Figure 2.7 contains the set of
imported data model classes.
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 i.e. each call is realised as
a request/response pair (note that the BDEMS operations are combined in various
ways to create an asynchronous service; see the BDEMS Information Model [BDEMS, 13]). The binding files are available in two
forms:
It is
recommended that only the combined form is used (many WSDL-based code
generation tools do not process the WSDL '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 |
BulkBlockManifest |
Class |
2.3 |
|
4.1 |
BulkBlockManifest.Type |
ComplexType |
|
Attribute |
2.3 |
LUID |
4.2 |
bulkBlockManifestId |
Element |
|
Attribute |
2.3 |
DateTime |
4.3 |
expiryDate |
Element |
|
Attribute |
2.3 |
BulkBlockDataFile |
4.4 |
bulkBlockDataFile |
Element |
BulkBlockDataFile |
Class |
2.3 |
|
4.5 |
BulkBlockDataFile.Type |
ComplexType |
|
Attribute |
2.3 |
URL |
4.6 |
url |
Element |
|
Attribute |
2.3 |
Hexadecimal |
4.7 |
checkSum |
Element |
|
Attribute |
2.3 |
Integer |
4.8 |
totalSize |
Element |
|
Attribute |
2.3 |
SequenceIdentifier |
4.9 |
savePoint |
Element |
|
Attribute |
2.3 |
ServiceSet |
4.10 |
serviceSet |
Element |
ServiceSet |
Class |
2.3 |
|
4.11 |
ServiceSet.Type |
ComplexType |
|
Attribute |
2.3 |
ServiceRecord |
4.12 |
serviceRecord |
Element |
ServiceRecord |
Class |
2.3 |
|
4.13 |
ServiceRecord.Type |
ComplexType |
|
Attribute |
2.3 |
Enumeration |
4.14 |
serviceName |
Element |
|
Attribute |
2.3 |
Enumeration |
4.15 |
interfaceName |
Element |
|
Attribute |
2.3 |
OperationSet |
4.16 |
operationSet |
Element |
OperationSet |
Class |
2.3 |
|
4.17 |
OperationSet.Type |
ComplexType |
|
Attribute |
2.3 |
NormalizedString |
4.18 |
operationName |
Element |
BulkBlockReport |
Class |
2.3 |
|
4.19 |
BulkBlockReport.Type |
ComplexType |
|
Attribute |
2.3 |
LUID |
4.20 |
bulkBlockManifestIdRef |
Element |
|
Attribute |
2.3 |
ReportSummary |
4.21 |
reportSummary |
Element |
|
Attribute |
2.3 |
ReportFailureDetail |
4.22 |
transactionReport |
Element |
ReportSummary |
Class |
2.3 |
|
4.23 |
ReportSummary.Type |
ComplexType |
|
Attribute |
2.3 |
Int |
4.24 |
noofTotalFullSuccess |
Element |
|
Attribute |
2.3 |
Int |
4.25 |
noofTotalPartialSuccess |
Element |
|
Attribute |
2.3 |
Int |
4.26 |
noofTotalFailure |
Element |
|
Attribute |
2.3 |
InterfaceSummaryReport |
4.27 |
InterfaceSummaryReport |
Element |
InterfaceSummaryReport |
Class |
2.3 |
|
4.28 |
InterfaceSummaryReport.Type |
ComplexType |
|
Attribute |
2.3 |
Enumeration |
4.29 |
interfaceName |
Element |
|
Attribute |
2.3 |
Int |
4.30 |
noofFullSuccess |
Element |
|
Attribute |
2.3 |
Int |
4.31 |
noofPartialSuccess |
Element |
|
Attribute |
2.3 |
Int |
4.32 |
noofFailure |
Element |
ReportFailureDetail |
Class |
2.3 |
|
4.33 |
ReportFailureDetail.Type |
ComplexType |
|
Attribute |
2.3 |
TransactionReport |
4.34 |
failureReport |
Element |
TransactionReport |
Class |
2.3 |
|
4.35 |
TransactionReport.Type |
ComplexType |
|
Attribute |
2.3 |
LUID |
4.36 |
transactionOpIdentifierRef |
Element |
|
Attribute |
2.3 |
Enumeration |
4.37 |
serviceName |
Element |
|
Attribute |
2.3 |
AnyURI |
4.38 |
transactionFailStatusVocabulary |
Element |
|
Attribute |
2.3 |
External Vocabulary |
4.39 |
transactionFailStatus |
Element |
FailureReport |
Class |
2.3 |
|
4.40 |
FailureReport.Type |
ComplexType |
|
Attribute |
2.3 |
AnyURI |
|
failureReportVocabulary |
Element |
|
Attribute |
2.3 |
External Vocabulary |
4.41 |
failureCode |
Element |
|
Attribute |
2.3 |
NormalizedString |
4.42 |
failureDescription |
Element |
FilterObject |
Class |
2.3 |
|
4.43 |
FilterObject.Type |
ComplexType |
|
Attribute |
2.3 |
FilterRule |
4.44 |
filterRule |
Element |
FilterRule |
Class |
2.3 |
|
4.45 |
FilterRule.Type |
ComplexType |
|
Attribute |
2.3 |
AnyURI |
4.46 |
filterTypeVocabulary |
Element |
|
Attribute |
2.3 |
External Vocabulary |
4.47 |
filterType |
Element |
|
Attribute |
2.3 |
AnyURI |
4.48 |
filterValueVocabulary |
Element |
|
Attribute |
2.3 |
External Vocabulary |
4.49 |
filterValue |
Element |
SupportedServices |
Class |
2.4 |
|
4.50 |
SupportedServices.Type |
ComplexType |
|
Attribute |
2.4 |
PersonInterfaceOperations |
4.51 |
personOperation |
Element |
|
Attribute |
2.4 |
GroupInterfaceOperations |
4.52 |
groupOperation |
Element |
|
Attribute |
2.4 |
MembershipInterfaceOperations |
4.53 |
membershipOperation |
Element |
|
Attribute |
2.4 |
TemplateInterfaceOperations |
4.54 |
templateOperation |
Element |
|
Attribute |
2.4 |
OfferingInterfaceOperations |
4.55 |
offeringOperation |
Element |
|
Attribute |
2.4 |
SectionInterfaceOperations |
4.56 |
sectionOperation |
Element |
|
Attribute |
2.4 |
AssociationInterfaceOperations |
4.57 |
associationOperation |
Element |
|
Attribute |
2.4 |
LineItemInterfaceOperations |
4.58 |
lineItemOperation |
Element |
|
Attribute |
2.4 |
ResultInterfaceOperations |
4.59 |
resultOperation |
Element |
|
Attribute |
2.4 |
ResultValueInterfaceOperations |
4.60 |
resultValueOperation |
Element |
PersonInterfaceOperations |
Class |
2.4 |
|
4.61 |
PersonInterfaceOperations.Type |
ComplexType |
|
Attribute |
2.4 |
NormalizedString |
4.62 |
operationName |
Element |
GroupInterfaceOperations |
Class |
2.4 |
|
4.63 |
GroupInterfaceOperations.Type |
ComplexType |
|
Attribute |
2.4 |
NormalizedString |
4.64 |
operationName |
Element |
MembershipInterfaceOperations |
Class |
2.4 |
|
4.65 |
MembershipInterfaceOperations.Type |
ComplexType |
|
Attribute |
2.4 |
NormalizedString |
4.66 |
operationName |
Element |
TemplateInterfaceOperations |
Class |
2.4 |
|
4.67 |
TemplateInterfaceOperations.Type |
ComplexType |
|
Attribute |
2.4 |
NormalizedString |
4.68 |
operationName |
Element |
OfferingInterfaceOperations |
Class |
2.4 |
|
4.69 |
OfferingInterfaceOperations.Type |
ComplexType |
|
Attribute |
2.4 |
NormalizedString |
4.70 |
operationName |
Element |
SectionInterfaceOperations |
Class |
2.4 |
|
4.71 |
SectionInterfaceOperations.Type |
ComplexType |
|
Attribute |
2.4 |
NormalizedString |
4.72 |
operationName |
Element |
AssociationInterfaceOperations |
Class |
2.4 |
|
4.73 |
AssociationInterfaceOperations.Type |
ComplexType |
|
Attribute |
2.4 |
NormalizedString |
4.74 |
operationName |
Element |
LineItemInterfaceOperations |
Class |
2.4 |
|
4.75 |
LineItemInterfaceOperations.Type |
ComplexType |
|
Attribute |
2.4 |
NormalizedString |
4.76 |
operationName |
Element |
ResultInterfaceOperations |
Class |
2.4 |
|
4.77 |
ResultInterfaceOperations.Type |
ComplexType |
|
Attribute |
2.4 |
NormalizedString |
4.78 |
operationName |
Element |
ResultValueInterfaceOperations |
Class |
2.4 |
|
4.79 |
ResultValueInterfaceOperations.Type |
ComplexType |
|
Attribute |
2.4 |
NormalizedString |
4.80 |
operationName |
Element |
BulkDataRecord |
Class |
2.6 |
|
5.2 |
BulkDataRecord.Type |
ComplexType |
|
Attribute |
2.6 |
TransactionRecord |
5.3 |
transactionRecord |
Element |
TransactionRecord |
Class |
2.6 |
|
5.4 |
TransactionRecord.Type |
ComplexType |
|
Attribute |
2.6 |
LUID |
5.5 |
transactionOpIdentifier |
Element |
|
Attribute |
2.6 |
NormalizedString |
5.6 |
serviceName |
Element |
|
Attribute |
2.6 |
NormalizedString |
5.7 |
interfaceName |
Element |
|
Attribute |
2.6 |
NormalizedString |
5.8 |
operationName |
Element |
|
Attribute |
2.6 |
ParameterSet |
5.9 |
parameterSet |
Element |
ParameterSet |
Class |
2.6 |
|
5.10 |
ParameterSet.Type |
ComplexType |
|
Attribute |
2.6 |
ParameterRecord |
5.11 |
parameterRecord |
Element |
ParameterRecord |
Class |
2.6 |
|
5.12 |
ParameterRecord.Type |
ComplexType |
|
Attribute |
2.6 |
Internal Vocabulary |
5.13 |
parameterInvoc |
Element |
|
Attribute |
2.6 |
NormalizedString |
5.14 |
parameterName |
Element |
|
Attribute |
2.6 |
External Vocbulary |
5.15 |
parameterType |
Element |
|
Attribute |
2.6 |
ParameterValue |
5.16 |
parameterValue |
Element |
ParameterValue |
Class |
2.7 |
|
5.17 |
ParameterValue.Type |
ComplexType |
|
Attribute |
2.7 |
GUID |
5.18 |
guid |
Element |
|
Attribute |
2.7 |
GUIDSet |
5.19 |
guidSet |
Element |
|
Attribute |
2.7 |
NormalizedString |
5.20 |
queryObject |
Element |
|
Attribute |
2.7 |
DateTime |
5.21 |
sequenceIdentifier |
Element |
|
Attribute |
2.7 |
Text |
5.22 |
academicSession |
Element |
|
Attribute |
2.7 |
URL |
5.23 |
url |
Element |
|
Attribute |
2.7 |
PersonRecord |
5.24 |
personRecord |
Element |
|
Attribute |
2.7 |
PersonCoreRecord |
5.25 |
personCoreRecord |
Element |
|
Attribute |
2.7 |
PersonRecordSet |
5.26 |
personRecordSet |
Element |
|
Attribute |
2.7 |
GroupRecord |
5.27 |
groupRecord |
Element |
|
Attribute |
2.7 |
GroupRecordSet |
5.28 |
groupRecordSet |
Element |
|
Attribute |
2.7 |
MembershipRecord |
5.29 |
membershipRecord |
Element |
|
Attribute |
2.7 |
MembershipRecordSet |
5.30 |
membershipRecordSet |
Element |
|
Attribute |
2.7 |
CourseTemplateRecord |
5.31 |
courseTemplateRecord |
Element |
|
Attribute |
2.7 |
CourseTemplateRecordSet |
5.32 |
courseTemplateRecordSet |
Element |
|
Attribute |
2.7 |
CourseOfferingRecord |
5.33 |
courseOfferingRecord |
Element |
|
Attribute |
2.7 |
CourseOfferingRecordSet |
|
courseOfferingRecordSet |
Element |
|
Attribute |
2.7 |
CourseSectionRecord |
5.34 |
courseSectionRecord |
Element |
|
Attribute |
2.7 |
CourseSectionRecordSet |
5.35 |
courseSectionRecordSet |
Element |
|
Attribute |
2.7 |
SectionAssociationRecord |
5.36 |
sectionAssociationRecord |
Element |
|
Attribute |
2.7 |
SectionAssociationRecordSet |
5.37 |
sectionAssociationRecordSet |
Element |
|
Attribute |
2.7 |
ResultRecord |
5.38 |
resultRecord |
Element |
|
Attribute |
2.7 |
ResultRecordSet |
5.39 |
resultRecordSet |
Element |
|
Attribute |
2.7 |
ResultValueRecord |
5.40 |
resultValueRecord |
Element |
|
Attribute |
2.7 |
ResultValueRecordSet |
5.41 |
resultValueRecordSet |
Element |
|
Attribute |
2.7 |
LineItemRecord |
5.42 |
lineItemRecord |
Element |
|
Attribute |
2.7 |
LineItemRecordSet |
5.43 |
lineItemRecordSet |
Element |
|
Attribute |
2.7 |
LineItemType |
5.44 |
lineItemType |
Element |
|
Attribute |
2.7 |
Internal Vocabulary |
5.45 |
membershipIdType |
Element |
|
Attribute |
2.7 |
Relationship |
5.46 |
relationship |
Element |
|
Attribute |
2.7 |
Role |
5.47 |
role |
Element |
|
Attribute |
2.7 |
ResultStatus |
5.48 |
resultStatus |
Element |
|
Attribute |
2.7 |
Status |
5.49 |
status |
Element |
PersonRecord |
Class |
2.7 |
See IMS Global PMSv2.0
Info Model |
PersonRecord.Type |
ComplexType |
|
PersonRecordSet |
Class |
2.7 |
See IMS Global PMSv2.0
Info Model |
PersonRecordSet.Type |
ComplexType |
|
GroupRecord |
Class |
2.7 |
See IMS Global GMSv2.0
Info Model |
GroupRecord.Type |
ComplexType |
|
GroupRecordSet |
Class |
2.7 |
See IMS Global GMSv2.0
Info Model |
GroupRecordSet.Type |
ComplexType |
|
MembershipRecord |
Class |
2.7 |
See IMS Global MMSv2.0 Info
Model |
MembershipRecord.Type |
ComplexType |
|
MembershipRecordSet |
Class |
2.7 |
See IMS Global MMSv2.0
Info Model |
MembershipRecordSet.Type |
ComplexType |
|
CourseTemplateRecord |
Class |
2.7 |
See IMS Global CMSv1.0
Info Model |
CourseTemplateRecord.Type |
ComplexType |
|
CourseTemplateRecordSet |
Class |
2.7 |
See IMS Global CMSv1.0
Info Model |
CourseTemplateRecordSet.Type |
ComplexType |
|
CourseOfferingRecord |
Class |
2.7 |
See IMS Global CMSv1.0
Info Model |
CourseOfferingRecord.Type |
ComplexType |
|
CourseOfferingRecordSet |
Class |
2.7 |
See IMS Global CMSv1.0
Info Model |
CourseOfferingRecordSet.Type |
ComplexType |
|
CourseSectionRecord |
Class |
2.7 |
See IMS Global CMSv1.0
Info Model |
CourseSectionRecord.Type |
ComplexType |
|
CourseSectionRecordSet |
Class |
2.7 |
See IMS Global CMSv1.0
Info Model |
CourseSectionRecordSet.Type |
ComplexType |
|
SectionAssociationRecord |
Class |
2.7 |
See IMS Global CMSv1.0
Info Model |
SectionAssociationRecord.Type |
ComplexType |
|
SectionAssociationRecordSet |
Class |
2.7 |
See IMS Global CMSv1.0
Info Model |
SectionAssociationRecordSet.Type |
ComplexType |
|
ResultRecord |
Class |
2.7 |
See IMS Global OMSv1.0
Info Model |
ResultRecord.Type |
ComplexType |
|
ResultRecordSet |
Class |
2.7 |
See IMS Global OMSv1.0
Info Model |
ResultRecordSet.Type |
ComplexType |
|
ResultValueRecord |
Class |
2.7 |
See IMS Global OMSv1.0
Info Model |
ResultValueRecord.Type |
ComplexType |
|
ResultValueRecordSet |
Class |
2.7 |
See IMS Global OMSv1.0
Info Model |
ResultValueRecordSet.Type |
ComplexType |
|
LineItemRecord |
Class |
2.7 |
See IMS Global OMSv1.0
Info Model |
LineItemRecord.Type |
ComplexType |
|
LineItemRecordSet |
Class |
2.7 |
See IMS Global OMSv1.0
Info Model |
LineItemRecordSet.Type |
ComplexType |
|
Relationship |
Class |
2.7 |
See IMS Global MMSv2.0
Info Model |
Relationship.Type |
ComplexType |
|
Role |
Class |
2.7 |
See IMS Global GMSv2.0
Info Model |
Role.Type |
ComplexType |
|
LineItemType |
Class |
2.7 |
See IMS Global OMSv1.0
Info Model |
LineItemType.Type |
ComplexType |
|
ResultStatus |
Class |
2.7 |
See IMS Global OMSv1.0
Info Model |
ResultStatus.Type |
ComplexType |
|
Status |
Class |
2.7 |
See IMS Global OMSv1.0
Info Model |
ResultStatus.Type |
ComplexType |
|
Text |
Class |
2.7 |
See IMS Global CMSv1.0
Info Model |
Status.Type |
ComplexType |
|
imsx_StatusInfo |
Class |
2.5 |
|
See IMS GWSv1.0 |
imsx_StatusInfo.Type |
ComplexType |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_codeMajor |
Element |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_severity |
Element |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_messageRefIdentifier |
Element |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_operationRefIdentifier |
Element |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_description |
Element |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_codeMinor |
Element |
imsx_CodeMinor |
Class |
2.4 |
|
See IMS GWSv1.0 |
imsx_CodeMinor.Type |
ComplexType |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_codeMinorField |
Element |
imsx_CodeMinorField |
Class |
2.4 |
|
See IMS GWSv1.0 |
imsx_CodeMinorField.Type |
ComplexType |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_codeMinorFieldName |
Element |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_codeMinorFieldValue |
Element |
imsx_StatusBinding |
Class |
2.4 |
|
See IMS GWSv1.0 |
imsx_StatusBinding.Type |
ComplexType |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_syncRequestHeaderInfo |
Element |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_syncResponseHeaderInfo |
Element |
imsx_RequestHeaderInfo |
Class |
2.4 |
|
See IMS GWSv1.0 |
imsx_RequestHeaderInfo.Type |
ComplexType |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_version |
Element |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_messageIdentifier |
Element |
imsx_ResponseHeaderInfo |
Class |
2.4 |
|
See IMS GWSv1.0 |
imsx_ResponseHeaderInfo.Type |
ComplexType |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_version |
Element |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_messageIdentifier |
Element |
|
Attribute |
2.4 |
n/a |
See IMS GWSv1.0 |
imsx_statusInfo |
Element |
Key:
I.
The 'PSM Reference' field refers to information in the PSM description
(Section 2 in this document). The sub-fields are:
a.
Name the name of the data structure in the PSM and PIM
b.
UML Type the type of UML construct i.e. either Class or Attribute
c.
Figure the reference Figure number in this document;
II.
The 'PIM Reference' field refers to infomation in the BDEMS
Information Model [BDEMS, 13]. The sub-fields are:
a.
Type the type of the data structure in the Information Model
b.
Table the reference number of Tabular description in the
corresponding Information Model document;
III.
The 'XSD Reference' field refers to infrmation in the XSD
descriptions (Section 5 in this document). The sub-fields
are:
a.
Name the name of the field in the XSD(s)
b.
Type the type of XSD construct i.e. either a ComplexType or
Element.
WSDL file:
"BulkDataExchangeManagementServiceSyncSingle.wsdl"
Target
namespace:
http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0
WSDL Definition |
|
Name |
Documentation |
BulkDataExchangeManagementServiceSyncServices |
WSDL File Information
Services: BulkDataExchangeManagementService
(Synchronous Communications) Author: Colin
Smythe Date: 30 June
2011 Version:
Final 1.0 Status: Final
Release Description:
The Bulk Data Exchange Management Service (BDEMS). This forms a part of the IMS
Learning Information Services (LIS) v2.0 specification. History:
Version 1.0: This is the first formal release of this service. WSDL Binding:
WSDL Binding is based upon the IMS General Web Services Base Profile v1.0 The
IMS 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 IMS 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 IMS Global Learning Consortium (GLC)
specification IMS Global Bulk Data Exchange Management Service Version 1.0 found
at http://www.imsglobal.org/lis/bdemsv1p0/imsbdemsv1p0_BindPDv1.pdf and the
original IMS schema binding or code base
http://www.imsglobal.org/lis/bdemsv1p0/imsbdemsv10_BindPDv1.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. IMS Global 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
GLCs procedures with respect to rights in IMS Global specifications can be found
at the IMS Global Intellectual Property Rights web page:
http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf. Copyright IMS
Global Learning 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
IMS, 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 IMS Global community on the IMS Global website as described in the following
two paragraphs:-
The limited
permissions granted above are perpetual and will not be revoked by IMS Global 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 XSLT File Information
XSL
Generator: UMLtoWSDLTransformv0p9.5.xsl XSLT
Processor: Xalan Release: 1.0
Beta 4 Date: 31st
March, 2011 IMS Global Auto-generation Binding Tool-kit
(I-BAT)
This file was
auto-generated using the IMS Global 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. IMS Global 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 IMS Global "I-BAT" Documentation
available at the IMS Global web-site. Tool
Copyright: 2005-2011 (c) IMS Global Learning Consortium Inc. All Rights
Reserved. |
Services |
||
Name |
Documentation |
|
|
Port Name |
Binding |
Address Extensibility |
Documentation |
|
BulkDataExchangeManagerSyncSoapPort |
|
|
Binding : BulkDataExchangeManagerSyncSoapBinding |
|
Port Type |
|
Extensibility |
|
Operations |
announceBulkDataExchange, announceFailureBulkDataExchange,
reportBulkDataExchange, requestBulkDataExchange, ignoreBulkDataExchange,
cancelBulkDataExchange, |
Port Type : BulkDataExchangeManagerSyncPortType |
||||
Operation Name |
Input message |
Output message |
Documentation |
|
announceBulkDataExchange |
|
|||
announceFailureBulkDataExchange |
|
|||
reportBulkDataExchange |
|
|||
requestBulkDataExchange |
|
|||
ignoreBulkDataExchange |
|
|||
cancelBulkDataExchange |
|
Part Name |
Element |
Type |
Documentation |
|
Parameters |
tns:announceBulkDataExchangeRequest |
N/A |
|
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
|
imsx_epaRequestHeaderInfoRequest |
epa:imsx_epaRequestHeaderInfo |
N/A |
|
Part Name |
Element |
Type |
Documentation |
|
Response |
tns:announceBulkDataExchangeResponse |
N/A |
|
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
Part Name |
Element |
Type |
Documentation |
|
Parameters |
tns:announceFailureBulkDataExchangeRequest |
N/A |
|
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
|
imsx_epaRequestHeaderInfoRequest |
epa:imsx_epaRequestHeaderInfo |
N/A |
|
Part Name |
Element |
Type |
Documentation |
|
Response |
tns:announceFailureBulkDataExchangeResponse |
N/A |
|
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
Part Name |
Element |
Type |
Documentation |
|
Parameters |
tns:reportBulkDataExchangeRequest |
N/A |
|
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
|
imsx_epaRequestHeaderInfoRequest |
epa:imsx_epaRequestHeaderInfo |
N/A |
|
Part Name |
Element |
Type |
Documentation |
|
Response |
tns:reportBulkDataExchangeResponse |
N/A |
|
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
Part Name |
Element |
Type |
Documentation |
|
Parameters |
tns:requestBulkDataExchangeRequest |
N/A |
|
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
|
imsx_epaRequestHeaderInfoRequest |
epa:imsx_epaRequestHeaderInfo |
N/A |
|
Part Name |
Element |
Type |
Documentation |
|
Response |
tns:requestBulkDataExchangeResponse |
N/A |
|
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
Part Name |
Element |
Type |
Documentation |
|
Parameters |
tns:ignoreBulkDataExchangeRequest |
N/A |
|
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
|
imsx_epaRequestHeaderInfoRequest |
epa:imsx_epaRequestHeaderInfo |
N/A |
|
Part Name |
Element |
Type |
Documentation |
|
Response |
tns:ignoreBulkDataExchangeResponse |
N/A |
|
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
Part Name |
Element |
Type |
Documentation |
|
Parameters |
tns:cancelBulkDataExchangeRequest |
N/A |
|
|
HeaderInfoParameters |
tns:imsx_syncRequestHeaderInfo |
N/A |
|
|
imsx_epaRequestHeaderInfoRequest |
epa:imsx_epaRequestHeaderInfo |
N/A |
|
Part Name |
Element |
Type |
Documentation |
|
Response |
tns:cancelBulkDataExchangeResponse |
N/A |
|
|
HeaderInfoResponse |
tns:imsx_syncResponseHeaderInfo |
N/A |
|
NOTE: Each of
the SOAP request messages includes the end-point addressing SOAP header (this
should be optionally supplied).
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 file-based
storage.
The
vocabularies in the BDEMS are:
These
vocabularies are the default set maintained under the IMS Global 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 IMS
GLC. As part of a profiling process entirely new vocabularies may be defined to
replace the default set.
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.
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.
The BDEMS
vocabularies are:
These vocabularies
are each expressed as an instance of the IMS Global Vocabulary Data Exchange
(VDEX) v1.0 specification. Documentation of the vocabulary is supplied in Section 6. The online versions of these vocabularies
are available in the directory: http://www.imsglobal.org/vdex/lis/bdemsv1p0/.
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.
Operation Name |
Input (Request) SOAP
Message |
Output (Response) SOAP
Message |
announceBulkDataExchange |
||
announceFailureBulkDataExchange |
||
reportBulkDataExchange |
||
requestBulkDataExchange |
||
ignoreBulkDataExchange |
||
cancelBulkDataExchange |
NOTE: The above
examples do not demonstrate the use of the end-point addressing SOAP header.
Title |
IMS Global Bulk Data Exchange Management Service WSDL/XSD Binding |
Editor |
Colin Smythe (IMS Global) |
Co-Chairs |
Linda Feng (Oracle), Bill Lee (Desire2learn) |
Version |
1.0.1 |
Version Date |
30 Septemer 2013 |
Status |
Final Release |
Summary |
This document contains the description of the IMS Global Bulk Data
Exchange Management Service v1.0.1 WSDL/XSD binding. This service is used to exchange
bulk data by reference to an exernal data file. This document contains the
definition of the corresponding Web Service based upon SOAP/HTTP messaging. |
Revision Information |
Original release. |
Purpose |
This document is made available for adoption by the public
community at large. |
Document Location |
The following
individuals contributed to the development of this document:
Name |
Organization |
Kerry Blinco |
DEEWR ( |
Kirk Bunte |
SungardHE ( |
Angus Chan |
Desire2learn ( |
Adam Cooper |
JISC ( |
Michael De Ridder |
Desire2Learn ( |
Michael Feldstein |
Cengage ( |
Linda Feng |
Oracle ( |
John Fontaine |
Blackboard ( |
Chris Hatton |
Pearson ( |
Karen Kuffner |
|
Zack Leavitt |
eCollege ( |
Bill Lee |
Desire2learn ( |
Richard Moon |
SungardHE ( |
Phil Nicholls |
Psydev Ltd ( |
Mike Parkhill |
Desire2learn ( |
Colin Smythe |
IMS Global Learning Consortium, Inc. |
Reinhold Staudinger |
Blackboard ( |
Version No. |
Release Date |
Comments |
BDEMS Final Release 1.0 |
30 June 2011 |
The first formal release of the Final Release version of this
document. |
BDEMS Final Release 1.0.1 |
30 September 2013 |
Corrections |
|
|
|
IMS
Global Learning Consortium, Inc. (“IMS Global”) is publishing the information
contained in this document (“Specification”) for purposes of scientific,
experimental, and scholarly collaboration only.
IMS Global 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 Global would appreciate receiving your comments
and suggestions.
Please contact IMS Global through our website at http://www.imsglobal.org.
Please refer to Document Name: IMS Global BDEMS v1.0.1
WSDL/XSD Binding Final Release
Date: 30 September 2013.