Documentación de integraciones

El Servicio de gestión de grupos (GMS)

Este servicio se utiliza para afectar las Unidades de organización de Brightspace distintas de las plantillas, las ofertas y las secciones. Esto incluye departamentos, semestres y los tipos de unidad de organización personalizados.

Implementar operaciones

deleteGroup
replaceGroup
readGroup

Acerca de la operación deleteGroup

deleteGroup es la operación que se usa para eliminar las unidades de organización de Brightspace tales como departamentos y semestres.

Se utiliza deleteCourseTemplate para las plantillas del curso, deleteCourseOffering para las ofertas de cursos y deleteCourseSection para las secciones del curso.

Procesamiento de la operación deleteGroup

La implementación deleteGroup usa una de las tres interfaces del controlador del IPSIS dependiendo del tipo de grupo que va a buscar.

IDeleteDepartmentHandler: para las unidades de organización con un tipo de unidad de organización estándar de Departamento.
IDeleteOtherOrgUnitHandler: para las unidades de organización que no tienen un tipo de unidad de organización estándar de Departamento, Semestre, Plantilla de cursos, Oferta de cursos, Sección o Grupo.
IDeleteSemesterHandler: para las unidades de organización con un tipo de unidad de organización estándar de Semestre.

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

         <!--Optional:-->

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

         <!--Optional:-->

         <ims:imsx_messageIdentifier>1234</ims:imsx_messageIdentifier>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:deleteGroupRequest>

         <ims:sourcedId>LIS_Test_Department</ims:sourcedId>

      </ims:deleteGroupRequest>

   </soapenv:Body>

</soapenv:Envelope>

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

Campo	Nota	Obligatorio
deleteGroupRequest.sourcedId	Este campo debe tener un valor para comunicar el identificador único del grupo que está intentando eliminar.	Sí

Respuesta deleteGroup 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>GMS_deleteGroup_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 deleteGroup 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 replaceGroup

replaceGroup es la operación que se usa para crear o actualizar las unidades de organización de Brightspace tales como departamentos y semestres.

Debe utilizar replaceCourseTemplate para las plantillas del curso, replaceCourseOffering para las ofertas de cursos o replaceCourseSection para las secciones del curso.

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

Flujo de proceso: replaceGroup

Cuando se recibe una solicitud de replaceGroup del LIS, Brightspace traduce la solicitud con los traductores del LIS configurados para ITranslateGroup para transformar la solicitud en un formato que la plataforma del IPSIS puede comprender.
Una vez que la solicitud se ha traducido, el GroupType se utiliza para determinar qué controladores de la Plataforma del IPSIS se invocan.
- Si el GroupType está asociado con el Tipo de unidad de organización estándar de departamento, los controladores configurados para IReplaceDepartmentHandler se usan para procesar la solicitud.
- Si el GroupType está asociado con el Tipo de unidad de organización estándar de semestre, los controladores configurados para IReplaceSemesterHandler se usan para procesar la solicitud.
- Si el GroupType es otro elemento, los controladores configurados para IReplaceOrgUnitHandler se usan para procesar la solicitud.
Se genera una respuesta del LIS desde la respuesta del controlador.

Solicitud replaceGroup 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:replaceGroupRequest>

            <!--Not Used by D2L-->

          <ims:sourcedId>Demo_Semester</ims:sourcedId>

            <ims:groupRecord>

               <ims:sourcedGUID>

                  <ims:sourcedId>Demo_Semester</ims:sourcedId>

               </ims:sourcedGUID>

               <ims:group>

                  <ims:groupType>

                     <!--Not Used by D2L-->

                     <ims:scheme>

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

                        <ims:textString>D2L</ims:textString>

                     </ims:scheme>

                     <ims:typevalue>

                        <ims:id>

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

                           <ims:textString>Semester</ims:textString>

                        </ims:id>

                        <!--Not Used by D2L-->

                        <ims:type>

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

                           <ims:textString>Semester</ims:textString>

                        </ims:type>

                        <!--Not Used by D2L-->

                        <ims:level>

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

                           <ims:textString>1</ims:textString>

                        </ims:level>

                     </ims:typevalue>

                  </ims:groupType>

                  <ims:description>

                     <ims:shortDescription>Demo Semester</ims:shortDescription>

                  </ims:description>

               </ims:group>

            </ims:groupRecord>

         </ims:replaceGroupRequest>

     </soapenv:Body>

  </soapenv:Envelope>

Encabezado de solicitud replaceGroup 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	groupRecord.sourcedGUID.sourcedId	Sí
Nombre	groupRecord.group.description.shortDescription	Sí
Tipo	groupRecord.group.groupType.typeValue(0).id	Sí

Respuesta replaceGroup 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>GMS_replaceGroup_20120104T232428_1383886Z</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 replaceGroup 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 readGroup 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:readGroupRequest>

         <ims:sourcedId>LIS_Test_Department</ims:sourcedId>

      </ims:readGroupRequest>

   </soapenv:Body>

</soapenv:Envelope>

Respuesta readGroup 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>GMS_readGroup_20120104T231937_2063886Z</imsx_messageIdentifier>

         <imsx_statusInfo>

           <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>warning</imsx_severity>

           <imsx_messageRefIdentifier>1234</imsx_messageRefIdentifier>

           <imsx_description>GMS.readGroup</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">

     <readGroupResponse xmlns="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0">

        <groupRecord>

           <sourcedGUID>

               <sourcedId>LIS_Test_Department</sourcedId>

           </sourcedGUID>

           <group>

              <groupType>

                 <typevalue>

                    <id>Departamento</id>

                 </typevalue>

              </groupType>

              <description>

                 <shortDescription>Departamento de pruebas del LIS</shortDescription>

              </description>

            </group>

         </groupRecord>

      </readGroupResponse>

   </s:Body>

</s:Envelope>