Documentatie over integraties

De Person Management Service (PMS)

Deze service wordt gebruikt om Brightspace®-gebruikersaccounts te beïnvloeden.

Geïmplementeerde activiteiten

deletePerson
replacePerson
readPerson

Voor- en achternaam van voorkeur

Clients die LIS 2.0 gebruiken, kunnen voorkeursnamen van gebruikers opnemen en onderhouden met behulp van XML-labels in een LIS-integratie. Hieronder staan de regels die IPSIS volgt wanneer de SIS de voorkeursnamen van een gebruiker in Brightspace® mag overschrijven:

Als LIS een lege voorkeursvoornaam heeft voor een gebruiker met een voorkeursvoornaam in Brightspace®, verwijdert u de voorkeursvoornaam.
Als LIS een lege voorkeursachternaam heeft voor een gebruiker met een voorkeursachternaam in Brightspace®, verwijdert u de voorkeursachternaam.
Als LIS het voorkeursnaamblok heeft en alleen de voorkeursachternaam bevat, doet u niets met de voorkeursvoornaam en werkt u de voorkeursachternaam bij in Brightspace®.
Als LIS het voorkeursnaamblok heeft en alleen de voorkeursvoornaam bevat, doet u niets met de voorkeursachternaam en werkt u de voorkeursvoornaam bij in Brightspace®.
Als het blok Voorkeursnaam ontbreekt in de aanvraag, verwijdert u de voorkeursvoor- en achternaam.
Als LIS het voorkeursnaamblok heeft en de voor- en achternaam aanwezig zijn, overschrijft u de voorkeursvoor- of achternaam in Brightspace®.

Opmerking: Het NameType Voorkeur bevat de voorkeursnaam van een gebruiker en kan als onderdeel van een Person-object naast de rest van de naam en de onderdeelnaam worden verzonden.

Voor klanten die IPSIS versie 1.0 gebruiken:

PersonRequestPreferendFirstLastNameOptionalTranslator mag overal in de lijst staan.
ReplaceUserPreferredFirstNameNoUpdateHandler en ReplaceUserPreferredLastNameNoUpdateHandler moeten voor ReplaceUserSaveLMSHandler worden geplaatst

Info over de deletePerson-bewerking

De bewerking deletePerson wordt gebruikt om gebruikers uit Brightspace® te verwijderen.

Processtroom: deletePerson

Wanneer een LIS-aanvraag deletePerson wordt ontvangen, haalt de adapter de unieke id voor de gebruiker rechtstreeks op uit het veld sourcedId van de aanvraag, zonder gebruik te maken van een inplugbaar omzettingsprogramma.
Zodra de persoon-id is verkregen, worden de IPSIS-platformhandlers die zijn geconfigureerd voor IDeleteUserHandler gebruikt om de aanvraag te verwerken.
De LIS-respons wordt gegenereerd op basis van de respons van de handler.

Voorbeeld van een deletePerson-aanvraag

<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:deletePersonRequest>

         <ims:sourcedId>Demo_User</ims:sourcedId>

      </ims:deletePersonRequest>

   </soapenv:Body>

</soapenv:Envelope>

Koptekst- en tekstvelden voor deletePerson-aanvraag

Velden van aanvraagkoptekst

Raadpleeg voor meer informatie het onderwerp LIS v2.0-services gebruiken > Aanvraag- en responskopteksten.

Velden van aanvraagtekst

De adapter accepteert de volgende velden in de aanvraag:

Eigenschap	Toewijzing LIS-aanvraag	Verplicht
Code	deletePersonRequest.sourcedId	Ja

Voorbeeld van een deletePerson-respons

<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_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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

       xmlns:xsd="http://www.w3.org/2001/XMLSchema"/>

</s:Envelope>

Koptekst- en tekstvelden voor deletePerson-respons

Velden voor responskoptekst

Raadpleeg voor meer informatie het onderwerp LIS v2.0-services gebruiken > Aanvraag- en responskopteksten.

Velden voor responstekst

Er worden geen velden geretourneerd in de tekst van de respons.

Info over de replacePerson-bewerking

De replacePerson-bewerking wordt gebruikt om Brightspace®-gebruikers te maken of bij te werken.

Wanneer u de standaardconfiguraties gebruikt, kunt u na succes controleren of de gebruiker is gemaakt of bijgewerkt via de tool Gebruikers beheren in Brightspace®.

Processtroom: replacePerson

Wanneer een LIS-aanvraag replacePerson wordt ontvangen, vertaalt Brightspace® de aanvraag met behulp van de LIS-omzettingsprogramma's die zijn geconfigureerd voor ITranslatePerson om de aanvraag om te zetten in een indeling die het IPSIS-platform kan begrijpen.
Zodra de aanvraag is vertaald, verwerken de IPSIS-platformhandlers die zijn geconfigureerd voor IReplaceUserHandler de aanvraag.
Er wordt een LIS-respons gegenereerd op basis van de respons van de handler.

Voorbeeld van replacePerson-aanvraag

