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

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