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

תפקידים אפשריים שהמשתמש יקבל הזמנה.

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

שיטות

accept

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

create

 יצירת הזמנה.

delete

 מחיקת הזמנה.

get

 מחזירה הזמנה.

list

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