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

 แสดงผลรายการคำเชิญที่ผู้ใช้ที่ส่งคำขอได้รับอนุญาตให้ดู โดยจำกัดไว้เฉพาะรายการที่ตรงกับคำขอรายการ