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

خدمة إدارة الأشخاص (PMS)

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

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

deletePerson
replacePerson
readPerson

الأسماء الأولى وأسماء العائلة المفضلة

يمكن للعملاء الذين يستخدمون LIS 2.0 تضمين أسماء المستخدمين المفضلة والحفاظ عليها باستخدام علامات XML في تكامل LIS. فيما يأتي القواعد التي تتبعها حزمة التكامل لأنظمة معلومات الطالب عندما يتم السماح لنظام معلومات الطالب بالكتابة فوق أسماء المستخدم المفضلة في Brightspace:

إذا كان لـ LIS اسم أول مفضل فارغ لمستخدم لديه اسم أول مفضل في Brightspace، فاحذف الاسم الأول المفضل.
إذا كان لـ LIS اسم عائلة مفضل فارغ لمستخدم لديه اسم عائلة مفضل في Brightspace، فاحذف اسم العائلة المفضل.
إذا كان لـ LIS كتلة اسم مفضلة، وتتضمن اسم العائلة المفضل فقط، فلا تفعل أي شيء بالاسم الأول المفضل وقم بتحديث اسم العائلة المفضل في Brightspace.
إذا كان لـ LIS كتلة اسم مفضلة، وتتضمن الاسم الأول المفضل فقط، فلا تفعل أي شيء باسم العائلة المفضل وقم بتحديث الاسم الأول المفضل في Brightspace.
عندما تكون كتلة الاسم المفضلة مفقودة من الطلب، فاحذف الاسم الأول واسم العائلة المفضلين.
إذا كان لـ LIS كتلة الاسم المفضلة والاسم الأول واسم العائلة موجودين، فقم بالكتابة فوق الاسم الأول أو اسم العائلة المفضلين في Brightspace.

ملاحظة: يحتوي NameType المفضل على معلومات الاسم المفضل للمستخدم، ويمكن إرسالها مع باقي الاسم واسم الجزء بوصفها جزءًا من مادة الشخص.

بالنسبة إلى العملاء الذين يستخدمون حزمة التكامل لأنظمة معلومات الطالب الإصدار 1.0:

يمكن لـ PersonRequestPreferredFirstAndLastNameOptionalTranslator الانتقال إلى أي مكان في القائمة.
يجب أن ينتقل كل من ReplaceUserPreferredFirstNameNoUpdateHandler وReplaceUserPreferredLastNameNoUpdateHandler قبل ReplaceUserSaveLMSHandler

لمحة عن عملية deletePerson

تُستخدم عملية deletePerson لحذف المستخدمين من Brightspace.

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

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

نموذج طلب deletePerson

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

         <ims:sourcedId>Demo_User</ims:sourcedId>

      </ims:deletePersonRequest>

   </soapenv:Body>

</soapenv:Envelope>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

لمحة عن عملية replacePerson

تُستخدم عملية replacePerson لإنشاء مستخدمي Brightspace أو تحديثهم.

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

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

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

نموذج طلب replacePerson

