Documentação de integrações

Serviço de gestão de associação (MMS)

Esse serviço é usado para afetar as inscrições do Brightspace.

Operações implementadas

deleteMembership
replaceMembership
readMembership

Sobre a operação deleteMembership

deleteMembership é a operação usada para excluir inscrições no Brightspace. As inscrições são a relação entre usuários e unidades organizacionais e podem ser verificadas ou investigadas em Gerenciar usuários ou na Lista de classe para um determinado curso.

Fluxo do processo: deleteMembership

Quando uma solicitação do LIS deleteMembership é recebida, o adaptador obtém o ID exclusivo para a associação do campo sourcedId da solicitação diretamente, sem o uso de um tradutor plugável.
Uma vez que o ID da associação foi obtido, os manipuladores da plataforma do IPSIS configurados para IDeleteEnrollmentHandler processam a solicitação.
A resposta do LIS é gerada a partir da resposta do manipulador.

Amostra da solicitação deleteMembership

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

     xmlns:ims="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_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:deleteMembershipRequest>

         <ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>

      </ims:deleteMembershipRequest>

   </soapenv:Body>

</soapenv:Envelope>

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

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

O adaptador aceita os seguintes campos na solicitação:

Propriedade	Mapeamento da solicitação do LIS	Obrigatório
Código	deleteMembershipRequest.sourcedId	Sim

Amostra da resposta deleteMembership

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

   <s:Header>

      <h:imsx_syncResponseHeaderInfo

          xmlns:h="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0"

          xmlns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_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>MMS_deleteMembership_20120120T191434_9913552Z</imsx_messageIdentifier>

         <imsx_statusInfo>

            <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>status</imsx_severity>

            <imsx_messageRefIdentifier>1234</imsx_messageRefIdentifier>

            <imsx_description/>

            <imsx_codeMinor*gt;

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

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 replaceMembership

ReplaceMembership é a operação usada para criar ou atualizar inscrições no Brightspace. As inscrições são a relação entre usuários e unidades organizacionais e podem ser verificadas ou investigadas em Gerenciar usuários ou na Lista de classe para um determinado curso.

Fluxo do processo: replaceMembership

Quando uma solicitação do LIS replaceMembership é recebida, o Brightspace traduz a solicitação usando os tradutores do LIS configurados para ITranslateMembership, para transformar a solicitação em um formato que a Plataforma IPSIS possa entender.
Uma vez que a solicitação foi traduzida, os manipuladores de plataforma IPSIS configurados para IReplaceEnrollmentHandler são usados para processar a solicitação.
Uma resposta do LIS é gerada a partir da resposta do manipulador.

Amostra da solicitação replaceMembership

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

   xmlns:ims="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_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:replaceMembershipRequest>

         <!--Not Used by D2L-->

         <ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>

         <ims:membershipRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>

            </ims:sourcedGUID>

            <ims:membership>

               <ims:collectionSourcedId>Demo_Section_01</ims:collectionSourcedId>

               <!--Not Used by D2L-->

               <ims:membershipIdType>courseSection</ims:membershipIdType>

               <ims:member>

                  <ims:personSourcedId>Demo_User</ims:personSourcedId>

                  <ims:role>

                     <ims:roleType>Learner</ims:roleType>

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

                  </ims:role>

               </ims:member>

            </ims:membership>

         </ims:membershipRecord>

      </ims:replaceMembershipRequest>

   </soapenv:Body>

</soapenv:Envelope>

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

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
ID da mensagem da inscrição	membershipRecord.sourcedGUID.sourcedId	Sim
Código da Seção	membershipRecord.membership.collectionSourcedId	Sim
ID do usuário	membershipRecord.membership.member.personSourcedId	Sim
Função	membershipRecord.membership.member.role{*}.roleType	Sim
Status da inscrição	membershipRecord.membership.member.role{*}.status	Sim

Amostra da resposta replaceMembership

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

   <s:Header>

      <h:imsx_syncResponseHeaderInfo

          xmlns:h="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0"

          xmlns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_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>MMS_replaceMembership_20120419T000158_6944880Z</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 replaceMembership

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 readMembership

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

   xmlns:ims="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_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:readMembershipRequest>

         <ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>

      </ims:readMembershipRequest>

   </soapenv:Body>

</soapenv:Envelope>

Amostra da resposta readMembership

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

   <s:Header>

      <h:imsx_syncResponseHeaderInfo

          xmlns:h="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0"

          xmlns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_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>MMS_readMembership_20120419T000158_6944880Z</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">

       <ims:membershipRecord>

         <ims:sourcedGUID>

            <ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>

         </ims:sourcedGUID>

         <ims:membership>

            <ims:collectionSourcedId>F515050A-6A6C-486B-8B46-97BA6FD62458</ims:collectionSourcedId>

            <ims:membershipIdType>83418823-CADC-40A6-885E-C460F78E896F</ims:membershipIdType>

            <ims:member>

               <ims:personSourcedId>967F247A-F65B-41CE-8A33-8B2E1C8AF357</ims:personSourcedId>

              <ims:role><ims:roleType>Learner</ims:roleType></ims:role>

           </ims:member>

         </ims:membership>

     </ims:membershipRecord>

   </s:Body>

</s:Envelope>