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

หลักสูตร

บทบาทที่เป็นไปได้ที่ผู้ใช้อาจได้รับเชิญ

Enum
COURSE_ROLE_UNSPECIFIED ไม่มีบทบาทในหลักสูตร
STUDENT นักเรียนในหลักสูตร
TEACHER ครูของหลักสูตรนี้
OWNER เจ้าของหลักสูตร

เมธอด

accept

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

create

สร้างคําเชิญ

delete

ลบคําเชิญ

get

ส่งคําเชิญ

list

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