ملاحظة: يتضمن نموذج الطلب هذا حقل ملحق اختياري (بخط غامق) يوفر إمكانية تغيير حالة المستخدم بعد إنشائه الأولي. حقل الملحق مطلوب لهذا الإجراء لأن حالة المستخدم لا تتطابق مباشرة مع حقل من مواصفات LIS.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

  xmlns:ims="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">

   <soapenv:Header>

      <ims:imsx_syncRequestHeaderInfo>

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

         <ims:imsx_messageIdentifier>12346</ims:imsx_messageIdentifier>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:replacePersonRequest>

         <!--Not Used by D2L-->

         <ims:sourcedId>Demo_User</ims:sourcedId>

         <ims:personRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_User</ims:sourcedId>

            </ims:sourcedGUID>

            <!--Optional:-->

            <ims:person>

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

               <ims:name>

                  <ims:nameType>

                     <ims:instanceIdentifier>

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

                        <ims:textString>Contact</ims:textString>

                     </ims:instanceIdentifier>

                     <ims:instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/nametypevocabularyv1p0</ims:instanceVocabulary&gt;

                     <ims:instanceValue>

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

                        <ims:textString>Contact</ims:textString>

                     </ims:instanceValue>

                  </ims:nameType>

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

                  <ims:partName>

                     <ims:instanceIdentifier>

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

                        <ims:textString>Contact-First</ims:textString>

                     </ims:instanceIdentifier>

                     <ims:instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/partnamevocabularyv1p0</ims:instanceVocabulary&gt;

                     <ims:instanceName>

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

                        <ims:textString>First</ims:textString>

                     </ims:instanceName>

                     <ims:instanceValue>

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

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

                     </ims:instanceValue>

                  </ims:partName>

                  <ims:partName>

                     <ims:instanceIdentifier>

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

                        <ims:textString>Contact-Last</ims:textString>

                     </ims:instanceIdentifier>

                     <ims:instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/partnamevocabularyv1p0&lt:/ims:instanceVocabulary&gt;

                     <ims:instanceName>

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

                        <ims:textString>Last</ims:textString>

                     </ims:instanceName>

                     <ims:instanceValue>

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

                        <ims:textString>User</ims:textString>

                     </ims:instanceValue>

                  </ims:partName>

               </ims:name>

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

               <ims:contactinfo>

                  <ims:contactinfoType>

                     <ims:instanceIdentifier>

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

                        <ims:textString>EmailPrimary</ims:textString>

                     </ims:instanceIdentifier>

                     <ims:instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/contactinfotypevocabularyv1p0</ims:instanceVocabulary&gt;

                     <ims:instanceValue>

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

                        <ims:textString>EmailPrimary</ims:textString>

                     </ims:instanceValue>

                  </ims:contactinfoType>

                  <ims:contactinfoValue>

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

                     <ims:textString>duser@demo.com</ims:textString>

                  </ims:contactinfoValue>

               </ims:contactinfo>

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

               <ims:roles>

                  <ims:enterpriserolesType>

                     <ims:instanceIdentifier>

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

                        <ims:textString>StudentInformationSystem</ims:textString>

                     </ims:instanceIdentifier>

                     <ims:instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/epriserolestypevocabularyv1p0</ims:instanceVocabulary&gt;

                     <ims:instanceValue>

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

                        <ims:textString>StudentInformationSystem</ims:textString>

                     </ims:instanceValue>

                  </ims:enterpriserolesType>

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

                  <ims:institutionRole>

                     <ims:institutionroletype>

                        <ims:instanceIdentifier>

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

                           <ims:textString>StudentInformationSystem-Student</ims:textString>

                        </ims:instanceIdentifier>

                        <ims:instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/institutionroletypevocabularyv1p0</ims:instanceVocabulary&gt;

                        <ims:instanceValue>

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

                           <ims:textString>Student</ims:textString>

                        </ims:instanceValue>

                     </ims:institutionroletype>

                     <ims:primaryroletype>1</ims:primaryroletype>

                  </ims:institutionRole>

                  <!--Optional:-->

                  <ims:userId>

                     <ims:userIdValue>

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

                        <ims:textString>duser</ims:textString>

                     </ims:userIdValue>

                     <!--Optional:-->

                     <ims:password>

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

                        <ims:textString>d2l</ims:textString>

                     </ims:password>

                  </ims:userId>

               </ims:roles>


		 <ims:extension>


		    <ims:extensionField>


			<ims:fieldName>IsActive</ims:fieldName>


			<ims:fieldType>Boolean</ims:fieldType>


			<ims:fieldValue>True</ims:fieldValue>


		    </ims:extensionField>


		 </ims:extension>

            </ims:person>

         </ims:personRecord>

      </ims:replacePersonRequest>

   </soapenv:Body>

</soapenv:Envelope>

<ims:agent>

<ims:agentId>

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

<ims:textString>{Parent user Id}</ims:textString>

</ims:agentId>

<ims:agentDomain>

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

<ims:textString>{Parent role}</ims:textString>

</ims:agentDomain>

</ims:agent>

<ims:extension>

<ims:extensionField>

<ims:fieldName>SynchronizeRelationships</ims:fieldName>

<ims:fieldType>Boolean</ims:fieldType>

<ims:fieldValue>true</ims:fieldValue>

</ims:extensionField>

</ims:extension>

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

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

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

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

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

