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

خدمة إدارة المجموعات (GMS)

تُستخدم هذه الخدمة للتأثير في OrgUnits في Brightspace بخلاف القوالب والمضامين والمقاطع. ويشمل ذلك الأقسام والفصول الدراسية بالإضافة إلى أنواع الوحدات التنظيمية المخصصة.

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

deleteGroup
replaceGroup
readGroup

لمحة عن عملية deleteGroup

deleteGroup هي العملية المستخدمة لحذف الوحدات التنظيمية في Brightspace مثل الأقسام والفصول الدراسية.

يمكنك استخدام deleteCourseTemplate لقوالب المقررات التعليمية وdeleteCourseOffering لمضامين المقررات التعليمية وdeleteCourseSection لمقاطع المقررات التعليمية.

معالجة عملية deleteGroup

يستخدم تنفيذ deleteGroup واحدة من ثلاث واجهات لمعالج حزمة التكامل لأنظمة معلومات الطالب وفقًا لنوع المجموعة التي يتم البحث عنها.

‏IDeleteDepartmentHandler - للوحدات التنظيمية ذات نوع الوحدة التنظيمية القياسي للقسم.
‏IDeleteOtherOrgUnitHandler - للوحدات التنظيمية التي ليس لها نوع وحدة تنظيمية قياسي للقسم أو الفصل الدراسي أو CourseTemplate أو CourseOffering أو المقطع أو المجموعة.
‏IDeleteSemesterHandler - للوحدات التنظيمية ذات نوع الوحدة التنظيمية القياسي للفصل الدراسي.

نموذج طلب deleteGroup

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

         <!--Optional:-->

         <ims:imsx_version>V1.0</ims:imsx_version>

         <!--Optional:-->

         <ims:imsx_messageIdentifier>1234</ims:imsx_messageIdentifier>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:deleteGroupRequest>

         <ims:sourcedId>LIS_Test_Department</ims:sourcedId>

      </ims:deleteGroupRequest>

   </soapenv:Body>

</soapenv:Envelope>

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

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

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

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

الحقل	ملاحظة	مطلوب
deleteGroupRequest.sourcedId	يجب أن يحتوي هذا الحقل على قيمة للاتصال بالمعرِّف الفريد للمجموعة التي تحاول حذفها.	نعم

نموذج استجابة deleteGroup

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

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

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

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

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

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

لمحة عن عملية replaceGroup

إن replaceGroup هي العملية المستخدمة لإنشاء الوحدات التنظيمية في Brightspace مثل الأقسام والفصول الدراسية أو تحديثها.

ينبغي لك استخدام replaceCourseTemplate لقوالب المقررات التعليمية، أو replaceCourseOffering لمضامين المقررات التعليمية، أو replaceCourseSection لمقاطع المقررات التعليمية.

عند استخدام التكوينات الافتراضية، يمكنك عند النجاح التحقق من أنه قد تم إنشاء المجموعة أو تحديثها كما ينبغي من خلال بيئة الإدارة التنظيمية الخاصة بـ Desire2Learn‏ (DOME) في Brightspace.

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

عند تلقي طلب replaceGroup لـ LIS، تترجم Brightspace الطلب باستخدام مترجمي LIS الذين تم تكوينهم لـ ITranslateGroup لتحويل الطلب إلى تنسيق يمكن لمنصة حزمة التكامل لأنظمة معلومات الطالب فهمه.
بمجرد ترجمة الطلب، تُستخدم GroupType لتحديد معالجات منصة حزمة التكامل لأنظمة معلومات الطالب التي تم استدعاؤها.
- إذا كان GroupType مقترنًا بنوع OrgUnit القياسي للقسم، فستُستخدم المعالجات التي تم تكوينها لـ IReplaceDparmentHandler لمعالجة الطلب.
- إذا كان GroupType مقترنًا بنوع OrgUnit القياسي للفصل الدراسي، فستُستخدم المعالجات التي تم تكوينها لـ IReplaceSemesterHandler لمعالجة الطلب.
- إذا كان GroupType أي شيء آخر، فستُستخدم المعالجات التي تم تكوينها لـ IReplaceOrgUnitHandler لمعالجة الطلب.
يتم إنشاء استجابة LIS من استجابة المعالج.

نموذج طلب replaceGroup

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

            <!--Not Used by D2L-->

          <ims:sourcedId>Demo_Semester</ims:sourcedId>

            <ims:groupRecord>

               <ims:sourcedGUID>

                  <ims:sourcedId>Demo_Semester</ims:sourcedId>

               </ims:sourcedGUID>

               <ims:group>

                  <ims:groupType>

                     <!--Not Used by D2L-->

                     <ims:scheme>

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

                        <ims:textString>D2L</ims:textString>

                     </ims:scheme>

                     <ims:typevalue>

                        <ims:id>

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

                           <ims:textString>Semester</ims:textString>

                        </ims:id>

                        <!--Not Used by D2L-->

                        <ims:type>

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

                           <ims:textString>Semester</ims:textString>

                        </ims:type>

                        <!--Not Used by D2L-->

                        <ims:level>

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

                           <ims:textString>1</ims:textString>

                        </ims:level>

                     </ims:typevalue>

                  </ims:groupType>

                  <ims:description>

                     <ims:shortDescription>Demo Semester</ims:shortDescription>

                  </ims:description>

               </ims:group>

            </ims:groupRecord>

         </ims:replaceGroupRequest>

     </soapenv:Body>

  </soapenv:Envelope>

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

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

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

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

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

الخاصية	تعيين طلب LIS	مطلوب
الكود	groupRecord.sourcedGUID.sourcedId	نعم
الاسم	groupRecord.group.description.shortDescription	نعم
النوع	groupRecord.group.groupType.typeValue(0).id	نعم

نموذج استجابة replaceGroup

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

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

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

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

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

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

نموذج طلب readGroup

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

         <ims:sourcedId>LIS_Test_Department</ims:sourcedId>

      </ims:readGroupRequest>

   </soapenv:Body>

</soapenv:Envelope>

نموذج استجابة readGroup

<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>GMS_readGroup_20120104T231937_2063886Z</imsx_messageIdentifier>

         <imsx_statusInfo>

           <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>warning</imsx_severity>

           <imsx_messageRefIdentifier>1234</imsx_messageRefIdentifier>

           <imsx_description>GMS.readGroup</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">

     <readGroupResponse xmlns="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0">

        <groupRecord>

           <sourcedGUID>

               <sourcedId>LIS_Test_Department</sourcedId>

           </sourcedGUID>

           <group>

              <groupType>

                 <typevalue>

                    <id>Department</id>

                 </typevalue>

              </groupType>

              <description>

                 <shortDescription>LIS Test Department</shortDescription>

              </description>

            </group>

         </groupRecord>

      </readGroupResponse>

   </s:Body>

</s:Envelope>