IMS GLC Bulk Data Exchange Management Service WSDL/XSD Binding

Version 1.0 Final Release Specification

Final 1.0

Date Issued: 30 June 2011

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 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.

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.

top

Introduction

Scope and Context
Structure of this Document
Nomenclature
References

Platform Specific Model of the Binding

Service Description
Data for the Servce Operations
File-based Exchange Data Model

Application of the Binding Guidelines
WSDL File Documentation
1. Overview
2. Messages
XSD File Documentation
1. Service Data Model
2. 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

top

1. Introduction

This document is a part of the IMS GLC Bulk Data Exchange Management Service (BDEMS) v1.0 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 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 IMS GLC BDEMS WSDL Binding v1.0 is used in conjunction with the following documents:

IMS GLC Bulk Data Exchange Management Service Information Model v1.0 [BDEMS, 11] � the behaviour and data model definition of the Bulk Data Exchange Management Service;
IMS GLC Learning Information Services Best Practice and Implementation Guide v1.0 [LIS, 11b] � key information on how to adopt and implement the specification.

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 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 IMS GLC UML-Profile service/data models representation of the IMS GLC GMS specification information model. This representation is used by the IMS 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 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.

1.3 Nomenclature

BDEMS	Bulk Data Exchange Management Service
CMS	Course Management Service
GMS	Group Management Service
HTTP	HyperText Transfer Protocol
I-BAT	IMS GLC Binding Auto-generation Tool-kit
IMS GLC	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

1.4 References

[BDEMS, 11]	IMS GLC Bulk Data Exchange Management Services v1.0 Information Model Specification Final Release v1.0, L.Feng, B.Lee and C.Smythe, IMS Global Learning Consortium, June 2011.
[GWS, 06a]	IMS GLC General Web Services Base Profile Specification Final Release v1.0, C.Schroeder, J.Simon and C.Smythe, IMS Global Learning Consortium, January 2006.
[GWS, 06b]	IMS GLC General Web Services WSDL Binding Guidelines Final Release v1.0, C.Schroeder, J.Simon and C.Smythe, IMS Global Learning Consortium, January 2006.
[I-BAT, 06]	IMS Binding Auto-generation Toolkit Manual v1.0, C.Smythe, IMS Global Learning Consortium, July 2006.
[LIS, 11a]	IMS GLC Learning Information Services v2.0 Specification Final Rewease v1.0, L.Feng, B.Lee and C.Smythe, IMS Global Learning Consortium, June 2011.
[LIS, 11b]	IMS GLC Learning Information Services v2.0 Best Practice and Implementation Guide Final Release v1.0, L.Feng, B.Lee and C.Smythe, IMS Global Learning Consortium, June 2011.
[SDN11, 06]	IMS GLC Specification Note 11: Vocabulary Definition, Registration & Maintenance Procedures, C.Smythe, IMS Global Learning Consortium, October 2006.
[VDEX, 04a]	IMS Vocabulary Definition Exchange Information Model Specification Final Release v1.0, A.Cooper, IMS Global Learning Consortium, February 2004.
[VDEX, 04b]	IMS Vocabulary Definition Exchange XML Binding Specification Final Release v1.0, A.Cooper, IMS Global Learning Consortium, February 2004.

top | toc

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 BDEMS. 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 BDEMS.

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, 10].

Figure 2.2 The PSM representation of the service model description for the BDEMS.

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).

2.2 Data for the Service Operations

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.

Figure 2.3 The PSM representation of the parameters data model description for the BDEMS.

Figure 2.4 The PSM representation epresentation of the supported parameter data model description for the BDEMS.

Figure 2.5 The PSM representation of the status information data model description for the BDEMS.

2.3 File-based Data Exchange Data Model

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.

Figure 2.6 The PSM representation of the bulkdatarecord data model description for file storage in the BDEMS.

Figure 2.7 The PSM representation of the imported data model descriptions for file storage in the BDEMS.

top | toc

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 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, 11]). The binding files are available in two forms:

