This service manages Brightspace org units other than templates, offerings, and sections. This includes departments, semesters, and custom org unit types.
Implemented operations
- deleteGroup
- replaceGroup
- readGroup
About the deleteGroup operation
deleteGroup deletes Brightspace org units such as departments and semesters.
Use deleteCourseTemplate for course templates, deleteCourseOffering for course offerings, and deleteCourseSection for course sections.
Processing the deleteGroup operation
The deleteGroup implementation uses one of three IPSIS handler interfaces depending on the type of group being processed.
- IDeleteDepartmentHandler - Used for org units with the Department standard org unit type.
- IDeleteOtherOrgUnitHandler - Used for org units that are not Department, Semester, CourseTemplate, CourseOffering, Section, or Group.
- IDeleteSemesterHandler - Used for org units with the Semester standard org unit type.
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>
<ims:imsx_version>V1.0</ims:imsx_version>
<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>
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>
About the replaceGroup operation
replaceGroup creates or updates Brightspace org units such as departments and semesters.
Use replaceCourseTemplate for course templates, replaceCourseOffering for course offerings, and replaceCourseSection for course sections.
Process flow: replaceGroup
- Brightspace receives the replaceGroup request and translates it using the LIS translators configured for ITranslateGroup.
- The IPSIS Platform determines which handler to use based on the GroupType.
- A response is generated from the handler result.
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>
<ims:sourcedId>Demo_Semester</ims:sourcedId>
<ims:groupRecord>
<ims:sourcedGUID>
<ims:sourcedId>Demo_Semester</ims:sourcedId>
</ims:sourcedGUID>
<ims:group>
<ims:description>
<ims:shortDescription>Demo Semester</ims:shortDescription>
</ims:description>
</ims:group>
</ims:groupRecord>
</ims:replaceGroupRequest>
</soapenv:Body>
</soapenv:Envelope>
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>