Documentación de integraciones

El Servicio de gestión de membresías (MMS)

Este servicio se utiliza para afectar a las inscripciones de Brightspace.

Operaciones implementadas

deleteMembership
replaceMembership
readMembership

Acerca de la operación deleteMembership

deleteMembership es la operación que se usa para eliminar las inscripciones en Brightspace. Las inscripciones son la relación entre los usuarios y las unidades de organización, y pueden verificarse o investigarse en Administrar usuarios o en el Listado de alumnos de un curso en particular.

Flujo de proceso: deleteMembership

Cuando se recibe una solicitud deleteMembership del LIS, el adaptador obtiene el ID único de la membresía en el campo sourcedId de la solicitud directamente, sin el uso de un traductor conectable.
Una vez que se obtiene el ID de membresía, los controladores de la Plataforma del IPSIS configurados para IDeleteEnrollmentHandler procesan la solicitud.
La respuesta del LIS se genera desde la respuesta del controlador.

Solicitud deleteMembership de muestra

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

Encabezado de solicitud deleteMembership y campos del cuerpo

Campos del encabezado de la solicitud

Para obtener más información, consulte el tema Uso de los servicios LIS v2.0 > Encabezados de solicitud y respuesta.

Campos del cuerpo de la solicitud

El adaptador acepta los siguientes campos en la solicitud:

Propiedad	Esquema de solicitud del LIS	Obligatorio
Código	deleteMembershipRequest.sourcedId	Sí

Respuesta deleteMembership de muestra

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

Encabezado de respuesta deleteMembership y campos del cuerpo

Campos del encabezado de respuesta

Para obtener más información, consulte el tema Uso de los Servicios de LIS v2.0 > Encabezados de solicitud y respuesta.

Campos del cuerpo de respuesta

No se devuelven campos en el cuerpo de la respuesta.

Acerca de la operación replaceMembership

ReplaceMembership es la operación que se usa para crear o actualizar las inscripciones en Brightspace. Las inscripciones son la relación entre los usuarios y las unidades de organización, y pueden verificarse o investigarse en Administrar usuarios o en el Listado de alumnos de un curso en particular.

Flujo de proceso: replaceMembership

Cuando se recibe una solicitud replaceMembership del LIS, Brightspace traduce la solicitud con los traductores del LIS configurados para ITranslateMembership para transformar la solicitud en un formato que la plataforma del IPSIS puede comprender.
Una vez que la solicitud se ha traducido, los controladores de la Plataforma del IPSIS configurados para IReplaceEnrollmentHandler se utilizan para procesar la solicitud.
Se genera una respuesta del LIS desde la respuesta del controlador.

Solicitud replaceMembership de muestra

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

Encabezado de solicitud replaceMembership y campos del cuerpo

Campos del encabezado de la solicitud

Para obtener más información, consulte el tema Uso de los servicios LIS v2.0 > Encabezados de solicitud y respuesta.

Campos del cuerpo de la solicitud

La configuración del traductor de plantillas acepta los siguientes campos en la solicitud:

Propiedad	Esquema de solicitud del LIS	Obligatorio
ID de mensaje de inscripción	membershipRecord.sourcedGUID.sourcedId	Sí
Código de sección	membershipRecord.membership.collectionSourcedId	Sí
UserId	membershipRecord.membership.member.personSourcedId	Sí
Rol	membershipRecord.membership.member.role{*}.roleType	Sí
Estado de inscripción	membershipRecord.membership.member.role{*}.status	Sí

Respuesta replaceMembership de muestra

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

Encabezado de respuesta replaceMembership y campos del cuerpo

Campos del encabezado de respuesta

Para obtener más información, consulte el tema Uso de los Servicios de LIS v2.0 > Encabezados de solicitud y respuesta.

Campos del cuerpo de respuesta

No se devuelven campos en el cuerpo de la respuesta.

Solicitud readMembership de muestra

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

Respuesta readMembership de muestra

<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>Estudiante</ims:roleType></ims:role>

           </ims:member>

         </ims:membership>

     </ims:membershipRecord>

   </s:Body>

</s:Envelope>