This service manages Brightspace user accounts.
Implemented operations
- deletePerson
- replacePerson
- readPerson
Preferred First and Last Names
Clients using LIS 2.0 can include and maintain users’ preferred names using XML tags in an LIS integration. The following rules apply when IPSIS allows the SIS to overwrite preferred names in Brightspace:
- If LIS has an empty preferred first name for a user who has a preferred first name in Brightspace, delete the preferred first name.
- If LIS has an empty preferred last name for a user who has a preferred last name in Brightspace, delete the preferred last name.
- If LIS has the preferred name block and it only includes the preferred last name, do not change the preferred first name and update the preferred last name.
- If LIS has the preferred name block and it only includes the preferred first name, do not change the preferred last name and update the preferred first name.
- When the Preferred Name block is missing from the request, delete the preferred first and last names.
- If LIS has the preferred name block and both names are present, overwrite the preferred first and last names.
About the deletePerson operation
The deletePerson operation deletes users from Brightspace.
Process flow: deletePerson
- The adapter obtains the unique user ID from the sourcedId field of the request.
- Handlers configured for IDeleteUserHandler process the request.
- The LIS response is generated from the handler response.
Sample deletePerson request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ims="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_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:deletePersonRequest>
<ims:sourcedId>Demo_User</ims:sourcedId>
</ims:deletePersonRequest>
</soapenv:Body>
</soapenv:Envelope>
Sample deletePerson response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:imsx_syncResponseHeaderInfo
xmlns:h="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0"
xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_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>PMS_deletePerson_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/>
</s:Envelope>
About the replacePerson operation
The replacePerson operation creates or updates Brightspace users.
Process flow: replacePerson
- The request is translated using ITranslatePerson translators.
- Handlers configured for IReplaceUserHandler process the request.
- A response is generated from the handler result.
Sample readPerson request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ims="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
<soapenv:Header>
<ims:imsx_syncRequestHeaderInfo>
<ims:imsx_version>1.0</ims:imsx_version>
<ims:imsx_messageIdentifier>1234567</ims:imsx_messageIdentifier>
</ims:imsx_syncRequestHeaderInfo>
</soapenv:Header>
<soapenv:Body>
<ims:readPersonRequest>
<ims:sourcedId>Demo_User</ims:sourcedId>
</ims:readPersonRequest>
</soapenv:Body>
</soapenv:Envelope>