A single combined WSDL/XSD�� BulkDataExchangeManagementServicev1.0_SyncSingle_v1p0.wsdl;
Separated WSDL and XSD files � BulkDataExchangeManagementServicev1p0_SyncWSDL_v1p0.wsdl and BulkDataExchangeManagementServiceSyncXSD.xsd respectively.

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
bulkBlockManifestId	Attribute	2.3	LUID	4.2	bulkBlockManifestId	Element
expiryDate	Attribute	2.3	DateTime	4.3	expiryDate	Element
bulkBlockDataFile	Attribute	2.3	BulkBlockDataFile	4.4	bulkBlockDataFile	Element
BulkBlockDataFile	Class	2.3	�	4.5	BulkBlockDataFile.Type	ComplexType
url	Attribute	2.3	URL	4.6	url	Element
checkSum	Attribute	2.3	Hexadecimal	4.7	checkSum	Element
totalSize	Attribute	2.3	Integer	4.8	totalSize	Element
savePoint	Attribute	2.3	SequenceIdentifier	4.9	savePoint	Element
serviceSet	Attribute	2.3	ServiceSet	4.10	serviceSet	Element
ServiceSet	Class	2.3	�	4.11	ServiceSet.Type	ComplexType
serviceRecord	Attribute	2.3	ServiceRecord	4.12	serviceRecord	Element
ServiceRecord	Class	2.3	�	4.13	ServiceRecord.Type	ComplexType
serviceName	Attribute	2.3	Enumeration	4.14	serviceName	Element
interfaceName	Attribute	2.3	Enumeration	4.15	interfaceName	Element
operationSet	Attribute	2.3	OperationSet	4.16	operationSet	Element
OperationSet	Class	2.3	�	4.17	OperationSet.Type	ComplexType
operationName	Attribute	2.3	NormalizedString	4.18	operationName	Element
BulkBlockReport	Class	2.3	�	4.19	BulkBlockReport.Type	ComplexType
bulkBlockManifestIdRef	Attribute	2.3	LUID	4.20	bulkBlockManifestIdRef	Element
transactionReportSummary	Attribute	2.3	ReportSummary	4.21	reportSummary	Element
transactionReportDetail	Attribute	2.3	ReportFailureDetail	4.22	transactionReport	Element
ReportSummary	Class	2.3	�	4.23	ReportSummary.Type	ComplexType
noofTotalFullSuccess	Attribute	2.3	Int	4.24	noofTotalFullSuccess	Element
noofTotalPartialSuccess	Attribute	2.3	Int	4.25	noofTotalPartialSuccess	Element
noofTotalFailure	Attribute	2.3	Int	4.26	noofTotalFailure	Element
interfaceSummaryReport	Attribute	2.3	InterfaceSummaryReport	4.27	InterfaceSummaryReport	Element
InterfaceSummaryReport	Class	2.3	�	4.28	InterfaceSummaryReport.Type	ComplexType
interfaceName	Attribute	2.3	Enumeration	4.29	interfaceName	Element
noofFullSuccess	Attribute	2.3	Int	4.30	noofFullSuccess	Element
noofPartialSuccess	Attribute	2.3	Int	4.31	noofPartialSuccess	Element
noofFailure	Attribute	2.3	Int	4.32	noofFailure	Element
ReportFailureDetail	Class	2.3	�	4.33	ReportFailureDetail.Type	ComplexType
failureReport	Attribute	2.3	TransactionReport	4.34	failureReport	Element
TransactionReport	Class	2.3	�	4.35	TransactionReport.Type	ComplexType
transactionOpIdentifierRef	Attribute	2.3	LUID	4.36	transactionOpIdentifierRef	Element
serviceName	Attribute	2.3	Enumeration	4.37	serviceName	Element
transactionFailStatusVocabulary	Attribute	2.3	AnyURI	4.38	transactionFailStatusVocabulary	Element
transactionFailStatus	Attribute	2.3	External Vocabulary	4.39	transactionFailStatus	Element
FailureReport	Class	2.3	�	4.40	FailureReport.Type	ComplexType
failureReportVocabulary	Attribute	2.3	AnyURI		failureReportVocabulary	Element
failureCode	Attribute	2.3	External Vocabulary	4.41	failureCode	Element
failureDescription	Attribute	2.3	NormalizedString	4.42	failureDescription	Element
FilterObject	Class	2.3	�	4.43	FilterObject.Type	ComplexType
filterRule	Attribute	2.3	FilterRule	4.44	filterRule	Element
FilterRule	Class	2.3	�	4.45	FilterRule.Type	ComplexType
filterTypeVocabulary	Attribute	2.3	AnyURI	4.46	filterTypeVocabulary	Element
filterType	Attribute	2.3	External Vocabulary	4.47	filterType	Element
filterValueVocabulary	Attribute	2.3	AnyURI	4.48	filterValueVocabulary	Element
filterValue	Attribute	2.3	External Vocabulary	4.49	filterValue	Element
SupportedServices	Class	2.4	�	4.50	SupportedServices.Type	ComplexType
personOperation	Attribute	2.4	PersonInterfaceOperations	4.51	personOperation	Element
groupOperation	Attribute	2.4	GroupInterfaceOperations	4.52	groupOperation	Element
membershipOperation	Attribute	2.4	MembershipInterfaceOperations	4.53	membershipOperation	Element
templateOperation	Attribute	2.4	TemplateInterfaceOperations	4.54	templateOperation	Element
offeringOperation	Attribute	2.4	OfferingInterfaceOperations	4.55	offeringOperation	Element
sectionOperation	Attribute	2.4	SectionInterfaceOperations	4.56	sectionOperation	Element
associationOperation	Attribute	2.4	AssociationInterfaceOperations	4.57	associationOperation	Element
lineItemOperation	Attribute	2.4	LineItemInterfaceOperations	4.58	lineItemOperation	Element
resultOperation	Attribute	2.4	ResultInterfaceOperations	4.59	resultOperation	Element
resultValueOperation	Attribute	2.4	ResultValueInterfaceOperations	4.60	resultValueOperation	Element
PersonInterfaceOperations	Class	2.4	�	4.61	PersonInterfaceOperations.Type	ComplexType
operationName	Attribute	2.4	NormalizedString	4.62	operationName	Element
GroupInterfaceOperations	Class	2.4	�	4.63	GroupInterfaceOperations.Type	ComplexType
operationName	Attribute	2.4	NormalizedString	4.64	operationName	Element
MembershipInterfaceOperations	Class	2.4	�	4.65	MembershipInterfaceOperations.Type	ComplexType
operationName	Attribute	2.4	NormalizedString	4.66	operationName	Element
TemplateInterfaceOperations	Class	2.4	�	4.67	TemplateInterfaceOperations.Type	ComplexType
operationName	Attribute	2.4	NormalizedString	4.68	operationName	Element
OfferingInterfaceOperations	Class	2.4	�	4.69	OfferingInterfaceOperations.Type	ComplexType
operationName	Attribute	2.4	NormalizedString	4.70	operationName	Element
SectionInterfaceOperations	Class	2.4	�	4.71	SectionInterfaceOperations.Type	ComplexType
operationName	Attribute	2.4	NormalizedString	4.72	operationName	Element
AssociationInterfaceOperations	Class	2.4	�	4.73	AssociationInterfaceOperations.Type	ComplexType
operationName	Attribute	2.4	NormalizedString	4.74	operationName	Element
LineItemInterfaceOperations	Class	2.4	�	4.75	LineItemInterfaceOperations.Type	ComplexType
operationName	Attribute	2.4	NormalizedString	4.76	operationName	Element
ResultInterfaceOperations	Class	2.4	�	4.77	ResultInterfaceOperations.Type	ComplexType
operationName	Attribute	2.4	NormalizedString	4.78	operationName	Element
ResultValueInterfaceOperations	Class	2.4	�	4.79	ResultValueInterfaceOperations.Type	ComplexType
operationName	Attribute	2.4	NormalizedString	4.80	operationName	Element
BulkDataRecord	Class	2.6	�	5.2	BulkDataRecord.Type	ComplexType
transactionRecord	Attribute	2.6	TransactionRecord	5.3	transactionRecord	Element
TransactionRecord	Class	2.6	�	5.4	TransactionRecord.Type	ComplexType
transactionOpIdentifier	Attribute	2.6	LUID	5.5	transactionOpIdentifier	Element
serviceName	Attribute	2.6	NormalizedString	5.6	serviceName	Element
interfaceName	Attribute	2.6	NormalizedString	5.7	interfaceName	Element
operationName	Attribute	2.6	NormalizedString	5.8	operationName	Element
parameterSet	Attribute	2.6	ParameterSet	5.9	parameterSet	Element
ParameterSet	Class	2.6	�	5.10	ParameterSet.Type	ComplexType
parameterRecord	Attribute	2.6	ParameterRecord	5.11	parameterRecord	Element
ParameterRecord	Class	2.6	�	5.12	ParameterRecord.Type	ComplexType
parameterInvoc	Attribute	2.6	Internal Vocabulary	5.13	parameterInvoc	Element
parameterName	Attribute	2.6	NormalizedString	5.14	parameterName	Element
parameterType	Attribute	2.6	External Vocbulary	5.15	parameterType	Element
parameterValue	Attribute	2.6	ParameterValue	5.16	parameterValue	Element
ParameterValue	Class	2.7	�	5.17	ParameterValue.Type	ComplexType
guid	Attribute	2.7	GUID	5.18	guid	Element
guidSet	Attribute	2.7	GUIDSet	5.19	guidSet	Element
queryObject	Attribute	2.7	NormalizedString	5.20	queryObject	Element
sequenceIdentifier	Attribute	2.7	DateTime	5.21	sequenceIdentifier	Element
academicSession	Attribute	2.7	Text	5.22	academicSession	Element
url	Attribute	2.7	URL	5.23	url	Element
personRecord	Attribute	2.7	PersonRecord	5.24	personRecord	Element
personCoreRecord	Attribute	2.7	PersonCoreRecord	5.25	personCoreRecord	Element
personRecordSet	Attribute	2.7	PersonRecordSet	5.26	personRecordSet	Element
groupRecord	Attribute	2.7	GroupRecord	5.27	groupRecord	Element
groupRecordSet	Attribute	2.7	GroupRecordSet	5.28	groupRecordSet	Element
membershipRecord	Attribute	2.7	MembershipRecord	5.29	membershipRecord	Element
membershipRecordSet	Attribute	2.7	MembershipRecordSet	5.30	membershipRecordSet	Element
courseTemplateRecord	Attribute	2.7	CourseTemplateRecord	5.31	courseTemplateRecord	Element
courseTemplateRecordSet	Attribute	2.7	CourseTemplateRecordSet	5.32	courseTemplateRecordSet	Element
courseOfferingRecord	Attribute	2.7	CourseOfferingRecord	5.33	courseOfferingRecord	Element
courseOfferingRecordSet	Attribute	2.7	CourseOfferingRecordSet		courseOfferingRecordSet	Element
courseSectionRecord	Attribute	2.7	CourseSectionRecord	5.34	courseSectionRecord	Element
courseSectionRecordSet	Attribute	2.7	CourseSectionRecordSet	5.35	courseSectionRecordSet	Element
sectionAssociationRecord	Attribute	2.7	SectionAssociationRecord	5.36	sectionAssociationRecord	Element
sectionAssociationRecordSet	Attribute	2.7	SectionAssociationRecordSet	5.37	sectionAssociationRecordSet	Element
resultRecord	Attribute	2.7	ResultRecord	5.38	resultRecord	Element
resultRecordSet	Attribute	2.7	ResultRecordSet	5.39	resultRecordSet	Element
resultValueRecord	Attribute	2.7	ResultValueRecord	5.40	resultValueRecord	Element
resultValueRecordSet	Attribute	2.7	ResultValueRecordSet	5.41	resultValueRecordSet	Element
lineItemRecord	Attribute	2.7	LineItemRecord	5.42	lineItemRecord	Element
lineItemRecordSet	Attribute	2.7	LineItemRecordSet	5.43	lineItemRecordSet	Element
lineItemType	Attribute	2.7	LineItemType	5.44	lineItemType	Element
membershipIdType	Attribute	2.7	Internal Vocabulary	5.45	membershipIdType	Element
relationship	Attribute	2.7	Relationship	5.46	relationship	Element
role	Attribute	2.7	Role	5.47	role	Element
resultStatus	Attribute	2.7	ResultStatus	5.48	resultStatus	Element
status	Attribute	2.7	Status	5.49	status	Element
PersonRecord	Class	2.7	See IMS GLC PMSv2.0 Info Model		PersonRecord.Type	ComplexType
PersonRecordSet	Class	2.7	See IMS GLC PMSv2.0 Info Model		PersonRecordSet.Type	ComplexType
GroupRecord	Class	2.7	See IMS GLC GMSv2.0 Info Model		GroupRecord.Type	ComplexType
GroupRecordSet	Class	2.7	See IMS GLC GMSv2.0 Info Model		GroupRecordSet.Type	ComplexType
MembershipRecord	Class	2.7	See IMS GLC MMSv2.0 Info Model		MembershipRecord.Type	ComplexType
MembershipRecordSet	Class	2.7	See IMS GLC MMSv2.0 Info Model		MembershipRecordSet.Type	ComplexType
CourseTemplateRecord	Class	2.7	See IMS GLC CMSv1.0 Info Model		CourseTemplateRecord.Type	ComplexType
CourseTemplateRecordSet	Class	2.7	See IMS GLC CMSv1.0 Info Model		CourseTemplateRecordSet.Type	ComplexType
CourseOfferingRecord	Class	2.7	See IMS GLC CMSv1.0 Info Model		CourseOfferingRecord.Type	ComplexType
CourseOfferingRecordSet	Class	2.7	See IMS GLC CMSv1.0 Info Model		CourseOfferingRecordSet.Type	ComplexType
CourseSectionRecord	Class	2.7	See IMS GLC CMSv1.0 Info Model		CourseSectionRecord.Type	ComplexType
CourseSectionRecordSet	Class	2.7	See IMS GLC CMSv1.0 Info Model		CourseSectionRecordSet.Type	ComplexType
SectionAssociationRecord	Class	2.7	See IMS GLC CMSv1.0 Info Model		SectionAssociationRecord.Type	ComplexType
SectionAssociationRecordSet	Class	2.7	See IMS GLC CMSv1.0 Info Model		SectionAssociationRecordSet.Type	ComplexType
ResultRecord	Class	2.7	See IMS GLC OMSv1.0 Info Model		ResultRecord.Type	ComplexType
ResultRecordSet	Class	2.7	See IMS GLC OMSv1.0 Info Model		ResultRecordSet.Type	ComplexType
ResultValueRecord	Class	2.7	See IMS GLC OMSv1.0 Info Model		ResultValueRecord.Type	ComplexType
ResultValueRecordSet	Class	2.7	See IMS GLC OMSv1.0 Info Model		ResultValueRecordSet.Type	ComplexType
LineItemRecord	Class	2.7	See IMS GLC OMSv1.0 Info Model		LineItemRecord.Type	ComplexType
LineItemRecordSet	Class	2.7	See IMS GLC OMSv1.0 Info Model		LineItemRecordSet.Type	ComplexType
Relationship	Class	2.7	See IMS GLC MMSv2.0 Info Model		Relationship.Type	ComplexType
Role	Class	2.7	See IMS GLC GMSv2.0 Info Model		Role.Type	ComplexType
LineItemType	Class	2.7	See IMS GLC OMSv1.0 Info Model		LineItemType.Type	ComplexType
ResultStatus	Class	2.7	See IMS GLC OMSv1.0 Info Model		ResultStatus.Type	ComplexType
Status	Class	2.7	See IMS GLC OMSv1.0 Info Model		ResultStatus.Type	ComplexType
Text	Class	2.7	See IMS GLC CMSv1.0 Info Model		Status.Type	ComplexType
imsx_StatusInfo	Class	2.5	�	See IMS GWSv1.0	imsx_StatusInfo.Type	ComplexType
imsx_codeMajor	Attribute	2.4	n/a	See IMS GWSv1.0	imsx_codeMajor	Element
imsx_severity	Attribute	2.4	n/a	See IMS GWSv1.0	imsx_severity	Element
imsx_messageRefIdentifier	Attribute	2.4	n/a	See IMS GWSv1.0	imsx_messageRefIdentifier	Element
imsx_operationRefIdentifier	Attribute	2.4	n/a	See IMS GWSv1.0	imsx_operationRefIdentifier	Element
imsx_description	Attribute	2.4	n/a	See IMS GWSv1.0	imsx_description	Element
imsx_codeMinor	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
imsx_codeMinorField	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
imsx_codeMinorFieldName	Attribute	2.4	n/a	See IMS GWSv1.0	imsx_codeMinorFieldName	Element
imsx_codeMinorFieldValue	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
imsx_syncRequestHeaderInfo	Attribute	2.4	n/a	See IMS GWSv1.0	imsx_syncRequestHeaderInfo	Element
imsx_syncResponseHeaderInfo	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
imsx_version	Attribute	2.4	n/a	See IMS GWSv1.0	imsx_version	Element
imsx_messageIdentifier	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
imsx_version	Attribute	2.4	n/a	See IMS GWSv1.0	imsx_version	Element
imsx_messageIdentifier	Attribute	2.4	n/a	See IMS GWSv1.0	imsx_messageIdentifier	Element
imsx_statusInfo	Attribute	2.4	n/a	See IMS 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:
1. Name � the name of the data structure in the PSM and PIM
2. UML Type � the type of UML construct i.e. either Class or Attribute
3. Figure � the reference Figure number in this document;
The 'PIM Reference' field refers to infomation in the BDEMS Information Model [BDEMS, 11]. The sub-fields are:
1. Type � the type of the data structure in the Information Model
2. 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:
1. Name � the name of the field in the XSD(s)
2. Type � the type of XSD construct i.e. either a ComplexType or Element.

