Documentación de integraciones

El Servicio de gestión de oferta de cursos (COMS)

Este servicio se utiliza para afectar a las ofertas de cursos de D2L.

Operaciones implementadas

deleteCourseOffering
replaceCourseOffering
readCourseOffering

Acerca de la operación deleteCourseOffering

deleteCourseOffering es la operación que se usa para eliminar unidades de organización de D2L asociadas con las ofertas de cursos del LIS.

Flujo de proceso: deleteCourseOffering

Cuando se recibe una solicitud deleteCourseOffering del LIS, el adaptador obtiene el ID único de la Oferta de cursos en el campo sourcedId de la solicitud directamente, sin el uso de un traductor conectable.
Una vez que se obtiene el ID de la Oferta de cursos, los controladores de la Plataforma del IPSIS configurados para IDeleteCourseOfferingHandler se utilizan para procesar la solicitud.
La respuesta del LIS se genera desde la respuesta del controlador para completar el proceso.

Solicitud deleteCourseOffering de muestra

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

Encabezado de solicitud deleteCourseOffering y campos del cuerpo

Campos del encabezado de la solicitud

Para obtener más información, consulte el tema Uso de los servicios LIS v2.0 > Encabezados de solicitud y respuesta.

Campos del cuerpo de la solicitud

El adaptador acepta los siguientes campos en la solicitud:

Propiedad	Esquema de solicitud del LIS	Obligatorio
Código	deleteCourseOfferingRequest.sourcedId	Sí

Respuesta deleteCourseOfferingResponse de muestra

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

Encabezado de respuesta deleteCourseOffering y campos del cuerpo

Campos del encabezado de respuesta

Para obtener más información, consulte el tema Uso de los servicios LIS v2.0 > Encabezados de solicitud y respuesta.

Campos del cuerpo de respuesta

No se devuelven campos en el cuerpo de la respuesta.

Acerca de la operación replaceCourseOffering

replaceCourseOffering es la operación que se usa para crear o actualizar las Ofertas de cursos de Brightspace.

Cuando se utilizan las configuraciones predeterminadas, después de realizar la operación correctamente, puede validar que las ofertas de cursos se han creado o actualizado según corresponde mediante el DOME en Brightspace, Administrar cursos o el componente Mis cursos.

Flujo de proceso: replaceCourseOffering

Cuando se recibe una solicitud replaceCourseOffering del LIS, la solicitud se traduce con los traductores del LIS configurados para ITranslateCourseOffering a fin de transformar la solicitud en un formato que la plataforma del IPSIS pueda comprender.
Una vez que la solicitud se ha traducido, los controladores de la Plataforma del IPSIS configurados para IReplaceCourseOfferingHandler se utilizan para procesar la solicitud.
Se genera una respuesta LIS desde la respuesta del controlador para completar el proceso.

Solicitud replaceCourseOfferingde muestra

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

Encabezado de solicitud replaceCourseOffering y campos del cuerpo

Campos del encabezado de la solicitud

Para obtener más información, consulte el tema Uso de los servicios LIS v2.0 > Encabezados de solicitud y respuesta.

Campos del cuerpo de la solicitud

La configuración del traductor de plantillas acepta los siguientes campos en la solicitud:

Propiedad	Asignación de solicitud de IS	Obligatorio
Código	courseOfferingRecord.sourcedGUID.sourcedId	Sí
Nombre	courseOfferingRecord.courseOffering.title.textString	Sí
TemplateId principal	courseOfferingRecord.courseOffering.parentTemplateId	Sí
ID del semestre principal	courseOfferingRecord.courseOffering.academicSession.textString	No
ID del departamento principal	courseOfferingRecord.courseOffering.org.orgName.textString	No
Fecha de inicio	courseOfferingRecord.courseOffering.timeframe(0).begin	No
Fecha final	courseOfferingRecord.courseOffering.timeframe(0).end	No
Estado	courseOfferingRecord.courseOffering.status	No

Respuesta replaceCourseOffering de muestra

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

Encabezado de respuesta replaceCourseOffering y campos del cuerpo

Campos del encabezado de respuesta

Para obtener más información, consulte el tema Uso de los servicios LIS v2.0 > Encabezados de solicitud y respuesta.

Campos del cuerpo de respuesta

No se devuelven campos en el cuerpo de la respuesta.

Acerca de readCourseOffering

readCourseOffering es la operación que se utiliza para leer la información de la plataforma del IPSIS sobre las ofertas de cursos de LIS.

El adaptador LIS 2.0 acepta los siguientes campos en la solicitud:

Elemento XML de LIS	Datos de D2L	Obligatorio
readCourseOfferingRequest.sourcedId	OrgUnitCode	Sí

Solicitud readCourseOffering de muestra

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

Respuesta readCourseOffering de muestra

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