Opmerking: Deze voorbeeldaanvraag bevat een optioneel uitbreidingsveld (vetgedrukt) waarmee de status van een gebruiker kan worden gewijzigd nadat deze voor het eerst is gemaakt. Het uitbreidingsveld is vereist voor deze actie omdat de gebruikersstatus niet rechtstreeks overeenkomt met een veld uit de LIS-specificatie.

<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>12346</ims:imsx_messageIdentifier>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:replacePersonRequest>

         <!--niet gebruikt door D2L®-->

         <ims:sourcedId>Demo_User</ims:sourcedId>

         <ims:personRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_User</ims:sourcedId>

            </ims:sourcedGUID>

            <!--Optioneel:-->

            <ims:person>

               <!--Nul of meer herhalingen:-->

               <ims:name>

                  <ims:nameType>

                     <ims:instanceIdentifier>

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

                        <ims:textString>Contact</ims:textString>

                     </ims:instanceIdentifier>

                     <ims:instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/nametypevocabularyv1p0</ims:instanceVocabulary&gt;

                     <ims:instanceValue>

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

                        <ims:textString>Contact</ims:textString>

                     </ims:instanceValue>

                  </ims:nameType>

                  <!--1 of meer herhalingen:-->

                  <ims:partName>

                     <ims:instanceIdentifier>

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

                        <ims:textString>Contact-First</ims:textString>

                     </ims:instanceIdentifier>

                     <ims:instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/partnamevocabularyv1p0</ims:instanceVocabulary&gt;

                     <ims:instanceName>

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

                        <ims:textString>First</ims:textString>

                     </ims:instanceName>

                     <ims:instanceValue>

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

                        <ims:textString>Demo</ims:textString>

                     </ims:instanceValue>

                  </ims:partName>

                  <ims:partName>

                     <ims:instanceIdentifier>

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

                        <ims:textString>Contact-Last</ims:textString>

                     </ims:instanceIdentifier>

                     <ims:instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/partnamevocabularyv1p0&lt:/ims:instanceVocabulary&gt;

                     <ims:instanceName>

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

                        <ims:textString>Last</ims:textString>

                     </ims:instanceName>

                     <ims:instanceValue>

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

                        <ims:textString>User</ims:textString>

                     </ims:instanceValue>

                  </ims:partName>

               </ims:name>

               <!--Nul of meer herhalingen:-->

               <ims:contactinfo>

                  <ims:contactinfoType>

                     <ims:instanceIdentifier>

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

                        <ims:textString>EmailPrimary</ims:textString>

                     </ims:instanceIdentifier>

                     <ims:instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/contactinfotypevocabularyv1p0</ims:instanceVocabulary&gt;

                     <ims:instanceValue>

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

                        <ims:textString>EmailPrimary</ims:textString>

                     </ims:instanceValue>

                  </ims:contactinfoType>

                  <ims:contactinfoValue>

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

                     <ims:textString>duser@demo.com</ims:textString>

                  </ims:contactinfoValue>

               </ims:contactinfo>

               <!--Nul of meer herhalingen:-->

               <ims:roles>

                  <ims:enterpriserolesType>

                     <ims:instanceIdentifier>

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

                        <ims:textString>StudentInformationSystem</ims:textString>

                     </ims:instanceIdentifier>

                     <ims:instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/epriserolestypevocabularyv1p0</ims:instanceVocabulary&gt;

                     <ims:instanceValue>

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

                        <ims:textString>StudentInformationSystem</ims:textString>

                     </ims:instanceValue>

                  </ims:enterpriserolesType>

                  <!--Nul of meer herhalingen:-->

                  <ims:institutionRole>

                     <ims:institutionroletype>

                        <ims:instanceIdentifier>

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

                           <ims:textString>StudentInformationSystem-Student</ims:textString>

                        </ims:instanceIdentifier>

                        <ims:instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/institutionroletypevocabularyv1p0</ims:instanceVocabulary&gt;

                        <ims:instanceValue>

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

                           <ims:textString>Student</ims:textString>

                        </ims:instanceValue>

                     </ims:institutionroletype>

                     <ims:primaryroletype>1</ims:primaryroletype>

                  </ims:institutionRole>

                  <!--Optioneel:-->

                  <ims:userId>

                     <ims:userIdValue>

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

                        <ims:textString>duser</ims:textString>

                     </ims:userIdValue>

                     <!--Optioneel:-->

                     <ims:password>

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

                        <ims:textString>d2l</ims:textString>

                     </ims:password>

                  </ims:userId>

               </ims:roles>


		 <ims:extension>


		    <ims:extensionField>


			<ims:fieldName>IsActive</ims:fieldName>


			<ims:fieldType>Boolean</ims:fieldType>


			<ims:fieldValue>True</ims:fieldValue>


		    </ims:extensionField>


		 </ims:extension>

            </ims:person>

         </ims:personRecord>

      </ims:replacePersonRequest>

   </soapenv:Body>

</soapenv:Envelope>

<ims:agent>

<ims:agentId>

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

<ims:textString>{Parent user Id}</ims:textString>

</ims:agentId>

<ims:agentDomain>

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

<ims:textString>{Parent role}</ims:textString>

</ims:agentDomain>

</ims:agent>

<ims:extension>

