توثيق التكامل

خدمة إدارة العضوية (MMS)

تُستخدم هذه الخدمة للتأثير في تسجيلات Brightspace.

العمليات المنفذة

deleteMembership
replaceMembership
readMembership

لمحة عن عملية deleteMembership

deleteMembership هي العملية المستخدمة لحذف التسجيلات في Brightspace. تمثل التسجيلات العلاقة بين المستخدمين والوحدات التنظيمية، ويمكن التحقق منها أو التحقيق فيها من "إدارة المستخدمين" أو من "قائمة الصفوف" لمقرر تعليمي محدد.

سير العملية: deleteMembership

عند تلقي طلب deleteMembership لـ LIS، يحصل المحول على المعرِّف الفريد للعضوية من حقل sourcedId للطلب مباشرةً، من دون استخدام مترجم قابل للتوصيل.
بمجرد الحصول على معرِّف العضوية، تقوم معالجات منصة حزمة التكامل لأنظمة معلومات الطالب التي تم تكوينها لـ IDeleteEnrollmentHandler بمعالجة الطلب.
يتم إنشاء استجابة LIS من استجابة المعالج.

نموذج طلب 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>

حقول الرأس والنص الأساسي في طلب deleteMembership

حقول رأس الطلب

لمزيد من المعلومات، راجع موضوع استخدام خدمات LIS الإصدار 2.0 > رؤوس الطلب والاستجابة.

حقول النص الأساسي للطلب

يقبل المحول الحقول الآتية في الطلب:

الخاصية	تعيين طلب LIS	مطلوب
الكود	deleteMembershipRequest.sourcedId	نعم

نموذج استجابة 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>

حقول الرأس والنص الأساسي في استجابة deleteMembership

حقول رأس الاستجابة

لمزيد من المعلومات، راجع موضوع استخدام خدمات LIS الإصدار 2.0 > رؤوس الطلب والاستجابة.

حقول النص الأساسي للاستجابة

لا يتم إرجاع أي حقول في النص الأساسي للاستجابة.

لمحة عن عملية replaceMembership

إن ReplaceMembership هي العملية المستخدمة لإنشاء التسجيلات في Brightspace أو تحديثها. تمثل التسجيلات العلاقة بين المستخدمين والوحدات التنظيمية، ويمكن التحقق منها أو التحقيق فيها من "إدارة المستخدمين" أو من "قائمة الصفوف" لمقرر تعليمي محدد.

سير العملية: replaceMembership

عند تلقي طلب replaceMembership لـ LIS، تترجم Brightspace الطلب باستخدام مترجمي LIS الذين تم تكوينهم لـ ITranslateMembership لتحويل الطلب إلى تنسيق يمكن لمنصة حزمة التكامل لأنظمة معلومات الطالب فهمه.
بمجرد ترجمة الطلب، تقوم معالجات منصة حزمة التكامل لأنظمة معلومات الطالب التي تم تكوينها لـ IReplaceEnrollmentHandler بمعالجة الطلب.
يتم إنشاء استجابة LIS من استجابة المعالج.

نموذج طلب 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>

حقول الرأس والنص الأساسي في طلب replaceMembership

حقول رأس الطلب

لمزيد من المعلومات، راجع موضوع استخدام خدمات LIS الإصدار 2.0 > رؤوس الطلب والاستجابة.

حقول النص الأساسي للطلب

يقبل تكوين مترجم القالب الحقول الآتية في الطلب:

الخاصية	تعيين طلب LIS	مطلوب
معرِّف رسالة التسجيل	membershipRecord.sourcedGUID.sourcedId	نعم
كود المقطع	membershipRecord.membership.collectionSourcedId	نعم
UserId	membershipRecord.membership.member.personSourcedId	نعم
دور	membershipRecord.membership.member.role{*}.roleType	نعم
حالة التسجيل	membershipRecord.membership.member.role{*}.status	نعم

نموذج استجابة 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>

حقول الرأس والنص الأساسي في استجابة replaceMembership

حقول رأس الاستجابة

لمزيد من المعلومات، راجع موضوع استخدام خدمات LIS الإصدار 2.0 > رؤوس الطلب والاستجابة.

حقول النص الأساسي للاستجابة

لا يتم إرجاع أي حقول في النص الأساسي للاستجابة.

نموذج طلب 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>

نموذج استجابة 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>