IMS Final Release

IMS logo

IMS Global Course Management Service WSDL/XSD Binding

Version 1.0.1

Final Release

 

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

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

top


Table of Contents

  1. Introduction

{C}{C}a.       {C}{C}Scope and Context

{C}{C}b.      {C}{C}Structure of this Document

{C}{C}c.       {C}{C}Nomenclature

{C}{C}d.      {C}{C}References

  1. Platform Specific Model of the Binding

{C}{C}.        {C}{C}Service Description

{C}{C}a.       {C}{C}Data for the Servce Operations

{C}{C}b.      {C}{C}Course Data Model

{C}{C}c.       {C}{C}File Data Model

  1. Application of the Binding Guidelines
  2. WSDL File Documentation

{C}{C}.        {C}{C}Overview

{C}{C}a.       {C}{C}Messages

  1. XSD File Documentation

{C}{C}.        {C}{C}Service Data Model

{C}{C}a.       {C}{C}File Data Model

  1. Binding of the Vocabularies
  2. Appendix A - Listing of the WSDLs
  3. Appendix B - Listing of the XSDs
  4. Appendix C - Vocabulary VDEX Instance File Listings
  5. Appendix D - Example SOAP Messages
  6. About This Document
  7. Revision History

top


1. Introduction

This document is a part of the IMS Global Course Management Service (CMS) v1.0.1 specification. The binding details how the Course Management Service Information Model is realised as a Web Service; in the form of a Web Services Description Language (WSDL) file. The CMS 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.

1.1 Scope and Context

The IMS Global CMS WSDL Binding v1.0 is used in conjunction with the following documents:

  1. IMS Global Course Management Service Information Model v1.0.1 [CMS, 13] – the behaviour and data model definition of the Course Management Service;
  2. IMS Global Learning Information Services Best Practice and Implementation Guide v2.0.1 [LIS, 13b] – key information on how to adopt and implement the specification.

This WSDL binding takes the Course 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 IMS Global 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 Global CMS 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 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 CMS WSDL files;

Appendix B - Listing of the XSD Files

This is the full listing of the CMS 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

CMS

Course 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

PIM

Protocol Independent Model

PSM

Platform Specific Model

UML

Unified Modelling Language

VDEX

Vocabulary Definition Exchange

W3C

World Wide Web Consortium

WSDL

Web 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

[CMS, 13]

IMS Global Course Management Services Information Model Specification v1.0.1 Final Release, L.Feng, B.Lee and C.Smythe, IMS Global Learning Consortium, September 2013.

[GWS, 06a]

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.

[GWS, 06b]

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.

[I-BAT, 06]

IMS Binding Auto-generation Toolkit Manual v1.0, C.Smythe, IMS Global Learning Consortium, July 2006.

[LIS, 13a]

IMS Global Learning Information Services Specification v2.0.1 Final Release , L.Feng, B.Lee and C.Smythe, IMS Global Learning Consortium, September 2013.

[LIS, 13b]

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.

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

Figure 2.2 is the PSM of the service model description for the CMS. The PSM is derived from the Platform Independent Model that was documented within the information model for the CMS specification [CMS, 13].

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

2.2 Data for the Service Operations

The data model for the service opertaions 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 CMS.

Figure 2.4 The PSM representation of the status information data model description for the CMS.

2.3 Course Data Models

The PSM for the Course data models are shown in Figures 2.5, 2.6, 2.7, 2.8 and 2.9. Figure 2.5 is the CourseTemplate data model, Figure 2.6 is the CourseOffering data model, Figure 2.7 is the CourseSection data model, Figure 2.8 is the SectionAssociation data model and Figure 2.9 contains the set of common data model classes.

Figure 2.5 The PSM representation of the CourseTemplate data model description for the CMS.

Figure 2.6 The PSM representation of the CourseOffering data model description for the CMS.

Figure 2.7 The PSM representation of the CourseSection data model description for the CMS.

Figure 2.8 The PSM representation of the SectionAssociation data model description for the CMS.

Figure 2.9 The PSM representation of the common data models description for the CMS.

2.4 File-based Data Exchange Data Model

The PSM for the file-based Course data models are shown in Figures 2.10, 2.11, 2.12, 2.13 and 2.14. Figure 2.10 is the CourseTemplateRecord data model, Figure 2.11 is the CourseOfferingRecord data model, Figure 2.12 is the CourseSectionRecord data model, Figure 2.13 is the SectionAssociationRecord data model and Figure 2.14 contains the set of common data model classes.

Figure 2.10 The PSM representation of the CourseTemplateRecord data model description for file storage in the CMS.

Figure 2.11 The PSM representation of the CourseOfferingRecord data model description for file storage in the CMS.

Figure 2.12 The PSM representation of the CourseSectionRecord data model description for file storage in the CMS.

Figure 2.13 The PSM representation of the SectionAssociationRecord data model description for file storage in the CMS.

Figure 2.14 The PSM representation of the common data model description for file storage in the CMS.

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. The binding files are available in three forms:

  • A single combined WSDL/XSD – CourseManagementServicev1p0_SyncSingle_v1p0.wsdl;
  • As single combined WSDL/XSD for each interface – CourseManagementServicev1p0_CourseTemplateManagerSyncSingle_v1p0.wsdl, CourseManagementServicev1p0_CourseOfferingManagerSyncSingle_v1p0.wsdl, CourseManagementServicev1p0_CourseSectionManagerSyncSingle_v1p0.wsdl and CourseManagementServicev1p0_SectionAssociationManagerSyncSingle_v1p0.wsdl
  • Separated WSDL and XSD files – CourseManagementServicev1p0_SyncWSDL_v1p0.wsdl and CourseManagementServiceSyncXSD.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

CourseTemplateRecordSet

Class

2.5

CourseTemplateRecordSet.Type

ComplexType

  • courseTemplateRecord

Attribute

2.5

CourseTemplateRecord

courseTemplateRecord

Element

CourseTemplateRecord

Class

2.5

5.2

CourseTemplateRecord.Type

ComplexType

  • sourcedGUID

Attribute

2.5

SourcedGUID

5.3

sourcedId

Element

  • courseTemplate

Attribute

2.5

CourseTemplate

courseTemplate

Element

SourcedGUID

Class

2.5

5.107

SourcedGUID.Type

ComplexType

  • refAgentInstanceId

Attribute

2.5

NormalizedString

5.108

refAgentInstanceId

Element

  • sourcedId

Attribute

2.5

SourcedId

5.109

sourcedId

Element

CourseTemplate

Class

2.5

5.10

CourseTemplate.Type

ComplexType

  • label

Attribute

2.5

Text

5.11

label

Element

  • title

Attribute

2.5

Text

5.12

title

Element

  • catalogDescription

Attribute

2.5

Description

5.13

catalogDescription

Element

  • courseNumber

Attribute

2.5

Text

5.14

courseNumber

Element

  • status

Attribute

2.6

External Vocabulary

5.15

status

Element

  • defaultCredits

Attribute

2.5

Text

5.16

defaultCredits

Element

  • org

Attribute

2.5

Org

5.17

org

Element

  • listofTopics

Attribute

2.5

ListofTopics

5.18

listofTopics

Element

  • listofPrerequisites

Attribute

2.5

ListofPrerequisites

5.19

listofPrerequisites

Element

  • dataSource

Attribute

2.5

GUID

5.20

dataSource

Element

  • recordInfo

Attribute

2.5

Metadata

5.21

recordInfo

Element

  • extension

