Documentation sur les intégrations

Service de gestion d’offre de cours (SGOC)

Ce service sert à affecter les offres de cours de D2L.

Opérations mises en œuvre

deleteCourseOffering
replaceCourseOffering
readCourseOffering

À propos de l’opération deleteCourseOffering

deleteCourseOffering est l’opération qui sert à supprimer les unités organisationnelles de D2L associées aux offres de cours LIS.

Flux de traitement : deleteCourseOffering

À la réception d’une requête deleteCourseOffering du LIS, l’adaptateur obtient l’ID unique pour l’offre de cours à partir du champ sourcedid de la requête, sans avoir recours à un traducteur.
Une fois l’ID de l’offre 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 pour compléter le traitement.

Exemple de requête deleteCourseOffering

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

         <ims:sourcedId>Demo_Course_Offering</ims:sourcedId>

      </ims:deleteCourseOfferingRequest>

   </soapenv:Body>

</soapenv:Envelope>

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

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	deleteCourseOfferingRequest.sourcedId	Oui

Exemple de deleteCourseOfferingResponse

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

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 replaceCourseOffering

L’opération replaceCourseOffering sert à créer ou à mettre à jour les offres 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 des offres de cours le cas échéant, grâce au DOME dans Brightspace, Gérer les cours ou le composant graphique Mes cours.

Flux de traitement : replaceCourseOffering

Lorsqu’une requête replaceCourseOffering du LIS est reçue, la requête est traduite à l’aide des traducteurs LIS configurés pour ITranslateCourseOffering 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 IReplaceCourseOfferingHandler servent à traiter la requête.
Une réponse du LIS est ensuite générée depuis le gestionnaire de réponse pour compléter le traitement.

Exemple de requête replaceCourseOffering

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

         <!--Not Used by D2L-->

         <ims:sourcedId>Demo_Offering</ims:sourcedId>

         <ims:courseOfferingRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_Offering</ims:sourcedId>

            </ims:sourcedGUID>

            <ims:courseOffering>

               <ims:title>

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

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

               </ims:title>

               <ims:parentTemplateId>Demo_Template</ims:parentTemplateId>

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

               </ims:org>

               <!--Zero or more repetitions:-->

               <ims:timeFrame>

                  <!--Optional:-->

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

                  <!--Optional:-->

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

               </ims:timeFrame>

            </ims:courseOffering>

         </ims:courseOfferingRecord>

      </ims:replaceCourseOfferingRequest>

   </soapenv:Body>

</soapenv:Envelope>

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

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é	Correspondance de requête IS	Requise
Code	courseOfferingRecord.sourcedGUID.sourcedId	Oui
Nom	courseOfferingRecord.courseOffering.title.textString	Oui
ID de modèle primaire	courseOfferingRecord.courseOffering.parentTemplateId	Oui
Parent SemesterId	courseOfferingRecord.courseOffering.academicSession.textString	Non
Id du département primaire	courseOfferingRecord.courseOffering.org.orgName.textString	Non
Date de début	courseOfferingRecord.courseOffering.timeframe(0).begin	Non
Date de fin	request.courseOffering.timeFrame(0).end	Non
État	courseOfferingRecord.courseOffering.status	Non

Exemple de réponse replaceCourseOffering

<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_replaceCourseOffering_20120113T180550_5936594Z</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 replaceCourseOffering

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 readCourseOffering

readCourseOffering est l’opération utilisée pour lire l’information de la plateforme IPSIS relative aux offres de cours LIS.

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

LIS XML Element	D2L Data	Requise
readCourseOfferingRequest.sourcedId	OrgUnitCode	Oui

Exemple de requête de replaceCourseOffering

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

			<ims:sourcedId>Demo_Offering</ims:sourcedId>

		</ims:readCourseOfferingRequest>

	</soapenv:Body>

</soapenv:Envelope>

Exemple de réponse readCourseOffering

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

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

         <courseOfferingRecord>

            <sourcedGUID>

               <sourcedId<Demo_Offering</sourcedId>

           </sourcedGUID>

            <courseOffering/>

         </courseOfferingRecord>

      </readCourseOfferingResponse>

   </s:Body>

</s:Envelope>