REST Resource: courses.aliases

منبع: CourseAlias

شناسه جایگزین برای یک دوره

نام مستعار به طور منحصر به فرد یک دوره را مشخص می کند. باید در یکی از حوزه های زیر منحصر به فرد باشد:

  • دامنه: یک نام مستعار با دامنه دامنه برای همه کاربران در دامنه ایجاد کننده نام مستعار قابل مشاهده است و فقط توسط یک مدیر دامنه می تواند ایجاد شود. نام مستعار دامنه‌دار اغلب زمانی استفاده می‌شود که یک دوره دارای شناسه‌ای خارج از Classroom باشد.

  • پروژه: یک نام مستعار با محدوده پروژه برای هر درخواستی از یک برنامه با استفاده از شناسه پروژه کنسول برنامه‌نویس که نام مستعار را ایجاد کرده است قابل مشاهده است و می‌تواند توسط هر پروژه ایجاد شود. نام مستعار محدوده پروژه اغلب زمانی استفاده می شود که یک برنامه دارای شناسه های جایگزین باشد. همچنین می‌توان از یک مقدار تصادفی برای اجتناب از دوره‌های تکراری در صورت عدم موفقیت در انتقال استفاده کرد، زیرا اگر درخواست قبلی موفق شده باشد، درخواست مجدد ALREADY_EXISTS را برمی‌گرداند.

نمایندگی JSON 
{
  "alias": string
}
فیلدها
alias

string

رشته مستعار. قالب رشته نشان دهنده دامنه نام مستعار مورد نظر است.

  • d:<name> یک نام مستعار با دامنه دامنه را نشان می دهد. مثال: d:math_101
  • p:<name> یک نام مستعار با محدوده پروژه را نشان می دهد. مثال: p:abc123

حداکثر طول این فیلد 256 کاراکتر است.

روش ها

create

 یک نام مستعار برای یک دوره ایجاد می کند.

delete

 نام مستعار یک دوره را حذف می کند.

list

 فهرستی از نام های مستعار را برای یک دوره برمی گرداند.