Attribute

2.5

IMSExtension

5.22

extension

Element

ListofPrerequisites

Class

2.5

5.23

ListofPrerequisites.Type

ComplexType

  • prerequisite

Attribute

2.5

Text

5.24

prerequisite

Element

ListofTopics

Class

2.5

5.25

ListofTopics.Type

ComplexType

  • topic

Attribute

2.5

Text

5.26

topic

Element

CourseOfferingRecordSet

Class

2.6

CourseOfferingRecordSet.Type

ComplexType

  • courseOfferingRecord

Attribute

2.6

CourseOfferingRecord

courseOfferingRecord

Element

CourseOfferingRecord

Class

2.6

5.4

CourseOfferingRecord.Type

ComplexType

  • sourcedGUID

Attribute

2.5

SourcedGUID

5.5

sourcedId

Element

  • courseOffering

Attribute

2.6

CourseOffering

courseOffering

Element

CourseOffering

Class

2.6

5.27

CourseOffering.Type

ComplexType

  • label

Attribute

26

Text

5.28

label

Element

  • title

Attribute

2.6

Text

5.29

title

Element

  • parentTemplateId

Attribute

2.6

GUID

5.30

parentTemplateId

Element

  • catalogDescription

Attribute

2.6

Description

5.31

catalogDescription

Element

  • defaultCredits

Attribute

2.6

Text

5.32

defaultCredits

Element

  • status

Attribute

2.6

External Vocabulary

5.33

status

Element

  • academicSession

Attribute

2.6

External Vocabulary

5.34

academicSession

Element

  • org

Attribute

2.6

Org

5.35

org

Element

  • timeFrame

Attribute

2.6

TimeFrame

5.36

timeFrame

Element

  • enrollControl

Attribute

2.6

EnrollControl

5.37

enrollControl

Element

  • dataSource

Attribute

2.6

GUID

5.38

dataSource

Element

  • recordInfo

Attribute

2.6

Metadata

5.39

recordInfo

Element

  • extension

Attribute

2.6

IMSExtension

5.40

extension

Element

CourseSectionRecordSet

Class

2.7

CourseOfferingRecordSet.Type

ComplexType

  • courseSectionRecord

Attribute

2.7

CourseSectionRecord

courseSectionRecord

Element

CourseSectionRecord

Class

2.7

5.6

CourseSectionRecord.Type

ComplexType

  • sourcedGUID

Attribute

2.5

SourcedGUID

5.7

sourcedId

Element

  • courseSection

Attribute

2.7

CourseSection

courseSection

Element

CourseSection

Class

2.7

5.41

CourseSection.Type

ComplexType

  • label

Attribute

2.7

Text

5.42

label

Element

  • title

Attribute

2.7

Text

5.43

title

Element

  • parentOfferingId

Attribute

2.7

GUID

5.44

parentOfferingId

Element

  • catalogDescription

Attribute

2.7

Description

5.45

catalogDescription

Element

  • status

Attribute

2.7

External Vocabulary

5.46

status

Element

  • defaultCredits

Attribute

2.7

Text

5.47

defaultCredits

Element

  • category

Attribute

2.7

External Vocabulary

5.48

status

Element

  • maxNumberofStudents

Attribute

2.7

Integer

5.49

maxNumberofStudents

Element

  • numberofStudents

Attribute

2.7

Integer

5.50

numberofStudents

Element

  • academicSession

Attribute

2.7

External Vocabulary

5.51

academicSession

Element

  • org

Attribute

2.7

Org

5.52

org

Element

  • timeFrame

Attribute

2.7

TimeFrame

5.53

timeFrame

Element

  • enrollControl

Attribute

2.7

EnrollControl

5.54

enrollControl

Element

  • location

Attribute

2.7

Text

5.55

locaton

Element

  • notes

Attribute

2.7

Text

5.56

locaton

Element

  • meeting

Attribute

2.7

Text

5.57

locaton

Element

  • dataSource

Attribute

2.7

GUID

5.58

dataSource

Element

  • recordInfo

Attribute

2.7

Metadata

5.59

recordInfo

Element

  • extension

Attribute

2.7

IMSExtension

5.60

extension

Element

SectionAssociationRecordSet

Class

2.8

CourseOfferingRecordSet.Type

ComplexType

  • sectionAssociationRecord

Attribute

2.8

SectionAssociationRecord

sectionAssociationRecord

Element

SectionAssociationRecord

Class

2.8

5.8

CourseSectionAssociationRecord.Type

ComplexType

  • sourcedGUID

Attribute

2.5

SourcedGUID

5.9

sourcedId

Element

  • sectionAssociation

Attribute

2.8

SectionAssociation

sectionAssociation

Element

SectionAssociation

Class

2.8

5.61

SectionAssociation.Type

ComplexType

  • label

Attribute

2.8

Text

5.62

label

Element

  • title

Attribute

2.8

Text

5.63

title

Element

  • status

Attribute

2.8

External Vocabulary

5.64

status

Element

  • courseSectionIdList

Attribute

2.8

ListofCourseSectionIds

5.65

courseSectionIdList

Element

  • dataSource

Attribute

2.8

GUID

5.66

dataSource

Element

  • recordInfo

Attribute

2.8

Metadata

5.67

recordInfo

Element

  • extension

Attribute

2.8

IMSExtension

5.68

extension

Element

ListofCourseSectionIds

Class

2.8

5.69

ListofCourseSectionIds.Type

ComplexType

  • courseSectionId

Attribute

2.8

GUID

5.70

courseSectionId

Element

EnrollControll

Class

2.9

5.76

EnrollControll.Type

ComplexType

  • enrollAccept

Attribute

2.9

Boolean

5.77

enrollAccept

Element

  • enrollAllowed

Attribute

2.9

Boolean

5.78

enrollAllowed

Element

Org

Class

2.9

5.71

Org.Type

ComplexType

  • orgName

Attribute

2.9

Text

5.72

orgName

Element

  • orgUnit

Attribute

2.9

Text

5.73

orgUnit

Element

  • type

Attribute

2.9

Text

5.74

type

Element

  • id

Attribute

2.9

Text

5.75

id

Element

TimeFrame

Class

2.9

5.79

TimeFrame.Type

ComplexType

  • begin

Attribute

2.9

DateTime

5.80

begin

Element

  • end

Attribute

2.9

DateTime

5.81

end

Element

  • restrict

Attribute

2.9

Boolean

5.82

restrict

Element

  • adminPeriod

Attribute

2.9

Text

5.83

adminPeriod

Element

Description

Class

2.9

5.84

Description.Type

ComplexType

  • shortDescription

Attribute

2.9

Text

5.85

shortDescription

Element

  • longDescription

Attribute

2.9

Text

5.86

longDescription

Element

  • fullDescription

Attribute

2.9

FullDescription

5.87

fullDescription

Element

FullDescription

Class

2.9

5.88

FullDescription.Type

ComplexType

  • mediamode

Attribute

2.9

Enumerated

5.89

mediamode

Element

  • contentRefType

Attribute

2.9

Enumerated

5.90

contentRefType

Element

  • mimeType

Attribute

2.9

NormailzedString

5.91

mimeType

Element

  • descriptionText

Attribute

2.9

Text

5.92

descriptionText

Element

Metadata

Class

2.9

5.95

Metadata.Type

ComplexType

  • metadataNameVocabulary

Attribute

2.9

AnyURI

5.96

metadataNameVocabulary

Element

  • metadataTypeVocabulary