top | toc

4. WSDL File Documentation

WSDL file: "BulkDataExchangeManagementServiceSyncSingle.wsdl"

Target namespace: http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0

4.1 Overview

Services
BulkDataExchangeManagementServiceSyncService

Bindings
BulkDataExchangeManagerSyncSoapBinding

Port types
BulkDataExchangeManagerSyncPortType

Messages

announceBulkDataExchangeRequest, announceBulkDataExchangeResponse, announceFailureBulkDataExchangeRequest, announceFailureBulkDataExchangeResponse, reportBulkDataExchangeRequest, reportBulkDataExchangeResponse, requestBulkDataExchangeRequest, requestBulkDataExchangeResponse, ignoreBulkDataExchangeRequest, ignoreBulkDataExchangeResponse, cancelBulkDataExchangeRequest, cancelBulkDataExchangeResponse,

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 GLC 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 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 IMS GLCs procedures with respect to rights in IMS GLC specifications can be found at the IMS GLC 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 GLC community on the IMS 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 IMS and receive an email from IMS granting the license. To register, follow the instructions on the IMS website: http://www.imsglobal.org/specificationdownload.cfm. 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 IMS GLC and receive an email from IMS GLC granting the license. To register, follow the instructions on the IMS GLC website: http://www.imsglobal.org/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 IMS 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 XSLT File Information XSL Generator: UMLtoWSDLTransformv0p9.5.xsl XSLT Processor: Xalan Release: 1.0 Beta 4 Date: 31st March, 2011 IMS GLC Auto-generation Binding Tool-kit (I-BAT) This file was auto-generated using the IMS 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. IMS 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 IMS GLC "I-BAT" Documentation available at the IMS GLC web-site. Tool Copyright: 2005-2011 (c) IMS Global Learning Consortium Inc. All Rights Reserved.

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 GLC 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.

