Documentação de integrações

Serviço de gestão de grupo (GMS)

Esse serviço é usado para afetar OrgUnits do Brightspace que não sejam modelos, ofertas e seções. Isso inclui departamentos, semestres e tipos de unidades organizacionais personalizados.

Operações implementadas

deleteGroup
replaceGroup
readGroup

Sobre a operação deleteGroup

deleteGroup é a operação usada para excluir unidades organizacionais do Brightspace, como departamentos e semestres.

Você usa deleteCourseTemplate para modelos de curso, deleteCourseOffering para ofertas de curso e deleteCourseSection para seções de curso.

Processar a operação deleteGroup

A implementação de deleteGroup usa uma das três interfaces de manipulador do IPSIS, dependendo do tipo de grupo que está sendo pesquisado.

IDeleteDepartmentHandler - para as unidades organizacionais com um tipo de unidade org padrão do Departamento.
IDeleteOtherOrgUnitHandler - para as unidades organizacionais que não têm um tipo de unidade org padrão de Departamento, Semestre, CourseTemplate, CourseOffering, Seção ou Grupo.
IDeleteSemesterHandler - para as unidades organizacionais com um tipo de unidade org padrão de Semestre.

Amostra da solicitação deleteGroup

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

Campos de cabeçalho e corpo da solicitação deleteGroup

Campos de cabeçalho da solicitação

Para mais informações, acesse Usar Serviços do LIS v2.0 > Cabeçalhos de solicitação e resposta.

Campos de corpo da solicitação

Campo	Observação	Obrigatório
deleteGroupRequest.sourcedId	Esse campo deve ter um valor para comunicar o identificador exclusivo do grupo que você está tentando excluir.	Sim

Amostra da resposta deleteGroup

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

Campos de cabeçalho e corpo da resposta deleteGroup

Campos de cabeçalho da resposta

Para mais informações, acesse Usar Serviços do LIS v2.0 > Cabeçalhos de solicitação e resposta.

Campos de corpo da resposta

Nenhum campo é retornado no corpo da resposta.

Sobre a operação replaceGroup

replaceGroup é a operação usada para criar ou atualizar unidades organizacionais do Brightspace, como departamentos e semestres.

Você deve usar replaceCourseTemplate para modelos de curso, replaceCourseOffering para ofertas de curso ou replaceCourseSection para seções de curso.

Ao usar as configurações padrão, em caso de sucesso, você poderá validar que o grupo foi criado ou atualizado conforme apropriado por meio do Navegador de variáveis de configuração do Brightspace.

Fluxo do processo: replaceGroup

Quando uma solicitação do LIS replaceGroup é recebida, o Brightspace traduz a solicitação usando os tradutores do LIS configurados para ITranslateGroup, para transformar a solicitação em um formato que a Plataforma IPSIS possa entender.
Uma vez que a solicitação foi traduzida, o GroupType é usado para determinar quais manipuladores da Plataforma IPSIS são chamados.
- Se o GroupType estiver associado com o tipo de OrgUnit padrão de Departamento, os manipuladores configurados para IReplaceDepartmentHandler serão usados para processar a solicitação.
- Se o GroupType estiver associado com o tipo de OrgUnit padrão de Semestre, os manipuladores configurados para IReplaceSemesterHandler serão usados para processar a solicitação.
- Se o GroupType for qualquer outro, os manipuladores configurados para IReplaceOrgUnitHandler serão usados para processar a solicitação.
Uma resposta do LIS é gerada a partir da resposta do manipulador.

Amostra da solicitação replaceGroup

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

Campos de cabeçalho e corpo da solicitação replaceGroup

Campos de cabeçalho da solicitação

Para mais informações, acesse Usar Serviços do LIS v2.0 > Cabeçalhos de solicitação e resposta.

Campos de corpo da solicitação

A configuração do tradutor do modelo aceita os seguintes campos na solicitação:

Propriedade	Mapeamento da solicitação do LIS	Obrigatório
Código	groupRecord.sourcedGUID.sourcedId	Sim
Nome	groupRecord.group.description.shortDescription	Sim
Tipo	groupRecord.group.groupType.typeValue(0).id	Sim

Amostra da resposta replaceGroup

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

Campos de cabeçalho e corpo da resposta replaceGroup

Campos de cabeçalho da resposta

Para mais informações, acesse Usar Serviços do LIS v2.0 > Cabeçalhos de solicitação e resposta.

Campos de corpo da resposta

Nenhum campo é retornado no corpo da resposta.

Amostra da solicitação readGroup

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

Amostra da resposta readGroup

<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>Department</id>

                 </typevalue>

              </groupType>

              <description>

                 <shortDescription>LIS Test Department</shortDescription>

              </description>

            </group>

         </groupRecord>

      </readGroupResponse>

   </s:Body>

</s:Envelope>