Attribute

2.9

AnyURI

5.97

metadataTypeVocabulary

Element

  • metadataField

Attribute

2.9

ExtensionField

5.98

metadataField

Element

IMSExtension

Class

2.9

5.100

IMSExtension.Type

ComplexType

  • extensionNameVocabulary

Attribute

2.9

AnyURI

5.101

extensionNameVocabulary

Element

  • extensionTypeVocabulary

Attribute

2.9

AnyURI

5.102

extensionTypeVocabulary

Element

  • extensionField

Attribute

2.9

ExtensionField

TBD

extensionField

Element

ExtensionField

Class

2.9

5.103

ExtensionField.Type

ComplexType

  • fieldName

Attribute

2.9

NormalizedString

5.104

fieldName

Element

  • fieldType

Attribute

2.9

NormalizedString

5.105

fieldType

Element

  • fieldValue

Attribute

2.9

NormalizedString

5.106

fieldValue

Element

Text

Class

2.9

5.93

Text.Type

ComplexType

  • language

Attribute

2.9

NormailzedString

5.94

language

Element

  • textString

Attribute

2.9

String

5.95

textString

Element

imsx_StatusInfo

Class

2.4

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:

{C}{C}I.                        {C}{C}The 'PSM Reference' field refers to information in the PSM description (Section 2 in this document). The sub-fields are:

{C}{C}a.       {C}{C}Name – the name of the data structure in the PSM and PIM

{C}{C}b.      {C}{C}UML Type – the type of UML construct i.e. either Class or Attribute

{C}{C}c.       {C}{C}Figure – the reference Figure number in this document;

{C}{C}       II.            {C}{C}The 'PIM Reference' field refers to infomation in the CMS Information Model [CMS, 12]. The sub-fields are:

{C}{C}.        {C}{C}Type – the type of the data structure in the Information Model

{C}{C}a.       {C}{C}Table – the reference number of Tabular description in the corresponding Information Model document;

{C}{C}      III.            {C}{C}The 'XSD Reference' field refers to information in the XSD descriptions (Section 5 in this document). The sub-fields are:

{C}{C}.        {C}{C}Name – the name of the field in the XSD(s)

{C}{C}a.       {C}{C}Type – the type of XSD construct i.e. either a ComplexType or Element.

top | toc


4. WSDL File Documentation

WSDL file: "CourseManagementServiceSyncSingle.wsdl"

Target namespace: http://www.imsglobal.org/services/lis/cms1p0/wsdl11/sync/imscms_v1p0

4.1 Overview

Services

CourseManagementServiceSyncService

Bindings

CourseTemplateManagerSyncSoapBinding

CourseOfferingManagerSyncSoapBinding

CourseSectionManagerSyncSoapBinding

SectionAssociationManagerSyncSoapBinding

Port types

CourseTemplateManagerSyncPortType

CourseOfferingManagerSyncPortType

CourseSectionManagerSyncPortType

SectionAssociationManagerSyncPortType

Messages

createCourseTemplateRequest, createCourseTemplateResponse, createByProxyCourseTemplateRequest, createByProxyCourseTemplateResponse, deleteCourseTemplateRequest, deleteCourseTemplateResponse, readCourseTemplateRequest, readCourseTemplateResponse, readAllCourseTemplateIdsRequest, readAllCourseTemplateIdsResponse, readCourseTemplateIdsFromSavePointRequest, readCourseTemplateIdsFromSavePointResponse, readCourseTemplatesRequest, readCourseTemplatesResponse, readCourseTemplatesFromSavePointRequest, readCourseTemplatesFromSavePointResponse, readCourseOfferingIdsForCourseTemplateRequest, readCourseOfferingIdsForCourseTemplateResponse, updateCourseTemplateRequest, updateCourseTemplateResponse, replaceCourseTemplateRequest, replaceCourseTemplateResponse, discoverCourseTemplateIdsRequest, discoverCourseTemplateIdsResponse, changeCourseTemplateIdentifierRequest, changeCourseTemplateIdentifierResponse, createCourseOfferingRequest, createCourseOfferingResponse, createByProxyCourseOfferingRequest, createByProxyCourseOfferingResponse, createCourseOfferingFromCourseOfferingRequest, createCourseOfferingFromCourseOfferingResponse, deleteCourseOfferingRequest, deleteCourseOfferingResponse, readCourseOfferingRequest, readCourseOfferingResponse, readAllCourseOfferingIdsRequest, readAllCourseOfferingIdsResponse, readCourseOfferingIdsFromSavePointRequest, readCourseOfferingIdsFromSavePointResponse, readAllActiveCourseOfferingIdsForAcademicSessionRequest, readAllActiveCourseOfferingIdsForAcademicSessionResponse, readCourseSectionIdsForCourseOfferingRequest, readCourseSectionIdsForCourseOfferingResponse, readCourseOfferingsRequest, readCourseOfferingsResponse, readCourseOfferingsFromSavePointRequest, readCourseOfferingsFromSavePointResponse, updateCourseOfferingRequest, updateCourseOfferingResponse, updateCourseOfferingStatusRequest, updateCourseOfferingStatusResponse, replaceCourseOfferingRequest, replaceCourseOfferingResponse, discoverCourseOfferingIdsRequest, discoverCourseOfferingIdsResponse, changeCourseOfferingIdentifierRequest, changeCourseOfferingIdentifierResponse, createCourseSectionRequest, createCourseSectionResponse, createByProxyCourseSectionRequest, createByProxyCourseSectionResponse, createCourseSectionFromCourseSectionRequest, createCourseSectionFromCourseSectionResponse, deleteCourseSectionRequest, deleteCourseSectionResponse, readCourseSectionRequest, readCourseSectionResponse, readAllCourseSectionIdsRequest, readAllCourseSectionIdsResponse, readCourseSectionIdsFromSavePointRequest, readCourseSectionIdsFromSavePointResponse, readCourseSectionsRequest, readCourseSectionsResponse, readCourseSectionsFromSavePointRequest, readCourseSectionsFromSavePointResponse, updateCourseSectionRequest, updateCourseSectionResponse, updateCourseSectionStatusRequest, updateCourseSectionStatusResponse, replaceCourseSectionRequest, replaceCourseSectionResponse, discoverCourseSectionIdsRequest, discoverCourseSectionIdsResponse, changeCourseSectionIdentifierRequest, changeCourseSectionIdentifierResponse, createSectionAssociationRequest, createSectionAssociationResponse, createByProxySectionAssociationRequest, createByProxySectionAssociationResponse, deleteSectionAssociationRequest, deleteSectionAssociationResponse, readSectionAssociationRequest, readSectionAssociationResponse, readAllSectionAssociationIdsRequest, readAllSectionAssociationIdsResponse, readSectionAssociationIdsFromSavePointRequest, readSectionAssociationIdsFromSavePointResponse, readSectionAssociationsRequest, readSectionAssociationsResponse, readSectionAssociationsFromSavePointRequest, readSectionAssociationsFromSavePointResponse, addCourseSectionIdRequest, addCourseSectionIdResponse, removeCourseSectionIdRequest, removeCourseSectionIdResponse, updateSectionAssociationRequest, updateSectionAssociationResponse, replaceSectionAssociationRequest, replaceSectionAssociationResponse, discoverSectionAssociationIdsRequest, discoverSectionAssociationIdsResponse, changeSectionAssociationIdentifierRequest, changeSectionAssociationIdentifierResponse,

 

WSDL Definition