IMS 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 IMS GLCs procedures with respect to rights in IMS GLC specifications can be found at the IMS GLC Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf.

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 GLC community on the IMS 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 IMS and receive an email from IMS granting the license. To register, follow the instructions on the IMS website: http://www.imsglobal.org/specificationdownload.cfm. 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 IMS GLC and receive an email from IMS GLC granting the license. To register, follow the instructions on the IMS GLC website: http://www.imsglobal.org/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 IMS 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 XSLT File Information

XSL Generator: UMLtoWSDLTransformv0p9.5.xsl

XSLT Processor: Xalan

Release: 1.0 Beta 4

Date: 31st March, 2011

IMS GLC Auto-generation Binding Tool-kit (I-BAT)

This file was auto-generated using the IMS 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. IMS 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 IMS GLC "I-BAT" Documentation available at the IMS GLC web-site.

Services

Name

Documentation

BulkDataExchangeManagementServiceSyncService

Service Information

Author: Colin Smythe

Date: 30 June 2011

Version: Final 1.0

Status: Final Release

Description: The Bulk Data Exchange Management Service (BDEMS) is composed of a single interface. This service is 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.

Service : BulkDataExchangeManagementServiceSyncService

Port Name Binding Address Extensibility Documentation

BulkDataExchangeManagerSyncSoapPort

