Integrations Documentation

The Course Section Management Service (CSMS)

This service is used to affect Brightspace course sections (or groups).

Implemented Operations

deleteCourseSection
replaceCourseSection
readCourseSection

About the deleteCourseSection operation

deleteCourseSection is the operation used to delete Brightspace Org Units associated with LIS Course Sections.

Process flow: deleteCourseSection

When an LIS deleteCourseSection request is received, the adapter obtains the unique id for the course section from the sourcedId field of the request directly, without the user of a pluggable translator.
Once the Course Section Id is obtained, the IPSIS Platform handlers configured for IDeleteCourseSectionHandler are used to process the request.
The LIS response is generated from the handler response.

Sample deleteCourseSection 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>1234</ims:imsx_messageIdentifier>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:deleteCourseSectionRequest>

         <ims:sourcedId>LIS_Section_01</ims:sourcedId>

      </ims:deleteCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

deleteCourseSection 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

Property	LIS Request Mapping	Required
Code	deleteCourseSectionRequest.sourcedId	Yes

Sample deleteCourseSection 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>CSMS_deleteCourseSection_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>

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

About the replaceCourseSection operations

replaceCourseSection is the operation used to create or update Brightspace course sections or groups.

When using the default configurations, upon success you can validate that the group has been created or updated as appropriate through the Config Variable Browser in the Brightspace or through the Groups or Sections Tool in the course (depending on handler configuration).

Process flow: replaceCourseSection

When a LIS replaceCourseSection request is received, Brightspace translates the request using the LIS translators configured for ITranslateCourseSection to transform the request into a format the IPSIS Platform can understand.
The IPSIS Platform handlers configured for IReplaceCourseSectionHandler are used to process the request.
An LIS response is generated from the handler response.

Sample replaceCourseSection 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>1234</ims:imsx_messageIdentifier>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:replaceCourseSectionRequest>

         <!--Not Used by D2L-->

         <ims:sourcedId>Demo_Section_01</ims:sourcedId>

         <ims:courseSectionRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_Section_01</ims:sourcedId>

            </ims:sourcedGUID>

            <ims:courseSection>

               <ims:title>

                  <ims:language>en-US</ims:language>

                  <ims:textString>Demo Section 1</ims:textString>

               </ims:title>

               <ims:parentOfferingId>Demo_Offering</ims:parentOfferingId>

               <!--Optional:-->

               <ims:status>Active</ims:status>

               <!--Optional:-->

               <ims:academicSession>

                  <ims:language>en-US</ims:language>

                  <ims:textString>Demo_Semester</ims:textString>

               </ims:academicSession>

               <!--Optional:-->

               <ims:org>

                  <!--Optional:-->

                  <ims:orgName>

                     <ims:language>en-US</ims:language>

                     <ims:textString>Demo_Department</ims:textString>

                  </ims:orgName>

               &lt:/ims:org>

               <ims:timeFrame>

                  <ims:begin>2012-01-01T00:00:00.000000</ims:begin>

                  <ims:end>2012-04-01T00:00:00.000000</ims:end>

               </ims:timeFrame>

            </ims:courseSection>

         </ims:courseSectionRecord>

      </ims:replaceCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

replaceCourseSection 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 template translator configuration accepts the following fields in the request:

Property	LIS Request Mapping	Required
Code	sourcedGUID.sourcedId	Yes
Name	courseSection.title.textString	Yes
Parent OfferingId	courseSection.parentOfferingId	Yes
Parent DepartmentId	courseSection.org.orgName	Yes
Parent SemesterId	courseSection.academicSession.textString	No
Start Date	courseSection.timeFrame(0).begin	Yes
End Date	courseSection.timeFrame(0).end	Yes
Status	courseSection.status	No

Sample replaceCourseSection 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_replaceCourseSection_20120130T160616_8347289Z</imsx_messageIdentifier>

         <imsx_statusInfo>

            <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>warning</imsx_severity>

            <imsx_messageRefIdentifier>1234</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"/>

</s:Envelope>

replaceCourseSection 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 readCourseSection 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:readCourseSectionRequest>

         <ims:sourcedId<Demo_Section</ims:sourcedId>

      </ims:readCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

Sample readCourseSection 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_messageIdentifier>CMS_readCourseSection_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">

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

        <courseSectionRecord>

           <sourcedGUID>

               <sourcedId>Demo_Section</sourcedId>

           </sourcedGUID>

            <courseSection/>

        </courseSectionRecord>

      </readCourseSectionResponse>

   </s:Body>

</s:Envelope>