Documentação de integrações

Serviço de gestão de associação de seção (SAMS)

Esse serviço é usado para afetar as associações entre as Seções do SIS e Ofertas de curso do Brightspace.

Operações implementadas

deleteSectionAssociation
replaceSectionAssociation
readSectionAssociation

Sobre a operação deleteSectionAssociation

A operação deleteSectionAssociation é usada para excluir unidades organizacionais do Brightspace associadas a Associações de seção do LIS.

Fluxo do processo: deleteSectionAssociation

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

Amostra da solicitação deleteSectionAssociation

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

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

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	deleteSectionAssociationRequest.sourcedId	Sim

Amostra da resposta deleteSectionAssociation

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

Campos de cabeçalho e corpo da resposta de deleteSectionAssociation

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 replaceSectionAssociation

A operação replaceSectionAssociation é usada para criar ou atualizar ofertas de cursos do Brightspace associadas a seções/grupos com base em solicitações de Associação de seção do LIS.

Ao usar as configurações padrão, em caso de sucesso, você poderá validar a associação de seção criada ou atualizada usando o DOME em Gerenciar cursos do Brightspace ou no widget Meus cursos.

Fluxo do processo: replaceSectionAssociation

Quando uma solicitação do LIS replaceSectionAssociation é recebida, o Brightspace traduz a solicitação usando os tradutores do LIS configurados para ITranslateSectionAssociation, 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 IReplaceSectionAssociationHandler são usados para processar a solicitação.
Uma resposta do LIS é gerada a partir da resposta do manipulador.

Observação: Se ReplaceSectionAssociationDatesFromAllSectionsHandler estiver configurado (configurado automaticamente para LIS 2.0), a data de início mais antiga e a data final mais recente serão usadas para o curso.

Amostra da solicitação replaceSectionAssociation

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

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

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 da associação de seção	sectionAssociationRecord.sourcedGUID.sourcedId	Sim
Nome da associação de seção	sectionAssociationRecord.sourcedGUID.sourcedId	Sim
Nome da associação de seção	sectionAssociationRecord.sectionAssociation.title.textString	Não
Ids de seção	sectionAssociationRecord.sectionAssociation.courseSectionIdList{*}.CourseSectionId	Sim
Status	sectionAssociationRecord.sectionAssociation.status	Não

Amostra da resposta replaceSectionAssociation

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

Campos de cabeçalho e corpo da resposta de replaceSectionAssociation

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 readSectionAssociation

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

Amostra da resposta readSectionAssociation

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