Name

Documentation

CourseManagementServiceSyncServices

WSDL File Information

Services: CourseManagementService (Synchronous Communications)

Author: Colin Smythe

Date: 30 June 2011

Version: Final 1.0

Status: Final Release

Description: The Course Management Service. This 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. This service was not a part of the IMS Enterprise Services v1.0.

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 Course Management Service Version 1.0 found at http://www.imsglobal.org/lis/CMS/imsCMS_InfoPDv1.pdf and the original IMS schema binding or code base http://www.imsglobal.org/lis/CMS/imsCMS_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 Globals 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:-

  • 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 Global and receive an email from IMS Global 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 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: UMLtoWSDLTransformv0p9p5.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

CourseManagementServiceSyncService

Service Information

Author: Colin Smythe

Date: 30 June 2011

Version: Final 1.0

Status: Final Release

Description: The Course Management Service is composed of four interfaces each of which has several operations.

History: Version 1.0: This is the first formal release of this service. This service is a part of the IMS LIS v2.0 specification

 

Service : CourseManagementServiceSyncService

Port Name

Binding

Address Extensibility

Documentation

CourseTemplateManagerSyncSoapPort

CourseTemplateManagerSyncSoapBinding

<soap11:address location="http://www.imsglobal.org/lis/CMS/CourseTemplateManagerSyncSoap/"/>

N/A

CourseOfferingManagerSyncSoapPort

CourseOfferingManagerSyncSoapBinding

<soap11:address location="http://www.imsglobal.org/lis/CMS/CourseOfferingManagerSyncSoap/"/>

N/A

CourseSectionManagerSyncSoapPort

CourseSectionManagerSyncSoapBinding

<soap11:address location="http://www.imsglobal.org/lis/CMS/CourseSectionManagerSyncSoap/"/>

N/A

SectionAssociationManagerSyncSoapPort

SectionAssociationManagerSyncSoapBinding

<soap11:address location="http://www.imsglobal.org/lis/CMS/SectionAssociationManagerSyncSoap/"/>

N/A

 

Binding : CourseTemplateManagerSyncSoapBinding

Port Type

CourseTemplateManagerSyncPortType

Extensibility

<soap11:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>

Operations

createCourseTemplate, createByProxyCourseTemplate, deleteCourseTemplate, readCourseTemplate, readAllCourseTemplateIds, readCourseTemplateIdsFromSavePoint, readCourseTemplates, readCourseTemplatesFromSavePoint, readCourseOfferingIdsForCourseTemplate, updateCourseTemplate, replaceCourseTemplate, discoverCourseTemplateIds, changeCourseTemplateIdentifier,

 

Binding : CourseOfferingManagerSyncSoapBinding

Port Type

CourseOfferingManagerSyncPortType

Extensibility

<soap11:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>

Operations

createCourseOffering, createByProxyCourseOffering, createCourseOfferingFromCourseOffering, deleteCourseOffering, readCourseOffering, readAllCourseOfferingIds, readCourseOfferingIdsFromSavePoint, readAllActiveCourseOfferingIdsForAcademicSession, readCourseSectionIdsForCourseOffering, readCourseOfferings, readCourseOfferingsFromSavePoint, updateCourseOffering, updateCourseOfferingStatus, replaceCourseOffering, discoverCourseOfferingIds, changeCourseOfferingIdentifier,

 

Binding : CourseSectionManagerSyncSoapBinding

Port Type

CourseSectionManagerSyncPortType

Extensibility

<soap11:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>

Operations

createCourseSection, createByProxyCourseSection, createCourseSectionFromCourseSection, deleteCourseSection, readCourseSection, readAllCourseSectionIds, readCourseSectionIdsFromSavePoint, readCourseSections, readCourseSectionsFromSavePoint, updateCourseSection, updateCourseSectionStatus, replaceCourseSection, discoverCourseSectionIds, changeCourseSectionIdentifier,

 

Binding : SectionAssociationManagerSyncSoapBinding

Port Type

SectionAssociationManagerSyncPortType

Extensibility

<soap11:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>

Operations

createSectionAssociation, createByProxySectionAssociation, deleteSectionAssociation, readSectionAssociation, readAllSectionAssociationIds, readSectionAssociationIdsFromSavePoint, readSectionAssociations, readSectionAssociationsFromSavePoint, addCourseSectionId, removeCourseSectionId, updateSectionAssociation, replaceSectionAssociation, discoverSectionAssociationIds, changeSectionAssociationIdentifier,

 

Port Type : CourseTemplateManagerSyncPortType

Operation Name

Input message

Output message

Documentation

createCourseTemplate

createCourseTemplateRequest

createCourseTemplateResponse

The 'createCourseTemplate' operation is responsible for creating a new CourseTemplate object on the service provider. The service consumer supplies the 'sourcedId' to be used to identify the new CourseTemplate.

createByProxyCourseTemplate

createByProxyCourseTemplateRequest

createByProxyCourseTemplateResponse

The 'createByProxyCourseTemplate' operation is responsible for creating a new CourseTemplate object on the service provider. The service provider supplies the 'sourcedId' to be used to identify the new CourseTemplate.

deleteCourseTemplate

deleteCourseTemplateRequest

deleteCourseTemplateResponse

The 'deleteCourseTemplate' operation deletes the identified CourseTemplate object. This means the 'sourcedId' can then be reused for another object.

readCourseTemplate

readCourseTemplateRequest

readCourseTemplateResponse

The 'readCourseTemplate' operation requests the service provider to return all of the data stored for the identified CourseTemplate object.

readAllCourseTemplateIds

readAllCourseTemplateIdsRequest

readAllCourseTemplateIdsResponse

The 'readAllCourseTemplateIds' operation requests the service provider to return the SourcedIds for all of the CourseTemplate objects.

readCourseTemplateIdsFromSavePoint

readCourseTemplateIdsFromSavePointRequest

readCourseTemplateIdsFromSavePointResponse

The 'readCourseTemplateIdsFromSavePoint' operation requests the service provider to return the SourcedIds for all of the CourseTemplate objects from the defined reference 'savePoint'.

readCourseTemplates

readCourseTemplatesRequest

readCourseTemplatesResponse

The 'readCourseTemplates' operation requests the service provider to return all of the data stored for the identified set of CourseTemplate objects.

readCourseTemplatesFromSavePoint

readCourseTemplatesFromSavePointRequest

readCourseTemplatesFromSavePointResponse

The 'readCourseTemplatesFromSavePoint' operation requests the service provider to return all of the data stored for the identified set of CourseTemplate objects from the defined reference 'savePoint'.

readCourseOfferingIdsForCourseTemplate

readCourseOfferingIdsForCourseTemplateRequest

readCourseOfferingIdsForCourseTemplateResponse

The 'readCourseOfferingIdsForCourseTemplate' operation requests the service provider to return the SourcedIds for all of the CourseOffering objects for the identified CourseTemplate.

updateCourseTemplate

updateCourseTemplateRequest

updateCourseTemplateResponse

The 'updateCourseTemplate' operation is responsible for changing the CourseTemplate object on the service provider by making an additive write to the previously stored data.

replaceCourseTemplate

replaceCourseTemplateRequest

replaceCourseTemplateResponse

The 'replaceCourseTemplate' operation is responsible for changing the CourseTemplate object on the service provider by making a destructive replacement of all the previously stored data. If the original object cannot be found, this operation acts as if it was a 'createCourseTemplate' operation call.

discoverCourseTemplateIds

