Documentation sur les intégrations

Service de gestion de groupe (SGG)

Ce service sert à affecter les unités organisationnelles de Brightspace autres que des modèles, des offres et des sections. Cela comprend les départements, semestres, ainsi que les types d’unité organisationnelle personnalisés.

Opérations de mise en œuvre

deleteGroup
replaceGroup
readGroup

À propos de l’opération deleteGroup

deleteGroup est l’opération qui sert à supprimer les unités organisationnelles de Brightspace comme les départements et les semestres.

Vous utilisez deleteCourseTemplate pour des modèles de cours, deleteCourseOffering pour les offres de cours, deleteCourseSection pour les sections de cours.

Opération traitement deleteGroup

La mise en œuvre deleteGroup utilise l’une des trois interfaces gestionnaires d’IPSIS selon le type de groupe recherché.

IDeleteDepartmentHandler – Pour ces unités organisationnelles dotées d’un type d’unité organisationnelle de département standard.
IDeleteOtherOrgUnitHandler – Pour ces unités organisationnelles qui ne disposent pas d’un type d’unité organisationnelle de département, semestre, modèle de cours, offre de cours, section ou groupe standard.
IDeleteDepartmentHandler – Pour ces unités organisationnelles dotées d’un type d’unité organisationnelle de semestre standard.

Exemple de requête deleteGroup

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

         <!--Optional:-->

         <ims:imsx_version>V1.0</ims:imsx_version>

         <!--Optional:-->

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

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

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

Champ	Note	Requise
deleteGroupRequest.sourcedId	Ce champ doit contenir une valeur pour communiquer l’identifiant unique du groupe que vous tentez de supprimer.	Oui

Exemple de réponse deleteGroup

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

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

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 replaceGroup

replaceGroup est l’opération qui sert à créer ou à mettre à jour les unités organisationnelles de Brightspace comme les départements et les semestres.

Vous utilisez replaceCourseTemplate pour des modèles de cours, replaceCourseOffering pour les offres de cours, replaceCourseSection pour les sections de cours.

Lorsque vous utilisez les configurations par défaut, suivant le succès de l’opération, vous pouvez valider la création ou la mise à jour du groupe le cas échéant, grâce au DOME dans Brightspace.

Flux de traitement : replaceGroup

Lorsqu’une requête replaceGroup du LIS est reçue, Brightspace la traduit à l’aide des traducteurs LIS configurés pour ITranslateGroup qui convertissent la requête dans un format que la plateforme IPSIS comprend.
Une fois la requête traduite, le type de groupe sert à déterminer quels gestionnaires de la plateforme IPSIS sont appelés.
- Si le type de groupe est associé au type d’unité organisationnelle configuré de département standard, les gestionnaires configurés pour IReplaceDepartmentHandler sont utilisés pour traiter la requête.
- Si le type de groupe est associé au type d’unité organisationnelle configuré de semestre standard, les gestionnaires configurés pour IReplaceSemesterHandler sont utilisés pour traiter la requête.
- Si le type de groupe est autre, les gestionnaires configurés pour IReplaceOrgUnitHandler sont utilisés pour traiter la requête.
Une réponse du LIS est ensuite générée depuis le gestionnaire de réponse.

Exemple de requête replaceGroup

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

            <!--Not Used by D2L-->

          <ims:sourcedId>Demo_Semester</ims:sourcedId>

            <ims:groupRecord>

               <ims:sourcedGUID>

                  <ims:sourcedId>Demo_Semester</ims:sourcedId>

               </ims:sourcedGUID>

               <ims:group>

                  <ims:groupType>

                     <!--Not Used by D2L-->

                     <ims:scheme>

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

                        <ims:textString>D2L</ims:textString>

                     </ims:scheme>

                     <ims:typevalue>

                        <ims:id>

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

                           <ims:textString>Semester</ims:textString>

                        </ims:id>

                        <!--Not Used by D2L-->

                        <ims:type>

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

                           <ims:textString>Semester</ims:textString>

                        </ims:type>

                        <!--Not Used by D2L-->

                        <ims:level>

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

                           <ims:textString>1</ims:textString>

                        </ims:level>

                     </ims:typevalue>

                  </ims:groupType>

                  <ims:description>

                     <ims:shortDescription>Demo Semester</ims:shortDescription>

                  </ims:description>

               </ims:group>

            </ims:groupRecord>

         </ims:replaceGroupRequest>

     </soapenv:Body>

  </soapenv:Envelope>

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

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
Code	groupRecord.sourcedGUID.sourcedId	Oui
Nom	groupRecord.group.description.shortDescription	Oui
Type	groupRecord.group.groupType.typeValue(0).id	Oui

Exemple de réponse replaceGroup

<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_replaceGroup_20120104T232428_1383886Z</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 replaceGroup

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 readGroup

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

Exemple de réponse readGroup

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

         <imsx_statusInfo>

           <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>warning</imsx_severity>

           <imsx_messageRefIdentifier>1234</imsx_messageRefIdentifier>

           <imsx_description>GMS.readGroup</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">

     <readGroupResponse xmlns="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0">

        <groupRecord>

           <sourcedGUID>

               <sourcedId>LIS_Test_Department</sourcedId>

           </sourcedGUID>

           <group>

              <groupType>

                 <typevalue>

                    <id>Department</id>

                 </typevalue>

              </groupType>

              <description>

                 <shortDescription>LIS Test Department</shortDescription>

              </description>

            </group>

         </groupRecord>

      </readGroupResponse>

   </s:Body>

</s:Envelope>