WSDLv1.1 File Information ------------------------- Services: CourseManagementService (Synchronous Communications) Author: Colin Smythe Date: 16th April, 2012 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 GLC General Web Services Base Profile v1.0 The IMS GLC GWS Basic Profile is derived from the WS-I Basic Profile v1.1. This profile uses: WSDL 1.1, SOAP 1.1, HTTP 1.1 and XML 1.0. Extension profiles to the IMS GLC GWS Base Profile are available but are not supported using this tool version. License: IPR, License and Distribution Notices This machine readable file is derived from IMS Global Learning Consortium (GLC) specification IMS Course Management Service (CMS) Version 1.0 found at http://www.imsglobal.org/lis and the original IMS GLC schema binding or code base http://www.imsglobal.org/lis. 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 (c) IMS Global Learning Consortium 1999-2012. 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 UML File Information --------------------------- The source file information must be supplied as an XMI file (without diagram layout information). The supported UML authoring tools are: (a) Poseidon - v6 (and later) Source XSLT File Information ---------------------------- XSL Generator: UMLtoWSDLv1.1Transformv1p0.xsl XSLT Processor: Xalan Release: 1.0 Date: 31st March, 2012 Autogen Engineer: Colin Smythe (IMS GLC, UK) Autogen Date: 2012-04-16 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-2012 (c) IMS Global Learning Consortium Inc. All Rights Reserved. The CourseOffering complexType is the container for the occurence of a course in a specific session e.g. term, semester, etc. A CourseTemplate can have several CourseOfferings and each CourseOffering can have several CourseSections. The CourseOfferingRecord complexType is the container for the relationship between the GUID of the CourseOffering object and the object itself. The CourseOfferingRecordSet is the complexType for the set of CourseOfferingRecords. The CourseSection complexType is a way to represent a group of people associated with a course or class. These groups may include everyone in the class or course, or may be subsets of that whole group. CourseSections may have sub-sections (these are created as separate Group objects linked using a relationship). The CourseSectionRecord is the complexType for the relationship between the GUID for the CourseSection Record object and the object itself. A CourseSectionRecordSet is the complexType for the collecyion of a set of CourseSectionREcords. The CourseTemplate complexType is the top-level container for the Course Template data model. A CourseTemplate is a general course that exists across terms, semesters, etc. It is an abstract course representation. The CourseTemplateRecord complexType is the container for the association between the GUID of the CourseTemplate and the object itself. The CourseTemplateRecordSet is the complexType for the set of CourseTemplateRecords. The Description complexType is the container for all of the material that is used to describe something. It has short (text), long (text) and full (multimedia) forms. The EnrollControl complexType is the container for the data that is used to control enrollment on the associated activity. The ExtensionField complexType is the container for each of the extension points. This is a name/type/value triple. The FullDescription complexType is the container for the multmedia-based description. The GUIDSet complexType is the container for the set of GUIDs. The IMSExtension complexType is the container for the set of extension information. The CodeMinor complexType is the container for the set of code minor status codes reported in the associated IMS SOAP message header. The CodeMinorField complexType is the container a single code minor status code. The RequestHeaderInfo complexType is the container for the information to be placed in the SOAP header for the request message transmitted for the associated operation call. The ResponseHeaderInfo complexType is the container for the information to be placed in the SOAP header for the response message transmitted for the associated operation call. The StatusInfo complexType is the container for the status code and associated information returned within the SOAP message as defined by the IMS GWSv1.0 specification. The ListofCourseSectionIds complexType is the container for the list of associated CourseSections. The ListofPrerequisities complexType is the container for the set of pre-reqisities fr the CourseTemplae. The ListofTopics complexType is the container for the list of topics that are covered in a Course derived from the CourseTemplate. The Metadata complexType is the container for meta-data that is used to describe an object. At the current time this is just a set of name/type/value triples. The Org complexType is the container for data about the organization that 'owns' the course structure. The SectionAssociation complexType is used to contain the identity of a set of associated CourseSections. This includes the label, title and status of the SectionAssociation. The SectionAssociationRecord is the container for the relationship between the GUID of the SectionAssociation object and the object itself. The SectionAssociationrecordSet complexType is the container for the collection of SectionAssociationRecords. The SourcedGUID complexType is the container for the extended sourcedId. The extension is the reference agent instance identifier. The Text complexType is the container for a language specific string. The language is denoted using an external vocabulary containing the permitted codes (based upon RFC4646). The TimeFrame complexType is the container for time information about the course component. PortType Description -------------------- This is the CourseTemplateManager interface. The operations are: 1) CreateCourseTemplate 2) CreateByProxyCourseTemplate 3) DeleteCourseTemplate 4) ReadCourseTemplate 5) ReadAllCourseTemplateIds 6) ReadCourseTemplateIdsFromSavePoint 7) ReadCourseTemplates 8) ReadCourseTemplatesFromSavePoint 9) ReadCourseOfferingIdsForCourseTemplate 10) UpdateCourseTemplate 11) ReplaceCourseTemplate 12) DiscoverCourseTemplateIds 13) ChangeCourseTemplateIdentifier Operation Description ---------------------

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.

 Operation Description ---------------------

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.

 Operation Description ---------------------

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

 Operation Description ---------------------

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

 Operation Description ---------------------

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

 Operation Description ---------------------

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

 Operation Description ---------------------

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

 Operation Description ---------------------

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

 Operation Description ---------------------

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

 Operation Description ---------------------

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

 Operation Description ---------------------

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.

 Operation Description ---------------------

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.

 Operation Description ---------------------

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

 Service Information ------------------- Author: Colin Smythe Date: 16th April, 2012 Version: Final 1.0 Status: Final Release Description: The Course Management Service is composed of four interfaces each of which has several operations. The interfaces are for the CourseTemplate, CourseOffering, CourseSection and SectionAssociation. 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.