discoverCourseTemplateIdsRequest

discoverCourseTemplateIdsResponse

The 'discoverCourseTemplateIds' operation requests the service provider to return the SourcedIds of all of the CourseTemplate objects that sustain the query criteria. At present, there is no defined format for the query i.e. the query is passed as a string.

changeCourseTemplateIdentifier

changeCourseTemplateIdentifierRequest

changeCourseTemplateIdentifierResponse

The 'changeCourseTemplateIdentifier' operation enables the service consumer to change the 'SourcedId' assigned to a CourseTemplate object on a service provider.

 

Port Type : CourseOfferingManagerSyncPortType

Operation Name

Input message

Output message

Documentation

createCourseOffering

createCourseOfferingRequest

createCourseOfferingResponse

The 'createCourseOffering' operation is responsible for creating a new CourseOffering object on the service provider. The service consumer supplies the 'sourcedId' to be used to identify the new CourseOffering.

createByProxyCourseOffering

createByProxyCourseOfferingRequest

createByProxyCourseOfferingResponse

The 'createByProxyCourseOffering' operation is responsible for creating a new CourseOffering object on the service provider. The service provider supplies the 'sourcedId' to be used to identify the new CourseOffering.

createCourseOfferingFromCourseOffering

createCourseOfferingFromCourseOfferingRequest

createCourseOfferingFromCourseOfferingResponse

The 'createCourseOfferingFromCourseOffering' operation is responsible for creating a new CourseOffering object by using an existing CourseOffering as the base. The service consumer supplies the 'sourcedId' to be used to identify the new CourseOffering.

deleteCourseOffering

deleteCourseOfferingRequest

deleteCourseOfferingResponse

The 'deleteCourseOffering' operation deletes the identified CourseOffering object. This means the 'sourcedId' can then be reused for another object.

readCourseOffering

readCourseOfferingRequest

readCourseOfferingResponse

The 'readCourseOffering' operation requests the service provider to return all of the data stored for the identified CourseOffering object.

readAllCourseOfferingIds

readAllCourseOfferingIdsRequest

readAllCourseOfferingIdsResponse

The 'readAllCourseOfferingIds' operation requests the service provider to return the SourcedIds for all of the CourseOffering objects.

readCourseOfferingIdsFromSavePoint

readCourseOfferingIdsFromSavePointRequest

readCourseOfferingIdsFromSavePointResponse

The 'readCourseOfferingIdsFromSavePoint' operation requests the service provider to return the SourcedIds for all of the CourseOffering objects from the defined reference 'savePoint'.

readAllActiveCourseOfferingIdsForAcademicSession

readAllActiveCourseOfferingIdsForAcademicSessionRequest

readAllActiveCourseOfferingIdsForAcademicSessionResponse

The 'readAllActiveCourseOfferingIdsForAcademicSession' operation requests the service provider to return the SourcedIds for all of the CourseOffering objects which are 'active' and which are for the identified 'academic session'.

readCourseSectionIdsForCourseOffering

readCourseSectionIdsForCourseOfferingRequest

readCourseSectionIdsForCourseOfferingResponse

The 'readCourseSectionIdsForCourseOffering' operation requests the service provider to return the SourcedIds for all of the CourseSection objects from the identified CourseOffering.

readCourseOfferings

readCourseOfferingsRequest

readCourseOfferingsResponse

The 'readCourseOffering' operation requests the service provider to return all of the data stored for the identified set of CourseOffering objects.

readCourseOfferingsFromSavePoint

readCourseOfferingsFromSavePointRequest

readCourseOfferingsFromSavePointResponse

The 'readCourseOfferingsFromSavePoint' operation requests the service provider to return all of the data stored for the identified set of CourseOffering objects from the defined reference 'savePoint'.

updateCourseOffering

updateCourseOfferingRequest

updateCourseOfferingResponse

The 'updateCourseOffering' operation is responsible for changing the CourseOffering object on the service provider by making an additive write to the previously stored data.

updateCourseOfferingStatus

updateCourseOfferingStatusRequest

updateCourseOfferingStatusResponse

The 'updateCourseOfferingStatus' operation is responsible for changing the CourseOffering status to the new supplied value.

replaceCourseOffering

replaceCourseOfferingRequest

replaceCourseOfferingResponse

The 'replaceCourseOffering' operation is responsible for changing the CourseOffering object on the service provider by making a destructive replacement of all the previously stored data. If the original object cannot be found, this operation acts as if it was a 'createCourseOffering' operation call.

discoverCourseOfferingIds

discoverCourseOfferingIdsRequest

discoverCourseOfferingIdsResponse

The 'discoverCourseOfferingIds' operation requests the service provider to return the SourcedIds of all of the CourseOffering objects that sustain the query criteria. At present, there is no defined format for the query i.e. the query is passed as a string.

changeCourseOfferingIdentifier

changeCourseOfferingIdentifierRequest

changeCourseOfferingIdentifierResponse

The 'changeCourseOfferingIdentifier' operation enables the service consumer to change the 'SourcedId' assigned to a CourseOffering object on a service provider.

 

Port Type : CourseSectionManagerSyncPortType

Operation Name

Input message

Output message

Documentation

createCourseSection

createCourseSectionRequest

createCourseSectionResponse

The 'createCourseSection' operation is responsible for creating a new CourseSection object on the service provider. The service consumer supplies the 'sourcedId' to be used to identify the new CourseSection.

createByProxyCourseSection

createByProxyCourseSectionRequest

createByProxyCourseSectionResponse

The 'createByProxyCourseSection' operation is responsible for creating a new CourseSection object on the service provider. The service provider supplies the 'sourcedId' to be used to identify the new CourseSection.

createCourseSectionFromCourseSection

createCourseSectionFromCourseSectionRequest

createCourseSectionFromCourseSectionResponse

The 'createCourseSectionFromCourseSection' operation is responsible for creating a new CourseSection object by using an existing CourseSection as the base. The service consumer supplies the 'sourcedId' to be used to identify the new CourseSection.

deleteCourseSection

deleteCourseSectionRequest

deleteCourseSectionResponse

The 'deleteCourseSection' operation deletes the identified CourseSection object. This means the 'sourcedId' can then be reused for another object.

readCourseSection

readCourseSectionRequest

readCourseSectionResponse

The 'readCourseSection' operation requests the service provider to return all of the data stored for the identified CourseSection object.

readAllCourseSectionIds

readAllCourseSectionIdsRequest

readAllCourseSectionIdsResponse

The 'readAllCourseSectionIds' operation requests the service provider to return the SourcedIds for all of the CourseSection objects.

readCourseSectionIdsFromSavePoint

readCourseSectionIdsFromSavePointRequest

readCourseSectionIdsFromSavePointResponse

The 'readCourseSectionIdsFromSavePoint' operation requests the service provider to return the SourcedIds for all of the CourseSection objects from the defined reference 'savePoint'.

readCourseSections

readCourseSectionsRequest

readCourseSectionsResponse

The 'readCourseSection' operation requests the service provider to return all of the data stored for the identified set of CourseSection objects.

readCourseSectionsFromSavePoint

readCourseSectionsFromSavePointRequest

readCourseSectionsFromSavePointResponse

The 'readCourseSectionsFromSavePoint' operation requests the service provider to return all of the data stored for the identified set of CourseSection objects from the defined reference 'savePoint'.

updateCourseSection

updateCourseSectionRequest

updateCourseSectionResponse