الخاصية	تعيين طلب LIS	مطلوب
OrgDefinedId	sourcedGUID.sourcedId	نعم
الاسم الكامل	person.name.formname	لا
الاسم الأول	person.name.partName.instanceValue.textString حيث person.name.partName.instanceName.textString = "الأول" أو "معين"	نعم
اسم العائلة	person.name.partName.instanceValue.textString حيث person.name.partName.instanceName.textString = "الأخير" أو "العائلة" أو "اللقب"	نعم
عنوان البريد الإلكتروني	person.contactinfo.contactinfoValue.textString حيث person.contactinfo.contactinfoType.instanceValue = "EmailPrimary"	لا
دور	person.roles.institutionRole(*).institutionroletype.instanceValue.textString	لا
الدور الأساسي	person.roles.institutionRole().institutionroletype.instanceValue.textString عندما يكون person.roles.institutionRole().primaryroletype = صواب	لا
اسم المستخدم	person.roles.userId.userIdValue.textString	لا
نوع اسم المستخدم	person.roles.userId.userIdType.textString	لا
كلمة المرور	person.roles.userId.password.textString	لا
نوع التشفير	person.roles.userId.pwEncryptionType.textString	لا
نوع المصادقة	person.roles.userId.authenticationType.textString	لا
IsActive	person.extension.extensionField.fieldValue	لا

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

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

   <s:Header>

      <h:imsx_syncResponseHeaderInfo

          xmlns:h="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0"

          xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_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>PMS_replacePerson_20120418T234324_4244880Z</imsx_messageIdentifier>

         <imsx_statusInfo>

            <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>warning</imsx_severity>

            <imsx_messageRefIdentifier>12346</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>

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

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

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

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

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

نموذج طلب readPerson

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

   xmlns:ims="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">

   <soapenv:Header>

      <ims:imsx_syncRequestHeaderInfo>

         <ims:imsx_version>1.0</ims:imsx_version>

         <ims:imsx_messageIdentifier>1234567</ims:imsx_messageIdentifier>

         <!--Optional:-->

         <ims:imsx_sendingAgentIdentifier/>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:readPersonRequest>

         <ims:sourcedId>Demo_User</ims:sourcedId>

      </ims:readPersonRequest>

   </soapenv:Body>

</soapenv:Envelope>

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

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

   <s:Header>

      <h:imsx_syncResponseHeaderInfo xmlns:h="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0"

         xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_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>PMS_readPerson_20120720T192847_4131414Z</imsx_messageIdentifier>

         <imsx_statusInfo>

           <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>warning</imsx_severity>

            <imsx_messageRefIdentifier>12354</imsx_messageRefIdentifier>

            <imsx_description>PMS.readPerson</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">

      <readPersonResponse xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">

         <personRecord>

           <sourcedGUID>

              <sourcedId>Demo_User</sourcedId>

           </sourcedGUID>

           <person>

               <formname>

                 <formnameType>

                     <instanceIdentifier>

                       <language>en-US</language>

                    </instanceIdentifier>

                     <instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/formatnmetypevocabularyv1p0</instanceVocabulary&gt;

                     <instanceValue>

                       <language>en-US</language>

                        <textString>Full</textString>

                     </instanceValue>

                 </formnameType>

                  <formattedName>

                    <language>en-US</language>

                     <textString>Demo User</textString>

                 </formattedName>

               </formname>

              <name>

                  <nameType>

                    <instanceIdentifier>

                        <language>en-US</language>

                     </instanceIdentifier>

                    <instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/nametypevocabularyv1p0</instanceVocabulary&gt;

                    <instanceValue>

                        <language>en-US</language>

                        <textString>Full</textString>

                     </instanceValue>

                  </nameType>

                 <partName>

                    <instanceIdentifier>

                       <language>en-US</language>

                    </instanceIdentifier>

                    <instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/partnamevocabularyv1p0</instanceVocabulary&gt;

                    <instanceName>

                        <language>en-US</language>

                       <textString>First</textString>

                    </instanceName>

                     <instanceValue>

                        <language>en-US</language>

                       <textString>Demo</textString>

                     </instanceValue>

                  </partName>

                  <partName>

                     <instanceIdentifier>

                       <language>en-US</language>

                     </instanceIdentifier>

                    <instanceVocabulary>http://www.imsglobal.org/lis/pmsv2p0/partnamevocabularyv1p0</instanceVocabulary&gt;

                     <instanceName>

                        <language>en-US</language>

                        <textString>Last</textString>

                     </instanceName>

                     <instanceValue>

                        <language>en-US</language>

                        <textString>User</textString>

                    </instanceValue>

                  </partName>

               </name>

           </person>

         </personRecord>

      </readPersonResponse>

   </s:Body>

</s:Envelope>