BulkDataExchangeManagerSyncSoapBinding

<soap11:address location="http://www.imsglobal.org/lis/bdems1p0/BulkDataExchangeManagerSyncSoap/"/>

N/A

Binding : BulkDataExchangeManagerSyncSoapBinding
Port Type	BulkDataExchangeManagerSyncPortType
Extensibility	`<soap11:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>`
Operations	announceBulkDataExchange, announceFailureBulkDataExchange, reportBulkDataExchange, requestBulkDataExchange, ignoreBulkDataExchange, cancelBulkDataExchange,

Port Type : BulkDataExchangeManagerSyncPortType

Operation Name

Input message

Output message

Documentation

announceBulkDataExchange

announceBulkDataExchangeRequest

announceBulkDataExchangeResponse

The 'announceBulkDataExchange' operation is used by a Service Provider to announce the availability of a bulk data obect that is ready for retrieval by Service Consumers. This call causes the suspension of real-time event notification.

announceFailureBulkDataExchange

announceFailureBulkDataExchangeRequest

announceFailureBulkDataExchangeResponse

The 'announceFailureBulkDataExchange' operation is used by a Service Provider to inform the Service Consumer that a previously issued, and acknowledged, 'requestBulkDataExchange' transaction cannot be serviced.

reportBulkDataExchange