The 'updateCourseSection' operation is responsible for changing the CourseSection object on the service provider by making an additive write to the previously stored data.

updateCourseSectionStatus

updateCourseSectionStatusRequest

updateCourseSectionStatusResponse

The 'updateCourseSectionStatus' operation is responsible for changing the CourseSection status to the new supplied value.

replaceCourseSection

replaceCourseSectionRequest

replaceCourseSectionResponse

The 'replaceCourseSection' operation is responsible for changing the CourseSection object on the service provider by making a destructive replacement of all the previously stored data. If the original object cannot be found, this operation acts as if it was a 'createCourseSection' operation call.

discoverCourseSectionIds

discoverCourseSectionIdsRequest

discoverCourseSectionIdsResponse

The 'discoverCourseSectionIds' operation requests the service provider to return the SourcedIds of all of the CourseTemplate objects that sustain the query criteria. At present, there is no defined format for the query i.e. the query is passed as a string.

changeCourseSectionIdentifier

changeCourseSectionIdentifierRequest

changeCourseSectionIdentifierResponse

The 'changeCourseSectionIdentifier' operation enables the service consumer to change the 'SourcedId' assigned to a CourseSection object on a service provider.

 

Port Type : SectionAssociationManagerSyncPortType

Operation Name

Input message

Output message

Documentation

createSectionAssociation

createSectionAssociationRequest

createSectionAssociationResponse

The 'createSectionAssociation' operation is responsible for creating a new SectionAssociation object on the service provider. The service consumer supplies the 'sourcedId' to be used to identify the new SectionAssociation.

createByProxySectionAssociation

createByProxySectionAssociationRequest

createByProxySectionAssociationResponse

The 'createByProxySectionAssociation' operation is responsible for creating a new CourseTemplate object on the service provider. The service provider supplies the 'sourcedId' to be used to identify the new SectionAssociation.

deleteSectionAssociation

deleteSectionAssociationRequest

deleteSectionAssociationResponse

The 'deleteSectionAssociation' operation deletes the identified SectionAssociation object. This means the 'sourcedId' can then be reused for another object.

readSectionAssociation

readSectionAssociationRequest

readSectionAssociationResponse

The 'readSectionAssociation' operation requests the service provider to return all of the data stored for the identified SectionAssociation object.

readAllSectionAssociationIds

readAllSectionAssociationIdsRequest

readAllSectionAssociationIdsResponse

The 'readAllSectionAssociationIds' operation requests the service provider to return the SourcedIds for all of the SectionAssociation objects.

readSectionAssociationIdsFromSavePoint

readSectionAssociationIdsFromSavePointRequest

readSectionAssociationIdsFromSavePointResponse

The 'readSectionAssociationIdsFromSavePoint' operation requests the service provider to return all of the identifiers for the set of SectionAssociation objects from the defined reference 'savePoint'.

readSectionAssociations

readSectionAssociationsRequest

readSectionAssociationsResponse

The 'readSectionAssociations' operation requests the service provider to return all of the data stored for the identified set of SectionAssociation objects.

readSectionAssociationsFromSavePoint

readSectionAssociationsFromSavePointRequest

readSectionAssociationsFromSavePointResponse

The 'readSectionAssociationsFromSavePoint' operation requests the service provider to return all of the data stored for the identified set of SectionAssociation objects from the defined reference 'savePoint'.

addCourseSectionId

addCourseSectionIdRequest

addCourseSectionIdResponse

The 'addCourseSectionId' operation requests the service provider to add a new CourseSection to the identified SectionAssociation.

removeCourseSectionId

removeCourseSectionIdRequest

removeCourseSectionIdResponse

The 'removeCourseSectionId' operation requests the service provider to remove a CourseSection from the identified SectionAssociation.

updateSectionAssociation

updateSectionAssociationRequest

updateSectionAssociationResponse

The 'updateSectionAssociation' operation is responsible for changing the SectionAssociation object on the service provider by making an additive write to the previously stored data.

replaceSectionAssociation

replaceSectionAssociationRequest

replaceSectionAssociationResponse

The 'replaceSectionAssociation' operation is responsible for changing the SectionAssociation object on the service provider by making a destructive replacement of all the previously stored data. If the original object cannot be found, this operation acts as if it was a 'createSectionAssociation' operation call.

discoverSectionAssociationIds

discoverSectionAssociationIdsRequest

discoverSectionAssociationIdsResponse

The 'discoverSectionAssociationIds' operation requests the service provider to return the SourcedIds of all of the SectionAssociation objects that sustain the query criteria. At present, there is no defined format for the query i.e. the query is passed as a string.

changeSectionAssociationIdentifier

changeSectionAssociationIdentifierRequest

changeSectionAssociationIdentifierResponse

The 'changeSectionAssociationIdentifier' operation enables the service consumer to change the 'SourcedId' assigned to a SectionAssociation object on a service provider.

 

4.2 Messages

createCourseTemplateRequest

Part Name

Element

Type

Documentation

Parameters

tns:createCourseTemplateRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

createCourseTemplateResponse

Part Name

Element

Type

Documentation

Response

tns:createCourseTemplateResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

createByProxyCourseTemplateRequest

Part Name

Element

Type

Documentation

Parameters

tns:createByProxyCourseTemplateRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

createByProxyCourseTemplateResponse

Part Name

Element

Type

Documentation

Response

tns:createByProxyCourseTemplateResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

deleteCourseTemplateRequest

Part Name

Element

Type

Documentation

Parameters

tns:deleteCourseTemplateRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

deleteCourseTemplateResponse

Part Name

Element

Type

Documentation

Response

tns:deleteCourseTemplateResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseTemplateRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseTemplateRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseTemplateResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseTemplateResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readAllCourseTemplateIdsRequest

Part Name

Element

Type

Documentation

Parameters

tns:readAllCourseTemplateIdsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readAllCourseTemplateIdsResponse

Part Name

Element

Type

Documentation

Response

tns:readAllCourseTemplateIdsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseTemplateIdsFromSavePointRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseTemplateIdsFromSavePointRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseTemplateIdsFromSavePointResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseTemplateIdsFromSavePointResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseTemplatesRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseTemplatesRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseTemplatesResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseTemplatesResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseTemplatesFromSavePointRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseTemplatesFromSavePointRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseTemplatesFromSavePointResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseTemplatesFromSavePointResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseOfferingIdsForCourseTemplateRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseOfferingIdsForCourseTemplateRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseOfferingIdsForCourseTemplateResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseOfferingIdsForCourseTemplateResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

updateCourseTemplateRequest

Part Name

Element

Type

Documentation

Parameters

tns:updateCourseTemplateRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

updateCourseTemplateResponse

Part Name

Element

Type

Documentation

Response

tns:updateCourseTemplateResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

replaceCourseTemplateRequest

Part Name

Element

Type

Documentation

Parameters

tns:replaceCourseTemplateRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

replaceCourseTemplateResponse

Part Name

Element

Type

Documentation

Response

tns:replaceCourseTemplateResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

discoverCourseTemplateIdsRequest

Part Name

Element

Type

Documentation

Parameters

tns:discoverCourseTemplateIdsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

discoverCourseTemplateIdsResponse

Part Name

Element

Type

Documentation

Response

tns:discoverCourseTemplateIdsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

changeCourseTemplateIdentifierRequest

Part Name

Element

Type

Documentation

Parameters

tns:changeCourseTemplateIdentifierRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

changeCourseTemplateIdentifierResponse

Part Name

Element

Type

