REST Resource: invitations

משאב: הזמנה

הזמנה להצטרף לקורס.

ייצוג JSON 
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
שדות
id

string

מזהה שהוקצה על ידי Classroom.

קריאה בלבד.
userId

string

המזהה של המשתמש שהוזמן.

כשהוא מוגדר כפרמטר של בקשה, אפשר להגדיר אותו לאחת מהאפשרויות הבאות:

  • המזהה המספרי של המשתמש
  • כתובת האימייל של המשתמש
  • ליטרל המחרוזת "me", שמציין את המשתמש ששלח את הבקשה
courseId

string

מזהה הקורס שאליו רוצים להזמין את המשתמש.
role

enum (CourseRole)

תפקיד שצריך להזמין אליו את המשתמש. לא יכול להיות COURSE_ROLE_UNSPECIFIED.

CourseRole

תפקידים אפשריים שיכולים להיות למשתמש.

טיפוסים בני מנייה (enum)
COURSE_ROLE_UNSPECIFIED אין תפקיד בקורס.
STUDENT תלמיד בקורס.
TEACHER מורה הקורס.
OWNER בעלי הקורס.

שיטות

accept

 מקבל הזמנה, מסיר אותה ומוסיפים את המשתמש שהוזמן למורים או לתלמידים (לפי הכללים) של הקורס שצוין.

create

 יצירת הזמנה.

delete

 מחיקת הזמנה.

get

 מחזיר הזמנה.

list

 מחזירה רשימת הזמנות שהמשתמש המבקש רשאי להציג, מוגבל לאלה שתואמות לבקשת הרשימה.