REST Resource: courses.aliases

משאב: CourseAlias

מזהה חלופי של קורס.

כינוי מזהה קורס באופן ייחודי. הוא חייב להיות ייחודי באחד מההיקפים הבאים:

  • דומיין: כתובת אימייל חלופית ברמת הדומיין גלויה לכל המשתמשים בדומיין של היוצר של כתובת האימייל החלופית, ורק אדמין דומיין יכול ליצור אותה. לעיתים קרובות משתמשים בכתובת אימייל חלופית ברמת הדומיין כשלקורס יש מזהה מחוץ ל-Classroom.

  • project: כינוי ברמת הפרויקט גלוי לכל בקשה מאפליקציה שמשתמשת במזהה הפרויקט ב-Developer Console שבו נוצר הכינוי, וניתן ליצור אותו בכל פרויקט. לרוב משתמשים בכינוי ברמת הפרויקט כשלאפליקציה יש מזהים חלופיים. אפשר להשתמש בערך אקראי גם כדי למנוע כפילויות של קורסים במקרה של כשלים בהעברה, כי ניסיון חוזר בבקשה יחזיר את הערך ALREADY_EXISTS אם בקשה קודמת הצליחה.

ייצוג ב-JSON
{
  "alias": string
}
שדות
alias

string

מחרוזת חלופית. הפורמט של המחרוזת מציין את היקף החלה הרצוי של הכינוי.

  • d:<name> מציין כינוי ברמת הדומיין. לדוגמה: d:math_101
  • p:<name> מציין כינוי ברמת הפרויקט. לדוגמה: p:abc123

האורך המקסימלי של השדה הוא 256 תווים.

Methods

create

יצירת כינוי לקובץ קורס.

delete

מחיקה של כתובת אימייל חלופית של קורס.

list

הפונקציה מחזירה רשימה של כינויים של קורס.