Documentation

Response

tns:changeCourseTemplateIdentifierResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

createCourseOfferingRequest

Part Name

Element

Type

Documentation

Parameters

tns:createCourseOfferingRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

createCourseOfferingResponse

Part Name

Element

Type

Documentation

Response

tns:createCourseOfferingResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

createByProxyCourseOfferingRequest

Part Name

Element

Type

Documentation

Parameters

tns:createByProxyCourseOfferingRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

createByProxyCourseOfferingResponse

Part Name

Element

Type

Documentation

Response

tns:createByProxyCourseOfferingResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

createCourseOfferingFromCourseOfferingRequest

Part Name

Element

Type

Documentation

Parameters

tns:createCourseOfferingFromCourseOfferingRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

createCourseOfferingFromCourseOfferingResponse

Part Name

Element

Type

Documentation

Response

tns:createCourseOfferingFromCourseOfferingResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

deleteCourseOfferingRequest

Part Name

Element

Type

Documentation

Parameters

tns:deleteCourseOfferingRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

deleteCourseOfferingResponse

Part Name

Element

Type

Documentation

Response

tns:deleteCourseOfferingResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseOfferingRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseOfferingRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseOfferingResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseOfferingResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readAllCourseOfferingIdsRequest

Part Name

Element

Type

Documentation

Parameters

tns:readAllCourseOfferingIdsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readAllCourseOfferingIdsResponse

Part Name

Element

Type

Documentation

Response

tns:readAllCourseOfferingIdsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseOfferingIdsFromSavePointRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseOfferingIdsFromSavePointRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseOfferingIdsFromSavePointResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseOfferingIdsFromSavePointResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readAllActiveCourseOfferingIdsForAcademicSessionRequest

Part Name

Element

Type

Documentation

Parameters

tns:readAllActiveCourseOfferingIdsForAcademicSessionRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readAllActiveCourseOfferingIdsForAcademicSessionResponse

Part Name

Element

Type

Documentation

Response

tns:readAllActiveCourseOfferingIdsForAcademicSessionResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseSectionIdsForCourseOfferingRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseSectionIdsForCourseOfferingRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseSectionIdsForCourseOfferingResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseSectionIdsForCourseOfferingResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseOfferingsRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseOfferingsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseOfferingsResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseOfferingsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseOfferingsFromSavePointRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseOfferingsFromSavePointRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseOfferingsFromSavePointResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseOfferingsFromSavePointResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

updateCourseOfferingRequest

Part Name

Element

Type

Documentation

Parameters

tns:updateCourseOfferingRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

updateCourseOfferingResponse

Part Name

Element

Type

Documentation

Response

tns:updateCourseOfferingResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

updateCourseOfferingStatusRequest

Part Name

Element

Type

Documentation

Parameters

tns:updateCourseOfferingStatusRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

updateCourseOfferingStatusResponse

Part Name

Element

Type

Documentation

Response

tns:updateCourseOfferingStatusResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

replaceCourseOfferingRequest

Part Name

Element

Type

Documentation

Parameters

tns:replaceCourseOfferingRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

replaceCourseOfferingResponse

Part Name

Element

Type

Documentation

Response

tns:replaceCourseOfferingResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

discoverCourseOfferingIdsRequest

Part Name

Element

Type

Documentation

Parameters

tns:discoverCourseOfferingIdsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

discoverCourseOfferingIdsResponse

Part Name

Element

Type

Documentation

Response

tns:discoverCourseOfferingIdsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

changeCourseOfferingIdentifierRequest

Part Name

Element

Type

Documentation

Parameters

tns:changeCourseOfferingIdentifierRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

changeCourseOfferingIdentifierResponse

Part Name

Element

Type

Documentation

Response

tns:changeCourseOfferingIdentifierResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

createCourseSectionRequest

Part Name

Element

Type

Documentation

Parameters

tns:createCourseSectionRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

createCourseSectionResponse

Part Name

Element

Type

Documentation

Response

tns:createCourseSectionResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

createByProxyCourseSectionRequest

Part Name

Element

Type

Documentation

Parameters

tns:createByProxyCourseSectionRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

createByProxyCourseSectionResponse

Part Name

Element

Type

Documentation

Response

tns:createByProxyCourseSectionResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

createCourseSectionFromCourseSectionRequest

Part Name

Element

Type

Documentation

Parameters

tns:createCourseSectionFromCourseSectionRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

createCourseSectionFromCourseSectionResponse

Part Name

Element

Type

Documentation

Response

tns:createCourseSectionFromCourseSectionResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

deleteCourseSectionRequest

Part Name

Element

Type

Documentation

Parameters

tns:deleteCourseSectionRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

deleteCourseSectionResponse

Part Name

Element

Type

Documentation

Response

tns:deleteCourseSectionResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseSectionRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseSectionRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseSectionResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseSectionResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readAllCourseSectionIdsRequest

Part Name

Element

Type

Documentation

Parameters

tns:readAllCourseSectionIdsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readAllCourseSectionIdsResponse

Part Name

Element

Type

Documentation

Response

tns:readAllCourseSectionIdsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseSectionIdsFromSavePointRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseSectionIdsFromSavePointRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseSectionIdsFromSavePointResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseSectionIdsFromSavePointResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseSectionsRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseSectionsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseSectionsResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseSectionsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readCourseSectionsFromSavePointRequest

Part Name

Element

Type

Documentation

Parameters

tns:readCourseSectionsFromSavePointRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readCourseSectionsFromSavePointResponse

Part Name

Element

Type

Documentation

Response

tns:readCourseSectionsFromSavePointResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

updateCourseSectionRequest

Part Name

Element

Type

Documentation

Parameters

tns:updateCourseSectionRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

updateCourseSectionResponse

Part Name

Element

Type

Documentation

Response

tns:updateCourseSectionResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

updateCourseSectionStatusRequest

Part Name

Element

Type

Documentation

Parameters

tns:updateCourseSectionStatusRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

updateCourseSectionStatusResponse

Part Name

Element

Type

Documentation

Response

tns:updateCourseSectionStatusResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

replaceCourseSectionRequest

Part Name

Element

Type

Documentation

Parameters

tns:replaceCourseSectionRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

replaceCourseSectionResponse

Part Name

Element

Type

Documentation

Response

tns:replaceCourseSectionResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

discoverCourseSectionIdsRequest

Part Name

Element

Type

Documentation

Parameters

tns:discoverCourseSectionIdsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

discoverCourseSectionIdsResponse

Part Name

Element

Type

Documentation

Response

tns:discoverCourseSectionIdsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

changeCourseSectionIdentifierRequest

Part Name

Element

Type

Documentation

Parameters

tns:changeCourseSectionIdentifierRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

changeCourseSectionIdentifierResponse

Part Name

Element

Type

Documentation

Response

tns:changeCourseSectionIdentifierResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

createSectionAssociationRequest

Part Name

Element

Type

Documentation

Parameters

tns:createSectionAssociationRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

createSectionAssociationResponse

Part Name

Element

Type

Documentation

Response

tns:createSectionAssociationResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

createByProxySectionAssociationRequest

Part Name

Element

Type

Documentation

Parameters

tns:createByProxySectionAssociationRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

createByProxySectionAssociationResponse

Part Name

Element

Type

Documentation

Response

tns:createByProxySectionAssociationResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

deleteSectionAssociationRequest

Part Name

Element

Type

Documentation

Parameters

