WSDLv1.1 File Information ------------------------- Services: OutcomesManagementService (Synchronous Communications) Author: Colin Smythe Date: 16th April 2012 Version: 2.0 Status: Public Draft Description: The Outcomes Management Service. This is a part of the IMS Learning Information Services v2.0 specification. History: Version 1.0: This is the first formal release of this service. This service was not defined in 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 Outcomes Management Service (OMS) 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 Context complexType is the container for all of the information that establishes the context for a lineItem. The ExtensionField complexType is the container for each of the extension entries. This is a name/type/value triple. The GUIDSet complexType is the container for a set of SourcedIds. 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/POX 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/POX 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 LineItem complexType is the container for the LineItem data model. A LineItem consists of a column of results that are assigned to a Course component e.g. CourseTemplate, etc. Note that the 'lineItemSettings' attribute was added to support IMS LTI specification-specific operational needs. The LineItemRecord complexType defines the association between the globally unique identifier of a LineItem object and the LineItem object iself. The LineItemRecordSet complexType is the container for the collection of LineItemRecords. The LineItemType complexType is the container for the definition of the type of lineItem. The value-space for the 'lineItemTypeValue' attribute is defined in the associated VDEX vocabulary. The Metadata complexType is the container for meta-data that is used to describe an object. At the curremt time this is just a set of name/type/value triples. The OrderedValue complexType is the container for each of the values in the set of permitted values. To be defined with respect to the LTI Specification. In general, this class is removed for non-LTI releated specification profiles. The ReplaceStatusCode complexType is the container for the status code for the attempted replace operation on the result object identified by the enclosed sourcedId. The ReplaceStatusCodes complexType is the container for the set of status codes that are returned for the set attempted replace result operations. The Result complexType is the container for a Result. Each Result identifies the Person to whom the result is assigned and the set of attributes for the result value. The ResultRecord complexType is the container for the association of a Result object with its globally unique identifier i.e. its sourcedId The ResultRecordSet complexType is the container for the collection of ResultRecords. The ResultStatus complexType is the container for the information about the status of the result. The value-space for the 'resultStatusValue' attribute is defined in the associated default VDEX vocabulary. The ResultValueComplexType is the container for the information about the set of values that are permitted for a Result. This is either a set of values or a numeric range. The ResultValueRecord complexType is the container for the association of a ResultValue object with its globally unique identifier i.e. its sourcedId. The ResultValueRecordSet complexType is the container for the collection of ResultValueRecords. The SourcedGUID complexType is the container for the extended sourcedId. The refAgentInstamceID permits multiple endpoint differentiation. The text complexType is the container for a language specific string. The language is denoted using the ISO 639 code set. See the corresponding VDEX file that contains the permitted value-space enumeration. The ValueList complexType is the container for the set of values that can be allocated to a Result. The ValueRange complexType is the container for the minimum and maximum numeric value that a Result can have. PortType Description -------------------- This is the LineItemManager interface. The operations are: 1) CreateLineItem 2) CreateByProxyLineItem 3) DeleteLineItem 4) ReadLineItem 5) ReadAllLineItemIds 6) ReadLineItemIdsForPerson 7) ReadLineItemIdsForCourseOffering 8) ReadLineItemIdsForCourseSection 9) ReadLineItemIdsForCourseSectionWithLineItemType 10) ReadLineItemIdsWithLineItemType 11) ReadLineItemIdsFromSavePoint 12) ReadLineItems 13) ReadLineItemsFromSavePoint 14) UpdateLineItem 15) ReplaceLineItem 16) DiscoverLineItemIds 17) ChangeLineItemIdentifier Operation Description ---------------------

The 'createLineItem' operation requests the service provider to create a new LineItem object with the supplied sourcedId value.

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

The 'createByProxyLineItem' operation requests the service provider to create a new LineItem object with a sourcedId allocated by the service provider itself.

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

The 'deleteLineItem' operation requests the service provider to delete the identified LineItem object.

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

The 'readLineItem' operation requests the service provider to supply the stored data for the identified LineItem object.

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

The 'readAllLineItemIds' operation requests the service provider to supply all of the SourcedIds that have been assigned to LineItem objects.

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

The 'readLineItemIdsForPerson' operation requests the service provider to supply the SourcedIds of the LineItem objects that contain results for the identified Person.

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

The 'readLineItemIdsForCourseOffering' operation requests the service provider to supply the SourcedIds of the LineItem objects that contain results associated with the identified CourseOffering.

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

The 'readLineItemIdsForCourseSection' operation requests the service provider to supply the SourcedIds of the LineItem objects that contain results associated with the identified CourseSection.

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

The 'readLineItemIdsForCourseSectionWithLineItemType' operation requests the service provider to supply the SourcedIds of the LineItem objects for the identified CourseSection with the identified LineItemType.

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

The 'readLineItemIdsWithLineItemTypen' operation requests the service provider to supply the SourcedIds of the LineItem objects with the identified LineItemType.

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

The 'readLineItemIdsFromSavePoint' operation requests the service provider to supply the SourcedIds of the LineItem objects that have been altered after the defined reference point (SavePoint).

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

The 'readLineItems' operation requests the service provider to supply the LineItem objects that have been identified by the service consumer.

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

The 'readLineItemsFromSavePoint' operation requests the service provider to supply the LineItem objects that have been altered after the defined reference point (SavePoint).

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

The 'updateLineItem' operation requests the service provider to write the new data into identified LineItem object (this is an additive write).

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

The 'replaceLineItem' operation requests the service provider to write the new data into identified LineItem object (this is an destructive overwrite of all the previously stored data). If the identified object does not exist, this becomes a 'createLineItem' operation.

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

The 'discoverLineItem' operation requests the service provider to supply the SourcedIds for all of the LineItem objects that comply to the supplied search criteria.

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

The 'changeLineItemIdentifier' operation requests the service provider to change the SourcedId for the identified LineItem object.

 Service Information ------------------- Author: Colin Smythe Date: 16th April, 2012 Version: 2.0 Status: Public Draft Description: The Outcomes Management Service is composed of three interfaces each of which has several operations. The interaces are for each of the LinetemRecord, ResultRecord and ResultValueRecord object management. 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.