reportBulkDataExchangeRequest

reportBulkDataExchangeResponse

The 'reportBulkDataExchange' operation is used by a Service Consumer to report to a Service Provider the retrieval of the bulk data object whose availability was announced previously. This causes real-time event processing to be restarted.

requestBulkDataExchange

requestBulkDataExchangeRequest

requestBulkDataExchangeResponse

The 'requestBulkDataExchange' operation is used by a Service Consumer to request a bulk data exchange from the Service Provider.

ignoreBulkDataExchange

ignoreBulkDataExchangeRequest

ignoreBulkDataExchangeResponse

The 'ignoreBulkDataExchange' operation is issued by a Service Consumer to inform the Service Provider that a previously issued anounce bulk data exchange request will be ignored. This causes real-time event processing to be restarted in the Provider and Consumer.

cancelBulkDataExchange

cancelBulkDataExchangeRequest

cancelBulkDataExchangeResponse

The 'cancelBulkDataExchange' operation is issued by a Service Consumer to inform the Service Provider that a previously issued bulk data exchange request is now cancelled. This causes real-time event processing to be restarted in the Provider and Consumer.

4.2 Messages

announceBulkDataExchangeRequest

Part Name

Element

Type

Documentation

Parameters

tns:announceBulkDataExchangeRequest

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

