Documentation sur les intégrations

Service de gestion de section de cours (SGSC)

Ce service sert à affecter les sections de cours (ou groupes) de Brightspace.

Opérations mises en œuvre

deleteCourseSection
replaceCourseSection
readCourseSection

À propos de l’opération deleteCourseSection

deleteCourseSection est l’opération qui sert à supprimer l’unité organisationnelle de Brightspace associée aux sections de cours LIS.

Flux de traitement : deleteCourseSection

À la réception d’une requête deleteCourseSection du LIS, l’adaptateur obtient l’ID unique pour la section de cours à partir du champ sourcedid de la requête, sans avoir recours à un traducteur.
Une fois l’ID de la section de cours reçu, les gestionnaires de la plateforme IPSIS configurés pour IDeleteCourseOfferingHandler servent à traiter la requête.
La réponse du LIS est ensuite générée depuis le gestionnaire de réponse.

Exemple de requête deleteCourseSection

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

   xmlns:ims="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0">

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

         <ims:sourcedId>LIS_Section_01</ims:sourcedId>

      </ims:deleteCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

champs d’en-tête et de corps de requête deleteCourseSection

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

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

Exemple de réponse deleteCourseSection

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

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 replaceCourseSection

L’opération replaceCourseSection sert à créer ou à mettre à jour les sections ou groupes de cours de Brightspace.

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 ou par l’outil Groupes ou Sections du cours (selon la configuration du gestionnaire).

Flux de traitement : replaceCourseSection

Lorsqu’une requête replaceCourseSection 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.
Les gestionnaires de la plateforme IPSIS configurés pour IReplaceCourseSectionHandler servent à 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 replaceCourseSection

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

   xmlns:ims="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0">

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

         <!--Not Used by D2L-->

         <ims:sourcedId>Demo_Section_01</ims:sourcedId>

         <ims:courseSectionRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_Section_01</ims:sourcedId>

            </ims:sourcedGUID>

            <ims:courseSection>

               <ims:title>

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

                  <ims:textString>Demo Section 1</ims:textString>

               </ims:title>

               <ims:parentOfferingId>Demo_Offering</ims:parentOfferingId>

               <!--Optional:-->

               <ims:status>Active</ims:status>

               <!--Optional:-->

               <ims:academicSession>

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

                  <ims:textString>Demo_Semester</ims:textString>

               </ims:academicSession>

               <!--Optional:-->

               <ims:org>

                  <!--Optional:-->

                  <ims:orgName>

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

                     <ims:textString>Demo_Department</ims:textString>

                  </ims:orgName>

               &lt:/ims:org>

               <ims:timeFrame>

                  <ims:begin>2012-01-01T00:00:00.000000</ims:begin>

                  <ims:end>2012-04-01T00:00:00.000000</ims:end>

               </ims:timeFrame>

            </ims:courseSection>

         </ims:courseSectionRecord>

      </ims:replaceCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

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

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	sourcedGUID.sourcedId	Oui
Nom	courseSection.title.textString	Oui
ID primaire de l’offre	courseSection.parentOfferingId	Oui
Id du département primaire	courseSection.org.orgName	Oui
Parent SemesterId	courseSection.academicSession.textString	Non
Date de début	courseSection.timeFrame(0).begin	Oui
Date de fin	courseSection.timeFrame(0).end	Oui
État	courseSection.status	Non

Exemple de réponse replaceCourseSection

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

   <s:Header>

      <h:imsx_syncResponseHeaderInfo xmlns:h="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0"

         xmlns="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0"

         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>CMS_replaceCourseSection_20120130T160616_8347289Z</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 replaceCourseSection

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 readCourseSection

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

   xmlns:ims="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0">

   <soapenv:Header>

      <ims:imsx_syncRequestHeaderInfo>

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

         <ims:imsx_messageIdentifier<MessageId_774290</ims:imsx_messageIdentifier>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:readCourseSectionRequest>

         <ims:sourcedId<Demo_Section</ims:sourcedId>

      </ims:readCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

Exemple de réponse readCourseSection

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

   <s:Header>

      <h:imsx_syncResponseHeaderInfo xmlns:h="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0"

          xmlns="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0"

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

         <imsx_messageIdentifier>CMS_readCourseSection_20120803T145419_1122428Z</imsx_messageIdentifier>

         <imsx_statusInfo>

           <imsx_codeMajor>success</imsx_codeMajor>

           <imsx_severity>warning</imsx_severity>

           <imsx_messageRefIdentifier>MessageId_774290</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">

     <readCourseSectionResponse xmlns="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0">

        <courseSectionRecord>

           <sourcedGUID>

               <sourcedId>Demo_Section</sourcedId>

           </sourcedGUID>

            <courseSection/>

        </courseSectionRecord>

      </readCourseSectionResponse>

   </s:Body>

</s:Envelope>