Documentación de integraciones

El Servicio de gestión de sección de cursos (CSMS)

Este servicio se utiliza para afectar a las secciones del curso de Brightspace.

Operaciones implementadas

deleteCourseSection
replaceCourseSection
readCourseSection

Acerca de la operación deleteCourseSection

deleteCourseSection es la operación que se usa para eliminar Unidades de organización de Brightspace asociadas con las Secciones de cursos de LIS.

Flujo de proceso: deleteCourseSection

Cuando se recibe una solicitud deleteCourseSection del LIS, el adaptador obtiene el ID único de la sección del curso en el campo sourcedId de la solicitud directamente, sin el uso de un traductor conectable.
Una vez que se obtiene el ID de la Sección de cursos, los controladores de la Plataforma del IPSIS configurados para IDeleteCourseSectionHandler se utilizan para procesar la solicitud.
La respuesta del LIS se genera desde la respuesta del controlador.

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

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

      </ims:deleteCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

Encabezado de solicitud deleteCourseSection 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

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

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

Encabezado de respuesta deleteCourseSection 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 las operaciones replaceCourseSection

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

Cuando se utilizan las configuraciones predeterminadas, después de realizar la operación correctamente, puede validar que el grupo se ha creado o actualizado según corresponde mediante el DOME en Brightspace o a través de la herramienta Grupos o Secciones en el curso (según la configuración del controlador).

Flujo de proceso: replaceCourseSection

Cuando se recibe una solicitud replaceCourseSection del LIS, Brightspace traduce la solicitud con los traductores del LIS configurados para ITranslateCourseSection para transformar la solicitud en un formato que la plataforma del IPSIS puede comprender.
Los controladores de la Plataforma del IPSIS configurados para IReplaceCourseSectionHandler se utilizan para procesar la solicitud.
Se genera una respuesta del LIS desde la respuesta del controlador.

Solicitud replaceCourseSection 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: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>

Encabezado de solicitud replaceCourseSection 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	Esquema de solicitud del LIS	Obligatorio
Código	sourcedGUID.sourcedId	Sí
Nombre	courseSection.title.textString	Sí
ID de oferta principal	courseSection.parentOfferingId	Sí
ID del departamento principal	courseSection.org.orgName	Sí
ID del semestre principal	courseSection.academicSession.textString	No
Fecha de inicio	courseSection.timeFrame(0).begin	Sí
Fecha final	courseSection.timeFrame(0).end	Sí
Estado	courseSection.status	No

Respuesta replaceCourseSection 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_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>

Encabezado de respuesta replaceCourseSection 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.

Solicitud readCourseSection 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:readCourseSectionRequest>

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

      </ims:readCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

Respuesta readCourseSection 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_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>