Integrations Documentation

The Course Template Management Service (CTMS)

This service is used to interact with Brightspace course templates.

Implemented operations

deleteCourseTemplate
replaceCourseTemplate
readCourseTemplate

About the deleteCourseTemplate operation

deleteCourseTemplate is the operation used to delete Brightspace Org Units associated with LIS Course Templates.

Process flow: deleteCourseTemplate

When an LIS deleteCourseTemplate request is received, the adapter obtains the unique id for the template from the the sourcedId field of the request directly, without the use of a pluggable translator.
The IPSIS Platform handlers configured for IDeleteCourseTemplateHandler process the request.
The LIS response is generated from the handler response.

Sample deleteCourseTemplate request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

   xmlns:ims="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0">

   <soapenv:Header>

      <ims:imsx_syncRequestHeaderInfo>

         <ims:imsx_version>V1.0</ims:imsx_version>

         <ims:imsx_messageIdentifier>1234</ims:imsx_messageIdentifier>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:deleteCourseTemplateRequest>

         <ims:sourcedId>Demo_Course_Template</ims:sourcedId>

      </ims:deleteCourseTemplateRequest>

   </soapenv:Body>

</soapenv:Envelope>

deleteCourseTemplate request header and body fields

Request header fields

For more information, refer to the topic Using LIS v2.0 Services > Request and response headers.

Request body fields

The adapter accepts the following fields in the request:

Property	LIS Request Mapping	Required
Code	deleteCourseTemplateRequest.sourcedId	Yes

Sample deleteCourseTemplate response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

   <s:Header>

      <h:imsx_syncResponseHeaderInfo

         xmlns:h="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0"

         xmlns="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0"

         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         xmlns:xsd="http://www.w3.org/2001/XMLSchema">

         <imsx_version>V1.0</imsx_version>

         <imsx_messageIdentifier>CTMS_deleteCourseTemplate_20120104T232203_8033886Z</imsx_messageIdentifier>

         <imsx_statusInfo>

            <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>status</imsx_severity>

            <imsx_messageRefIdentifier>1234</imsx_messageRefIdentifier>

            <imsx_codeMinor>

               <imsx_codeMinorField>

                  <imsx_codeMinorFieldName>TargetEndSystem</imsx_codeMinorFieldName>

                  <imsx_codeMinorFieldValue>fullsuccess</imsx_codeMinorFieldValue>

               </imsx_codeMinorField>

            </imsx_codeMinor>

         </imsx_statusInfo>

      </h:imsx_syncResponseHeaderInfo>

   </s:Header>

   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"/>

</s:Envelope>

deleteCourseTemplate response header and body fields

Response header fields

For more information, refer to the topic Using LIS v2.0 Services > Request and response headers.

Response body fields

No fields are returned in the response body.

Sample readCourseTemplate request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

   xmlns:ims="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0">

   <soapenv:Header>

      <ims:imsx_syncRequestHeaderInfo>

        <ims:imsx_version>V1.0</ims:imsx_version>

         <ims:imsx_messageIdentifier>MessageId_774290</ims:imsx_messageIdentifier>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:readCourseTemplateRequest>

        <ims:sourcedId>Demo_Template</ims:sourcedId>

      </ims:readCourseTemplateRequest>

   </soapenv:Body>

</soapenv:Envelope>

Sample readCourseTemplate response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

   <s:Header>

      <h:imsx_syncResponseHeaderInfo xmlns:h="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0" xmlns="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

         <imsx_version>V1.0</imsx_version>

         <imsx_messageIdentifier>CMS_readCourseOffering_20120803T145419_1122428Z</imsx_messageIdentifier>

         <imsx_statusInfo>            <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>warning</imsx_severity>

            <imsx_messageRefIdentifier>MessageId_774290</imsx_messageRefIdentifier>

            <imsx_description/>

            <imsx_codeMinor>

              <imsx_codeMinorField>                  <imsx_codeMinorFieldName>TargetEndSystem</imsx_codeMinorFieldName>

                 <imsx_codeMinorFieldValue>partialdatastorage</imsx_codeMinorFieldValue>

              </imsx_codeMinorField>

           </imsx_codeMinor>

        </imsx_statusInfo>

      </h:imsx_syncResponseHeaderInfo>

   </s:Header>

  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

     <readCourseTemplateResponse xmlns="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0">

         <courseTemplateRecord>

           <sourcedGUID>

              <sourcedId>Demo_Template</sourcedId>

            </sourcedGUID>

            <courseTemplate/>

         </courseTemplateRecord>

      </readCourseTemplateResponse>

   </s:Body>

</s:Envelope>