REST Resource: courses.aliases

المرجع: الاسم المستعار للدورة التدريبية

معرِّف بديل للدورة التدريبية.

ويعرّف الاسم المستعار الدورة التدريبية بشكل فريد. ويجب أن يكون فريدًا ضمن أحد النطاقات التالية:

  • النطاق: يكون الاسم المستعار على مستوى النطاق مرئيًا لجميع المستخدمين داخل نطاق منشئ الاسم المستعار ولا يمكن إنشاؤه إلا من خلال مشرف النطاق. غالبًا ما يتم استخدام اسم مستعار على نطاق النطاق عندما يكون للدورة التدريبية رقم تعريف خارجي لمنصة Classroom.

  • مشروع: الاسم المستعار على مستوى المشروع مرئي لأي طلب من أحد التطبيقات باستخدام رقم تعريف مشروع وحدة تحكم المطوّرين الذي أنشأ الاسم المستعار ويمكن إنشاؤه من خلال أي مشروع. غالبًا ما يتم استخدام اسم مستعار على مستوى المشروع عندما يحتوي التطبيق على معرّفات بديلة. يمكن أيضًا استخدام قيمة عشوائية لتجنب الدورات التدريبية المكررة في حال تعذُّر الإرسال، لأنّ إعادة محاولة الطلب ستعرض ALREADY_EXISTS في حال نجاح الطلب السابق.

تمثيل JSON 
{
  "alias": string
}
الحقول
alias

string

سلسلة الاسم المستعار. يشير تنسيق السلسلة إلى تحديد نطاق الاسم المستعار المطلوب.

  • تشير السمة d:<name> إلى اسم مستعار على مستوى النطاق. مثال: d:math_101
  • تشير السمة p:<name> إلى اسم مستعار على مستوى المشروع. مثال: p:abc123

يبلغ الحد الأقصى لطول هذا الحقل 256 حرفًا.

الطُرق

create

 تنشئ اسمًا مستعارًا لدورة دراسية.

delete

 يؤدي هذا الإجراء إلى حذف الاسم المستعار لدورة دراسية.

list

 عرض قائمة بأسماء مستعارة لدورة تدريبية.