Integrations Documentation

The Group Management Service (GMS)

This service is used to affect Brightspace OrgUnits other than templates, offerings, and sections. This includes departments, semesters, as well as custom org unit types.

Implement operations

deleteGroup
replaceGroup
readGroup

About the deleteGroup operation

deleteGroup is the operation used to delete Brightspace Org Units such as departments and semesters.

You use deleteCourseTemplate for course templates, deleteCourseOffering for course offerings, deleteCourseSection for course sections.

Processing the deleteGroup operation

The deleteGroup implementation uses one of three IPSIS handler interfaces depending on the type of group that is being searched for.

IDeleteDepartmentHandler - For those org units with a standard org unit type of Department.
IDeleteOtherOrgUnitHandler - For those org units that do not have a standard org unit type of Department, Semester, CourseTemplate, CourseOffering, Section, or Group.
IDeleteSemesterHandler - For those org units with a standard org unit type of Semester.

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

         <!--Optional:-->

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

         <!--Optional:-->

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

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:deleteGroupRequest>

         <ims:sourcedId>LIS_Test_Department</ims:sourcedId>

      </ims:deleteGroupRequest>

   </soapenv:Body>

</soapenv:Envelope>

deleteGroup 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

Field	Note	Required
deleteGroupRequest.sourcedId	This field must have a value to communicate the unique identifier of the group you are trying to delete.	Yes

Sample deleteGroup 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>GMS_deleteGroup_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>

deleteGroup 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 replaceGroup operation

replaceGroup is the operation used to create or update Brightspace Org Units such as departments and semesters.

You should use replaceCourseTemplate for course templates, replaceCourseOffering for course offerings, or replaceCourseSection for course sections.

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

Process flow: replaceGroup

When an LIS replaceGroup request is received, Brightspace translates the request using the LIS translators configured for ITranslateGroup to transform the request into a format that the IPSIS Platform can understand.
Once the request has been translated, the GroupType is used to determine which IPSIS Platform handlers are called.
- If the GroupType is associated with the Department Standard OrgUnit Type, the handlers configured for IReplaceDepartmentHandler are used to process the request.
- If the GroupType is associated with the Semester Standard OrgUnit Type, the handlers configured for IReplaceSemesterHandler are used to process the request.
- If the GroupType is anything else, the handlers configured for IReplaceOrgUnitHandler are used to process the request.
A LIS response is generated from the handler response.

Sample replaceGroup 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:replaceGroupRequest>

            <!--Not Used by D2L-->

          <ims:sourcedId>Demo_Semester</ims:sourcedId>

            <ims:groupRecord>

               <ims:sourcedGUID>

                  <ims:sourcedId>Demo_Semester</ims:sourcedId>

               </ims:sourcedGUID>

               <ims:group>

                  <ims:groupType>

                     <!--Not Used by D2L-->

                     <ims:scheme>

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

                        <ims:textString>D2L</ims:textString>

                     </ims:scheme>

                     <ims:typevalue>

                        <ims:id>

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

                           <ims:textString>Semester</ims:textString>

                        </ims:id>

                        <!--Not Used by D2L-->

                        <ims:type>

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

                           <ims:textString>Semester</ims:textString>

                        </ims:type>

                        <!--Not Used by D2L-->

                        <ims:level>

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

                           <ims:textString>1</ims:textString>

                        </ims:level>

                     </ims:typevalue>

                  </ims:groupType>

                  <ims:description>

                     <ims:shortDescription>Demo Semester</ims:shortDescription>

                  </ims:description>

               </ims:group>

            </ims:groupRecord>

         </ims:replaceGroupRequest>

     </soapenv:Body>

  </soapenv:Envelope>

replaceGroup 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	groupRecord.sourcedGUID.sourcedId	Yes
Name	groupRecord.group.description.shortDescription	Yes
Type	groupRecord.group.groupType.typeValue(0).id	Yes

Sample replaceGroup 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>GMS_replaceGroup_20120104T232428_1383886Z</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>

replaceGroup 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 readGroup 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:readGroupRequest>

         <ims:sourcedId>LIS_Test_Department</ims:sourcedId>

      </ims:readGroupRequest>

   </soapenv:Body>

</soapenv:Envelope>

Sample readGroup 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>GMS_readGroup_20120104T231937_2063886Z</imsx_messageIdentifier>

         <imsx_statusInfo>

           <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>warning</imsx_severity>

           <imsx_messageRefIdentifier>1234</imsx_messageRefIdentifier>

           <imsx_description>GMS.readGroup</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">

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

        <groupRecord>

           <sourcedGUID>

               <sourcedId>LIS_Test_Department</sourcedId>

           </sourcedGUID>

           <group>

              <groupType>

                 <typevalue>

                    <id>Department</id>

                 </typevalue>

              </groupType>

              <description>

                 <shortDescription>LIS Test Department</shortDescription>

              </description>

            </group>

         </groupRecord>

      </readGroupResponse>

   </s:Body>

</s:Envelope>