Integrations Documentation

The Section Association Management Service (SAMS)

This service is used to affect associations between SIS Sections and Brightspace Course Offerings.

Implemented operations

deleteSectionAssociation
replaceSectionAssociation
readSectionAssociation

About the deleteSectionAssociation operation

The deleteSectionAssociation operation is used to delete Brightspace org units associated with LIS Section Associations.

Process flow: deleteSectionAssociation

When an LIS deleteSectionAssociation request is received, the adapter obtains the unique id for the section association from the sourcedId field of the request directly, without the user of a pluggable translator.
Once the Course Section Id has been obtained, the IPSIS Platform handlers configured for IDeleteSectionAssociationHandler process the request.
The LIS response is then generated from the handler response.

Sample deleteSectionAssociation 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:deleteSectionAssociationRequest>

         <ims:sourcedId>Demo_Section_Assocation</ims:sourcedId>

      </ims:deleteSectionAssociationRequest>

   </soapenv:Body>

</soapenv:Envelope>

deleteSectionAssociation 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	deleteSectionAssociationRequest.sourcedId	Yes

Sample deleteSectionAssociation 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>

deleteSectionAssociation 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 replaceSectionAssociation operation

The replaceSectionAssociation operation is used to create or update Brightspace course offerings and associated sections/groups based on LIS Section Association requests.

When using the default configurations, upon success, you can validate the section association that has been created or updated using the Config Variable Browser in the Brightspace Manage Courses, or the My Courses widget.

Process flow: replaceSectionAssociation

When an LIS replaceSectionAssociation request is received, Brightspace translates the request using the LIS translators configured for ITranslateSectionAssociation to transform the request into a format that the IPSIS Platform can understand.
Once the request has been translated, the IPSIS Platform handlers configured for IReplaceSectionAssociationHandler are used to process the request.
A LIS response is generated from the handler response.

Note: If the ReplaceSectionAssociationDatesFromAllSectionsHandler is configured (automatically configured for LIS 2.0) then the oldest start date, and newest end date are used for the course.

Sample replaceSectionAssociation 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:replaceSectionAssociationRequest>

         <!--Not Used by D2L-->

         <ims:sourcedId>Demo_Section_Association</ims:sourcedId>

         <ims:sectionAssociationRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_Section_Association</ims:sourcedId>

            </ims:sourcedGUID>

            <ims:sectionAssociation>

               <!--Optional:-->

               <ims:title>

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

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

               </ims:title>

               <!--Optional:-->

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

               <!--Optional:-->

               <ims:courseSectionIdList>

                  <!--1 or more repetitions:-->

                  <ims:courseSectionId>Demo_Section_01</ims:courseSectionId>

               </ims:courseSectionIdList>

            </ims:sectionAssociation>

         </ims:sectionAssociationRecord>

      </ims:replaceSectionAssociationRequest>

   </soapenv:Body>

</soapenv:Envelope>

replaceSectionAssociation 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
Section Association Code	sectionAssociationRecord.sourcedGUID.sourcedId	Yes
Section Association Name	sectionAssociationRecord.sourcedGUID.sourcedId	Yes
Section Association Name	sectionAssociationRecord.sectionAssociation.title.textString	No
Section Ids	sectionAssociationRecord.sectionAssociation.courseSectionIdList{*}.CourseSectionId	Yes
Status	sectionAssociationRecord.sectionAssociation.status	No

Sample replaceSectionAssociation 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_replaceSectionAssociation_20120419T002302_0384880Z</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>

replaceSectionAssociation 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 readSectionAssociation 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:readSectionAssociationRequest>

         <ims:sourcedId>Demo_Section_Association</ims:sourcedId>

      </ims:readSectionAssociationRequest>

   </soapenv:Body>

</soapenv:Envelope>

Sample readSectionAssociation 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_readSectionAssociation_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">

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

         <sectionAssociationRecord>

            <sourcedGUID>

               <sourcedId>Demo_Section_Association</sourcedId>

            </sourcedGUID>

            <sectionAssociation/>

         </sectionAssociationRecord>

      </readSectionAssociationResponse>

   </s:Body>

</s:Envelope>