This service manages Brightspace enrollments.
Implemented operations
- deleteMembership
- replaceMembership
- readMembership
About the deleteMembership operation
deleteMembership deletes enrollments in Brightspace. Enrollments represent the relationship between users and org units and can be verified in Manage Users or in the Classlist for a course.
Process flow: deleteMembership
- When a deleteMembership request is received, the adapter obtains the unique ID for the membership from the sourcedId field of the request without using a pluggable translator.
- The IPSIS Platform handlers configured for IDeleteEnrollmentHandler process the request.
- The LIS response is generated from the handler response.
Sample deleteMembership request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ims="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_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:deleteMembershipRequest>
<ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>
</ims:deleteMembershipRequest>
</soapenv:Body>
</soapenv:Envelope>
Sample deleteMembership response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:imsx_syncResponseHeaderInfo
xmlns:h="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0"
xmlns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_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>MMS_deleteMembership_20120120T191434_9913552Z</imsx_messageIdentifier>
<imsx_statusInfo>
<imsx_codeMajor>success</imsx_codeMajor>
<imsx_severity>status</imsx_severity>
<imsx_messageRefIdentifier>1234</imsx_messageRefIdentifier>
<imsx_description/>
<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 replaceMembership operation
replaceMembership creates or updates enrollments in Brightspace.
Process flow: replaceMembership
- Brightspace translates the replaceMembership request using the LIS translators configured for ITranslateMembership.
- The IPSIS Platform handlers configured for IReplaceEnrollmentHandler process the request.
- An LIS response is generated from the handler response.
Sample replaceMembership request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ims="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_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:replaceMembershipRequest>
<ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>
<ims:membershipRecord>
<ims:sourcedGUID>
<ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>
</ims:sourcedGUID>
<ims:membership>
<ims:collectionSourcedId>Demo_Section_01</ims:collectionSourcedId>
<ims:membershipIdType>courseSection</ims:membershipIdType>
<ims:member>
<ims:personSourcedId>Demo_User</ims:personSourcedId>
<ims:role>
<ims:roleType>Learner</ims:roleType>
<ims:status>Active</ims:status>
</ims:role>
</ims:member>
</ims:membership>
</ims:membershipRecord>
</ims:replaceMembershipRequest>
</soapenv:Body>
</soapenv:Envelope>
Sample readMembership request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ims="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_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:readMembershipRequest>
<ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>
</ims:readMembershipRequest>
</soapenv:Body>
</soapenv:Envelope>