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 הבעלים של הקורס.

Methods

accept

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

create

 יצירת הזמנה.

delete

 מחיקה של הזמנה.

get

 הפונקציה מחזירה הזמנה.

list

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