Documentação de integrações

Serviço de gestão de oferta de curso (COMS)

Esse serviço é usado para afetar as Ofertas de curso da D2L.

Operações implementadas

deleteCourseOffering
replaceCourseOffering
readCourseOffering

Sobre a operação deleteCourseOffering

deleteCourseOffering é a operação usada para excluir Unidades organizacionais da D2L associadas a Ofertas de curso do LIS.

Fluxo do processo: deleteCourseOffering

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

Amostra da solicitação deleteCourseOffering

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

         <ims:sourcedId>Demo_Course_Offering</ims:sourcedId>

      </ims:deleteCourseOfferingRequest>

   </soapenv:Body>

</soapenv:Envelope>

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

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

Amostra de deleteCourseOfferingResponse

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

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 replaceCourseOffering

replaceCourseOffering é a operação usada para criar ou atualizar ofertas de curso do Brightspace.

Ao usar as configurações padrão, em caso de sucesso, você poderá validar que as ofertas do curso foram criadas ou atualizadas conforme apropriado por meio do Navegador de variável de configuração do Brightspace, de Gerenciar cursos ou do widget Meus cursos.

Fluxo do processo: replaceCourseOffering

Quando uma solicitação do LIS replaceCourseOffering é recebida, ela é traduzida usando os tradutores do LIS configurados para ITranslateCourseOffering, que transformam 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 IReplaceCourseOfferingHandler são usados para processar a solicitação.
Uma resposta do LIS é gerada a partir da resposta do manipulador para concluir o processo.

Amostra da solicitação replaceCourseOffering

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

         <!--Not Used by D2L-->

         <ims:sourcedId>Demo_Offering</ims:sourcedId>

         <ims:courseOfferingRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_Offering</ims:sourcedId>

            </ims:sourcedGUID>

            <ims:courseOffering>

               <ims:title>

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

                  <ims:textString>Demo Offering</ims:textString>

               </ims:title>

               <ims:parentTemplateId>Demo_Template</ims:parentTemplateId>

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

               </ims:org>

               <!--Zero or more repetitions:-->

               <ims:timeFrame>

                  <!--Optional:-->

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

                  <!--Optional:-->

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

               </ims:timeFrame>

            </ims:courseOffering>

         </ims:courseOfferingRecord>

      </ims:replaceCourseOfferingRequest>

   </soapenv:Body>

</soapenv:Envelope>

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

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 IS	Obrigatório
Código	courseOfferingRecord.sourcedGUID.sourcedId	Sim
Nome	courseOfferingRecord.courseOffering.title.textString	Sim
TemplateId principal	courseOfferingRecord.courseOffering.parentTemplateId	Sim
SemesterId principal	courseOfferingRecord.courseOffering.academicSession.textString	Não
DepartmentId principal	courseOfferingRecord.courseOffering.org.orgName.textString	Não
Data de início	courseOfferingRecord.courseOffering.timeframe(0).begin	Não
Data final	courseOfferingRecord.courseOffering.timeframe(0).end	Não
Status	courseOfferingRecord.courseOffering.status	Não

Amostra da resposta replaceCourseOffering

<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_replaceCourseOffering_20120113T180550_5936594Z</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 replaceCourseOffering

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 readCourseOffering

readCourseOffering é a operação usada para ler informações da Plataforma IPSIS sobre ofertas de curso do LIS.

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

Elemento LIS XML	Dados D2L	Obrigatório
readCourseOfferingRequest.sourcedId	OrgUnitCode	Sim

Exemplo de solicitação readCourseOffering

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

			<ims:sourcedId>Demo_Offering</ims:sourcedId>

		</ims:readCourseOfferingRequest>

	</soapenv:Body>

</soapenv:Envelope>

Amostra da resposta readCourseOffering

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

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

         <courseOfferingRecord>

            <sourcedGUID>

               <sourcedId<Demo_Offering</sourcedId>

           </sourcedGUID>

            <courseOffering/>

         </courseOfferingRecord>

      </readCourseOfferingResponse>

   </s:Body>

</s:Envelope>