<ims:extensionField>

<ims:fieldName>SynchronizeRelationships</ims:fieldName>

<ims:fieldType>Boolean</ims:fieldType>

<ims:fieldValue>true</ims:fieldValue>

</ims:extensionField>

</ims:extension>

Koptekst- en tekstvelden voor replacePerson-aanvraag

Velden van aanvraagkoptekst

Raadpleeg voor meer informatie het onderwerp LIS v2.0-services gebruiken > Aanvraag- en responskopteksten.

Velden van aanvraagtekst

De configuratie van het omzettingsprogramma voor sjablonen accepteert de volgende velden in de aanvraag:

Eigenschap	Toewijzing LIS-aanvraag	Verplicht
OrgDefinedId	sourcedGUID.sourcedId	Ja
Volledige naam	person.name.formname	Nee
Voornaam	person.name.partName.instanceValue.textString Waarbij person.name.partName.instanceName.textString = "First" of "Given"	Ja
Achternaam	person.name.partName.instanceValue.textString Waarbij person.name.partName.instanceName.textString = "Last", "Family" of "Surname"	Ja
E-mailadres	person.contactinfo.contactinfoValue.textString Waarbij person.contactinfo.contactinfoType.instanceValue = "EmailPrimary"	Nee
Rol	person.roles.institutionRole(*).institutionroletype.instanceValue.textString	Nee
Primaire rol	person.roles.institutionRole().institutionroletype.instanceValue.textString wanneer person.roles.institutionRole().primaryroletype = true	Nee
Gebruikersnaam	person.roles.userId.userIdValue.textString	Nee
Type gebruikersnaam	person.roles.userId.userIdType.textString	Nee
Wachtwoord	person.roles.userId.password.textString	Nee
Coderingstype	person.roles.userId.pwEncryptionType.textString	Nee
AuthenticationType	person.roles.userId.authenticationType.textString	Nee
IsActive	person.extension.extensionField.fieldValue	Nee

Voorbeeld van replacePerson-respons

<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_replacePerson_20120418T234324_4244880Z</imsx_messageIdentifier>

         <imsx_statusInfo>

            <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>warning</imsx_severity>

            <imsx_messageRefIdentifier>12346</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>

Koptekst- en tekstvelden voor replacePerson-respons

Velden voor responskoptekst

Raadpleeg voor meer informatie het onderwerp LIS v2.0-services gebruiken > Aanvraag- en responskopteksten.

Velden voor responstekst

Er worden geen velden geretourneerd in de tekst van de respons.

Voorbeeld van readPerson-aanvraag

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

         <!--Optioneel:-->

         <ims:imsx_sendingAgentIdentifier/>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:readPersonRequest>

         <ims:sourcedId>Demo_User</ims:sourcedId>

      </ims:readPersonRequest>

   </soapenv:Body>

</soapenv:Envelope>

Voorbeeld van readPerson-respons

<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_readPerson_20120720T192847_4131414Z</imsx_messageIdentifier>

         <imsx_statusInfo>

           <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>warning</imsx_severity>

            <imsx_messageRefIdentifier>12354</imsx_messageRefIdentifier>

            <imsx_description>PMS.readPerson</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">

      <readPersonResponse xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">

         <personRecord>

           <sourcedGUID>

              <sourcedId>Demo_User</sourcedId>

           </sourcedGUID>

           <person>

               <formname>

                 <formnameType>

                     <instanceIdentifier>

                       <language>en-US</language>

                    </instanceIdentifier>

                     <instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/formatnmetypevocabularyv1p0</instanceVocabulary&gt;

                     <instanceValue>

                       <language>en-US</language>

                        <textString>Full</textString>

                     </instanceValue>

                 </formnameType>

                  <formattedName>

                    <language>en-US</language>

                     <textString>Demo User</textString>

                 </formattedName>

               </formname>

              <name>

                  <nameType>

                    <instanceIdentifier>

                        <language>en-US</language>

                     </instanceIdentifier>

                    <instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/nametypevocabularyv1p0</instanceVocabulary&gt;

                    <instanceValue>

                        <language>en-US</language>

                        <textString>Full</textString>

                     </instanceValue>

                  </nameType>

                 <partName>

                    <instanceIdentifier>

                       <language>en-US</language>

                    </instanceIdentifier>

                    <instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/partnamevocabularyv1p0</instanceVocabulary&gt;

                    <instanceName>

                        <language>en-US</language>

                       <textString>First</textString>

                    </instanceName>

                     <instanceValue>

                        <language>en-US</language>

                       <textString>Demo</textString>

                     </instanceValue>

                  </partName>

                  <partName>

                     <instanceIdentifier>

                       <language>en-US</language>

                     </instanceIdentifier>

                    <instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/partnamevocabularyv1p0</instanceVocabulary&gt;

                     <instanceName>

                        <language>en-US</language>

                        <textString>Last</textString>

                     </instanceName>

                     <instanceValue>

                        <language>en-US</language>

                        <textString>User</textString>

                    </instanceValue>

                  </partName>

               </name>

           </person>

         </personRecord>

      </readPersonResponse>

   </s:Body>

</s:Envelope>