imsx_epaRequestHeaderInfoRequest

epa:imsx_epaRequestHeaderInfo

N/A

announceBulkDataExchangeResponse

Part Name

Element

Type

Documentation

Response

tns:announceBulkDataExchangeResponse

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

announceFailureBulkDataExchangeRequest

Part Name

Element

Type

Documentation

Parameters

tns:announceFailureBulkDataExchangeRequest

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

imsx_epaRequestHeaderInfoRequest

epa:imsx_epaRequestHeaderInfo

N/A

announceFailureBulkDataExchangeResponse

Part Name

Element

Type

Documentation

Response

tns:announceFailureBulkDataExchangeResponse

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

reportBulkDataExchangeRequest

Part Name

Element

Type

Documentation

Parameters

tns:reportBulkDataExchangeRequest

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

imsx_epaRequestHeaderInfoRequest

epa:imsx_epaRequestHeaderInfo

N/A

reportBulkDataExchangeResponse

Part Name

Element

Type

Documentation

Response

tns:reportBulkDataExchangeResponse

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

requestBulkDataExchangeRequest

Part Name

Element

Type

Documentation

Parameters

tns:requestBulkDataExchangeRequest

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

imsx_epaRequestHeaderInfoRequest

epa:imsx_epaRequestHeaderInfo

N/A

requestBulkDataExchangeResponse

Part Name

Element

Type

Documentation

Response

tns:requestBulkDataExchangeResponse

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

ignoreBulkDataExchangeRequest

Part Name

Element

Type

Documentation

Parameters

tns:ignoreBulkDataExchangeRequest

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

imsx_epaRequestHeaderInfoRequest

epa:imsx_epaRequestHeaderInfo

N/A

ignoreBulkDataExchangeResponse

Part Name

Element

Type

Documentation

Response

tns:ignoreBulkDataExchangeResponse

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

cancelBulkDataExchangeRequest

Part Name

Element

Type

Documentation

Parameters

tns:cancelBulkDataExchangeRequest

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

imsx_epaRequestHeaderInfoRequest

epa:imsx_epaRequestHeaderInfo

N/A

cancelBulkDataExchangeResponse

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).

top | toc

5. XSD File Documentation

The XSD file documentation has been produced by the Oxygen XML Editing tool.

5.1 Service Data Model

Click on the Section header to access this documentation for the data models in the service description.

5.2 File Data Model

Click on the Section header to access this documentation for the data models for file-based storage.

top | toc

6. Binding of the Vocabularies

The vocabularies in the BDEMS are:

Parameter type vocabulary � the set of values for the type of parameter that are permitted for the bulk data exchange data model. The PSM for the vocabulary is shown in Figures 6.1a, 6.1b, 6.1c and 6.1d;
Transaction fail status code vocabulary � the set of values for the failure codes for transactions in the bulk data exchange management service. The PSM for the vocabulary is shown in Figures 6.2a and 6.2b;
Announce failure report vocabulary � the set of values for the failure report codes for an announce request in the bulk data exchange management service. The PSM for the vocabulary is shown in Figure 6.3;
Filter types vocabulary � the set of values for the filter types in a request in the bulk data exchange management service. The PSM for the vocabulary is shown in Figures 6.4a and 6.4b;
Filter values for an object filter type vocabulary � the set of values for the filter values of a filter type of 'object' in a request in the bulk data exchange management service. The PSM for the vocabulary is shown in Figure 6.5.

These vocabularies are the default set maintained under the IMS 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 IMS GLC.� As part of a profiling process entirely new vocabularies may be defined to replace the default set.

Figure 6.1a The PSM representation of the parametertype vocabulary for the BDEMS.

Figure 6.1b The PSM representation of the parametertype vocabulary for the BDEMS.

Figure 6.1c The PSM representation of the parametertype vocabulary for the BDEMS.

Figure 6.1d The PSM representation of the parametertype vocabulary for the BDEMS.

Figure 6.2a The PSM representation of the transactionfailstatus vocabulary for the BDEMS.

Figure 6.2b The PSM representation of the transactionfailstatus vocabulary for the BDEMS.

Figure 6.3 The PSM representation of the announcefailurereport vocabulary for the BDEMS.

Figure 6.4a The PSM representation of the filtertype vocabulary for the BDEMS.

Figure 6.4b The PSM representation of the filtertype vocabulary for the BDEMS.

