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

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