tns:deleteSectionAssociationRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

deleteSectionAssociationResponse

Part Name

Element

Type

Documentation

Response

tns:deleteSectionAssociationResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readSectionAssociationRequest

Part Name

Element

Type

Documentation

Parameters

tns:readSectionAssociationRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readSectionAssociationResponse

Part Name

Element

Type

Documentation

Response

tns:readSectionAssociationResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readAllSectionAssociationIdsRequest

Part Name

Element

Type

Documentation

Parameters

tns:readAllSectionAssociationIdsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readAllSectionAssociationIdsResponse

Part Name

Element

Type

Documentation

Response

tns:readAllSectionAssociationIdsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readSectionAssociationIdsFromSavePointRequest

Part Name

Element

Type

Documentation

Parameters

tns:readSectionAssociationIdsFromSavePointRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readSectionAssociationIdsFromSavePointResponse

Part Name

Element

Type

Documentation

Response

tns:readSectionAssociationIdsFromSavePointResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readSectionAssociationsRequest

Part Name

Element

Type

Documentation

Parameters

tns:readSectionAssociationsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readSectionAssociationsResponse

Part Name

Element

Type

Documentation

Response

tns:readSectionAssociationsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

readSectionAssociationsFromSavePointRequest

Part Name

Element

Type

Documentation

Parameters

tns:readSectionAssociationsFromSavePointRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

readSectionAssociationsFromSavePointResponse

Part Name

Element

Type

Documentation

Response

tns:readSectionAssociationsFromSavePointResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

addCourseSectionIdRequest

Part Name

Element

Type

Documentation

Parameters

tns:addCourseSectionIdRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

addCourseSectionIdResponse

Part Name

Element

Type

Documentation

Response

tns:addCourseSectionIdResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

removeCourseSectionIdRequest

Part Name

Element

Type

Documentation

Parameters

tns:removeCourseSectionIdRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

removeCourseSectionIdResponse

Part Name

Element

Type

Documentation

Response

tns:removeCourseSectionIdResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

updateSectionAssociationRequest

Part Name

Element

Type

Documentation

Parameters

tns:updateSectionAssociationRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

updateSectionAssociationResponse

Part Name

Element

Type

Documentation

Response

tns:updateSectionAssociationResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

replaceSectionAssociationRequest

Part Name

Element

Type

Documentation

Parameters

tns:replaceSectionAssociationRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

replaceSectionAssociationResponse

Part Name

Element

Type

Documentation

Response

tns:replaceSectionAssociationResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

discoverSectionAssociationIdsRequest

Part Name

Element

Type

Documentation

Parameters

tns:discoverSectionAssociationIdsRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

discoverSectionAssociationIdsResponse

Part Name

Element

Type

Documentation

Response

tns:discoverSectionAssociationIdsResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

 

changeSectionAssociationIdentifierRequest

Part Name

Element

Type

Documentation

Parameters

tns:changeSectionAssociationIdentifierRequest

N/A

N/A

HeaderInfoParameters

tns:imsx_syncRequestHeaderInfo

N/A

N/A

 

changeSectionAssociationIdentifierResponse

Part Name

Element

Type

Documentation

Response

tns:changeSectionAssociationIdentifierResponse

N/A

N/A

HeaderInfoResponse

tns:imsx_syncResponseHeaderInfo

N/A

N/A

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 the exchange of Group objects in an external file.

top | toc


6. Binding of the Vocabularies

The vocabularies in the CMS are:

  • Status values vocabulary – the set of data-types that are permitted for the status field. The PSM for the status vocabulary is shown in Figure 6.1;
  • Extension data-type vocabulary – the set of data-types that are permitted for extensions in the Course data model. The PSM for the extension data-type vocabulary is shown in Figure 6.2.

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 Global.  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 status vocabulary for the CMS.

Figure 6.2 The PSM representation of the extension data-type vocabulary for the CMS.

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) – CourseManagementServicev1p0_SyncSinglev1p0.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:

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

top | toc


Appendix D - Example SOAP Messages

The set of examples for the SOAP messages are listed in Tables D.1 (CourseTemplate), D.2 (Course Offering), D.3 (Course Section) and D.4 (Section Association).

Table D.1 The set of SOAP message examples for each operation for the CourseTemplate port.

Operation Name

Input (Request) SOAP Message

Output (Response) SOAP Message

createCourseTemplate

createCourseTemplateRequest

createCourseTemplateResponse

createByProxyCourseTemplate

createByProxyCourseTemplateRequest

createByProxyCourseTemplateResponse

deleteCourseTemplate

deleteCourseTemplateRequest

deleteCourseTemplateResponse

readCourseTemplate

readCourseTemplateRequest

readCourseTemplateResponse

readAllCourseTemplateIds

readAllCourseTemplateIdsRequest

readAllCourseTemplateIdsResponse

readCourseTemplateIdsFromSavePoint

readCourseTemplateIdsFromSavePointRequest

readCourseTemplateIdsFromSavePointResponse

readCourseTemplates

readCourseTemplatesRequest

readCourseTemplatesResponse

readCourseTemplatesFromSavePoint

readCourseTemplatesFromSavePointRequest

readCourseTemplatesFromSavePointResponse

readCourseOfferingIdsForCourseTemplate

readCourseOfferingIdsForCourseTemplateRequest

readCourseOfferingIdsForCourseTemplateResponse

updateCourseTemplate

updateCourseTemplateRequest

updateCourseTemplateResponse

replaceCourseTemplate

replaceCourseTemplateRequest

replaceCourseTemplateResponse

discoverCourseTemplateIds

discoverCourseTemplateIdsRequest

discoverCourseTemplateIdsResponse

changeCourseTemplateIdentifier

changeCourseTemplateIdentifierRequest

changeCourseTemplateIdentifierResponse

Table D.2 The set of SOAP message examples for each operation for the CourseOffering port.

Operation Name

Input (Request) SOAP Message

Output (Response) SOAP Message

createCourseOffering

createCourseOfferingRequest

createCourseOfferingResponse

createCourseOfferingFromCourseOffering

createCourseOfferingFromCourseOfferingRequest

createCourseOfferingFromCourseOfferingResponse

createByProxyCourseOffering

createByProxyCourseOfferingRequest

createByProxyCourseOfferingResponse

deleteCourseOffering

deleteCourseOfferingRequest

deleteCourseOfferingResponse

readCourseOffering

readCourseOfferingRequest

readCourseOfferingResponse

readAllCourseOfferingIds

readAllCourseOfferingIdsRequest

readAllCourseOfferingIdsResponse

readCourseOfferingIdsFromSavePoint

readCourseOfferingIdsFromSavePointRequest

readCourseOfferingIdsFromSavePointResponse

readAllActiveCourseOfferingIdsForAcademicSession

readAllActiveCourseOfferingIdsForAcademicSessionRequest

readAllActiveCourseOfferingIdsForAcademicSessionResponse

readCourseSectionIdsForCourseOffering

readCourseSectionIdsForCourseOfferingRequest

readCourseSectionIdsForCourseOfferingResponse

readCourseOfferings

readCourseOfferingsRequest

readCourseOfferingsResponse

readCourseOfferingsFromSavePoint

readCourseOfferingsFromSavePointRequest

readCourseOfferingsFromSavePointResponse

updateCourseOffering

updateCourseOfferingRequest

updateCourseOfferingResponse

updateCourseOfferingStatus

updateCourseOfferingStatusRequest

updateCourseOfferingStatusResponse