Documentación de integraciones

El Servicio de gestión de asociación de sección (SAMS)

Este servicio se utiliza para afectar las asociaciones entre las secciones del SIS y las Ofertas de cursos de Brightspace.

Operaciones implementadas

deleteSectionAssociation
replaceSectionAssociation
readSectionAssociation

Acerca de la operación deleteSectionAssociation

La operación deleteSectionAssociation se utiliza para eliminar las unidades de organización de Brightspace asociadas con las Asociaciones de sección del LIS.

Flujo de proceso: deleteSectionAssociation

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

Solicitud deleteSectionAssociation de muestra

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

         <ims:sourcedId>Demo_Section_Assocation</ims:sourcedId>

      </ims:deleteSectionAssociationRequest>

   </soapenv:Body>

</soapenv:Envelope>

Encabezado de solicitud deleteSectionAssociation 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	deleteSectionAssociationRequest.sourcedId	Sí

Respuesta deleteSectionAssociation 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 deleteSectionAssociation y campos del cuerpo

Campos del encabezado de respuesta

Para obtener más información, consulte el tema Uso de los Servicios de 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 replaceSectionAssociation

La operación replaceSectionAssociation se utiliza para crear o actualizar las ofertas de cursos de Brightspace y las secciones o los grupos asociados en función de las solicitudes de Asociación de sección del LIS.

Cuando se utilizan las configuraciones predeterminadas, después de realizar la operación correctamente, puede validar la asociación de sección que se ha creado o actualizado con el DOME en Brightspace, Administrar cursos o el componente Mis cursos.

Flujo de proceso: replaceSectionAssociation

Cuando se recibe una solicitud replaceSectionAssociation del LIS, Brightspace traduce la solicitud utilizando los traductores del LIS configurados para ITranslateSectionAssociation 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 IReplaceSectionAssociationHandler se utilizan para procesar la solicitud.
Se genera una respuesta del LIS desde la respuesta del controlador.

Nota: Si ReplaceSectionAssociationDatesFromAllSectionHandler está configurado (configurado de forma automática para LIS 2.0), entonces se usa la fecha de inicio más antigua y la fecha final más reciente del curso.

Solicitud replaceSectionAssociation 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:replaceSectionAssociationRequest>

         <!--Not Used by D2L-->

         <ims:sourcedId>Demo_Section_Association</ims:sourcedId>

         <ims:sectionAssociationRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_Section_Association</ims:sourcedId>

            </ims:sourcedGUID>

            <ims:sectionAssociation>

               <!--Optional:-->

               <ims:title>

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

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

               </ims:title>

               <!--Optional:-->

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

               <!--Optional:-->

               <ims:courseSectionIdList>

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

                  <ims:courseSectionId>Demo_Section_01</ims:courseSectionId>

               </ims:courseSectionIdList>

            </ims:sectionAssociation>

         </ims:sectionAssociationRecord>

      </ims:replaceSectionAssociationRequest>

   </soapenv:Body>

</soapenv:Envelope>

Encabezado de solicitud replaceSectionAssociation 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 de asociación de sección	sectionAssociationRecord.sourcedGUID.sourcedId	Sí
Nombre de asociación de sección	sectionAssociationRecord.sourcedGUID.sourcedId	Sí
Nombre de asociación de sección	sectionAssociationRecord.sectionAssociation.title.textString	No
ID de sección	sectionAssociationRecord.sectionAssociation.courseSectionIdList{*}.CourseSectionId	Sí
Estado	sectionAssociationRecord.sectionAssociation.status	No

Respuesta replaceSectionAssociation 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_replaceSectionAssociation_20120419T002302_0384880Z</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 replaceSectionAssociation y campos del cuerpo

Campos del encabezado de respuesta

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

Campos del cuerpo de respuesta

No se devuelven campos en el cuerpo de la respuesta.

Solicitud readSectionAssociation 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:readSectionAssociationRequest>

         <ims:sourcedId>Demo_Section_Association</ims:sourcedId>

      </ims:readSectionAssociationRequest>

   </soapenv:Body>

</soapenv:Envelope>

Respuesta readSectionAssociation 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_readSectionAssociation_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">

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

         <sectionAssociationRecord>

            <sourcedGUID>

               <sourcedId>Demo_Section_Association</sourcedId>

            </sourcedGUID>

            <sectionAssociation/>

         </sectionAssociationRecord>

      </readSectionAssociationResponse>

   </s:Body>

</s:Envelope>