Documentação de integrações

Serviço de gestão de seção de curso (CSMS)

Esse serviço é usado para afetar as seções (ou grupos) de curso do Brightspace.

Operações implementadas

deleteCourseSection
replaceCourseSection
readCourseSection

Sobre a operação deleteCourseSection

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

Fluxo do processo: deleteCourseSection

Quando uma solicitação LIS deleteCourseSection é recebida, o adaptador obtém o ID exclusivo para a seção de curso do campo sourcedId da solicitação diretamente, sem o usuário de um tradutor plugável.
Uma vez que o ID da Seção de curso for obtido, os manipuladores de plataforma IPSIS configurados para IDeleteCourseSectionHandler são usados para processar a solicitação.
A resposta do LIS é gerada a partir da resposta do manipulador.

Amostra da solicitação deleteCourseSection

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

         <ims:sourcedId>LIS_Section_01</ims:sourcedId>

      </ims:deleteCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

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

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

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

Amostra da resposta deleteCourseSection

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

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 as operações replaceCourseSection

replaceCourseSection é a operação usada para criar ou atualizar seções ou grupos de curso do Brightspace.

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 DOME do Brightspace ou da ferramenta Grupos ou Seções no curso (dependendo da configuração do manipulador).

Fluxo do processo: replaceCourseSection

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

Amostra da solicitação replaceCourseSection

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

         <!--Not Used by D2L-->

         <ims:sourcedId>Demo_Section_01</ims:sourcedId>

         <ims:courseSectionRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_Section_01</ims:sourcedId>

            </ims:sourcedGUID>

            <ims:courseSection>

               <ims:title>

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

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

               </ims:title>

               <ims:parentOfferingId>Demo_Offering</ims:parentOfferingId>

               <!--Optional:-->

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

               <!--Optional:-->

               <ims:academicSession>

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

                  <ims:textString>Demo_Semester</ims:textString>

               </ims:academicSession>

               <!--Optional:-->

               <ims:org>

                  <!--Optional:-->

                  <ims:orgName>

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

                     <ims:textString>Demo_Department</ims:textString>

                  </ims:orgName>

               &lt:/ims:org>

               <ims:timeFrame>

                  <ims:begin>2012-01-01T00:00:00.000000</ims:begin>

                  <ims:end>2012-04-01T00:00:00.000000</ims:end>

               </ims:timeFrame>

            </ims:courseSection>

         </ims:courseSectionRecord>

      </ims:replaceCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

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

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	sourcedGUID.sourcedId	Sim
Nome	courseSection.title.textString	Sim
OfferingId principal	courseSection.parentOfferingId	Sim
DepartmentId principal	courseSection.org.orgName	Sim
SemesterId principal	courseSection.academicSession.textString	Não
Data de início	courseSection.timeFrame(0).begin	Sim
Data final	courseSection.timeFrame(0).end	Sim
Status	courseSection.status	Não

Amostra da resposta replaceCourseSection

<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_replaceCourseSection_20120130T160616_8347289Z</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 replaceCourseSection

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 readCourseSection

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

         <ims:sourcedId<Demo_Section</ims:sourcedId>

      </ims:readCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

Amostra da resposta readCourseSection

<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_messageIdentifier>CMS_readCourseSection_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">

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

        <courseSectionRecord>

           <sourcedGUID>

               <sourcedId>Demo_Section</sourcedId>

           </sourcedGUID>

            <courseSection/>

        </courseSectionRecord>

      </readCourseSectionResponse>

   </s:Body>

</s:Envelope>