Figure 6.5 The PSM representation of the filtervalueobject vocabulary for the BDEMS.

top | toc

Appendix A - Listing of the WSDLs

The WSDL bindings are for a Synchronous SOAP implementation only. The WSDL files, expressed using WSDLv1.1, are:

The combined WSDL/XSD file (this contains the WSDL and XSD descriptions in a single file) � BulkDataExchangeManagementServicev1p0_SyncSingle_v1p0.wsdl
The single WSDL file (used in conjunction with the separate XSD file) is available to LIS Alliance members. Click here to join the Alliance. Also available to Alliance members are combined WSDL/XSD files but where each file describes a single interface/port.

These files were generated by the I-BATv0.9.5 tool using the PSM representation described in Section 2.

top | toc

Appendix B - Listing of the XSDs

The XSD files are:

The stand-alone XSD � BulkDataExchangeManagmentServiceSyncXSD.xsd
The IMS General Web Services XSD for the validation of the end-point addressing headers - imsepav1p0_v1p0.xsd
The XSD for the external data file (this XSD also requires the data file validation XSDs from the PMS, GMS, MMS, CMS and OMS bindings) � imsbdemsFileData_v1p0.xsd
The XSD for the BDEMS containing the external data structure definitions for use with the separated WSDL file(s) is available to LIS Alliance members. Click here to join the Alliance.

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.

top | toc

Appendix C - Vocabulary VDEX Instance File Listings

The BDEMS vocabularies are:

Parameter types vocabulary � parametertypevocabularyv1p0.xml;
Filter types vocabulary � filtertypevocabularyv1p0.xml;
Filter types for filter objects vocabulary � filtervalueobjectvocabularyv1p0.xml;
Transaction failure status codes vocabulary � transactionfailstatusvocabularyv1p0.xml;
Announce failure reports vocabulary � announcefailurereportvocabularyv1p0.xml.

These vocabularies are each expressed as an instance of the IMS GLC 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/.

top | toc

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.

Operation Name	Input (Request) SOAP Message	Output (Response) SOAP Message
announceBulkDataExchange	announceBulkDataExchangeRequest	announceBulkDataExchangeResponse
announceFailureBulkDataExchange	announceFailureBulkDataExchangeRequest	announceFailureBulkDataExchangeResponse
reportBulkDataExchange	reportBulkDataExchangeRequest	reportBulkDataExchangeResponse
requestBulkDataExchange	requestBulkDataExchangeRequest	requestBulkDataExchangeResponse
ignoreBulkDataExchange	ignoreBulkDataExchangeRequest	ignoreBulkDataExchangeResponse
cancelBulkDataExchange	cancelBulkDataExchangeRequest	cancelBulkDataExchangeResponse

NOTE: The above examples do not demonstrate the use of the end-point addressing SOAP header.

top | toc

About This Document

Title	IMS GLC Bulk Data Exchange Management Service WSDL/XSD Binding
Editor	Colin Smythe (IMS GLC)
Co-Chairs	Linda Feng (Oracle), Bill Lee (Desire2learn)
Version	1.0
Version Date	30 June 2011
Release	Final 1.0
Status	Final Release
Summary	This document contains the description of the IMS GLC Bulk Data Exchange Management Service v1.0 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	http://www.imsglobal.org/lis/

top | toc

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)
John 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	IMS Global Learning Consortium, Inc.
Reinhold Staudinger	Blackboard (USA)
Nick Terrible	University of Wisconsin (USA)
Jason Zhong	SungardHE (USA)

top | toc

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.

top | toc

IMS Global Learning Consortium, Inc. (“IMS GLC”) is publishing the information contained in this document (“Specification”) for purposes of scientific, experimental, and scholarly collaboration only.

IMS 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.

IMS GLC would appreciate receiving your comments and suggestions.

Please contact IMS GLC through our website at http://www.imsglobal.org.

Please refer to Document Name: IMS GLC BDEMS v1.0 WSDL/XSD Binding Final Release v1.0
Date: 30 June 2011.

Table of Contents

1. Introduction

1.1 Scope and Context

1.2 Structure of this Document

1.3 Nomenclature

1.4 References

2.1 Service Description

2.2 Data for the Service Operations

2.3 File-based Data Exchange Data Model

3. Application of the Binding Guidelines

4. WSDL File Documentation

4.1 Overview

WSDL File Information

License Notice for Users

Distribution Notice for Developers

UML Source File Information

Source XSLT File Information

IMS GLC Auto-generation Binding Tool-kit (I-BAT)

Service Information

4.2 Messages

5. XSD File Documentation

6. Binding of the Vocabularies

About This Document

List of Contributors

Revision History