Documentation sur les intégrations

Service de gestion d'abonnements (SGA)

Ce service sert à affecter les inscriptions dans Brightspace.

Opérations mises en œuvre

deleteMembership
replaceMembership
readMembership

À propos de l’opération deleteMembership

deleteMembership est l’opération qui sert à supprimer des inscriptions dans Brightspace. Les inscriptions sont la relation entre l’utilisateur et l’unité organisationnelle, et elles peuvent être vérifiées ou examinées dans Gérer les utilisateurs ou dans la Liste des participants pour un cours particulier.

Flux de traitement : deleteMembership

À la réception d’une requête deleteMembership du LIS, l’adaptateur obtient l’ID unique pour l’abonnement à partir du champ sourcedId de la requête, sans avoir recours à un traducteur.
Une fois l’ID d’abonnement obtenu, les gestionnaires de la plateforme IPSIS configurés pour IDeleteEnrollmentHandler traitent la requête.
La réponse du LIS est ensuite générée depuis le gestionnaire de réponse.

Exemple de requête deleteMembership

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

Champs d’en-tête et de corps de requête deleteMembership

Champs de l’en-tête de la requête

Pour plus d’informations, reportez-vous à la grille d'évaluation Utiliser le service LIS v2.0 > En-têtes de requête et de réponse.

Champs du corps de la requête

L’adaptateur accepte les champs suivants dans la requête :

Propriété	Mise en correspondance de requête LIS	Requise
Code	deleteMembershipRequest.sourcedId	Oui

Exemple de réponse deleteMembership

<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*gt;

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

Champs d’en-tête et de corps de réponse deleteMembership

Champs de l’en-tête de réponse

Pour plus d’informations, reportez-vous à la grille d'évaluation Utiliser le service LIS v2.0 > En-têtes de requête et de réponse.

Champs du corps de réponse

Aucun champ n’est retourné dans le corps de la réponse.

À propos de l’opération replaceMembership

ReplaceMembership est l’opération qui sert à supprimer des inscriptions de Brightspace. Les inscriptions sont la relation entre l’utilisateur et l’unité organisationnelle, et elles peuvent être vérifiées ou examinées dans Gérer les utilisateurs ou dans la Liste des participants pour un cours particulier.

Flux de traitement : replaceMembership

Lorsqu’une requête replaceMembership du LIS est reçue, Brightspace la traduit à l’aide des traducteurs LIS configurés pour ITranslateMembership qui convertissent la requête dans un format que la plateforme IPSIS comprend.
Une fois la requête traduite, les gestionnaires de la plateforme IPSIS configurés pour IReplaceEnrollmentHandler traitent la requête.
Une réponse du LIS est ensuite générée depuis le gestionnaire de réponse.

Exemple de requête replaceMembership

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

         <!--Not Used by D2L-->

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

               <!--Not Used by D2L-->

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

Champs d’en-tête et de corps de requête replaceMembership

Champs de l’en-tête de la requête

Pour plus d’informations, reportez-vous à la grille d'évaluation Utiliser le service LIS v2.0 > En-têtes de requête et de réponse.

Champs du corps de la requête

Le modèle de configuration du traducteur accepte les champs suivants de la requête :

Propriété	Mise en correspondance de requête LIS	Requise
ID du message d’inscription	membershipRecord.sourcedGUID.sourcedId	Oui
Code de section	membershipRecord.membership.collectionSourcedId	Oui
UserId	membershipRecord.membership.member.personSourcedId	Oui
Rôle	membershipRecord.membership.member.role{*}.roleType	Oui
État de l’inscription	membershipRecord.membership.member.role{*}.status	Oui

Exemple de réponse replaceMembership

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

Champs d’en-tête et de corps de réponse replaceMembership

Champs de l’en-tête de réponse

Pour plus d’informations, reportez-vous à la grille d'évaluation Utiliser le service LIS v2.0 > En-têtes de requête et de réponse.

Champs du corps de réponse

Aucun champ n’est retourné dans le corps de la réponse.

Exemple de requête readMembership

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

Exemple de réponse readMembership

<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_readMembership_20120419T000158_6944880Z</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">

       <ims:membershipRecord>

         <ims:sourcedGUID>

            <ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>

         </ims:sourcedGUID>

         <ims:membership>

            <ims:collectionSourcedId>F515050A-6A6C-486B-8B46-97BA6FD62458</ims:collectionSourcedId>

            <ims:membershipIdType>83418823-CADC-40A6-885E-C460F78E896F</ims:membershipIdType>

            <ims:member>

               <ims:personSourcedId>967F247A-F65B-41CE-8A33-8B2E1C8AF357</ims:personSourcedId>

              <ims:role><ims:roleType>Learner</ims:roleType></ims:role>

           </ims:member>

         </ims:membership>

     </ims:membershipRecord>

   </s:Body>

</s:Envelope>