REST Resource: invitations

Resource: Undangan

Undangan untuk bergabung ke kursus.

Representasi JSON 
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
Kolom
id

string

ID yang ditetapkan oleh Classroom.

Hanya baca.
userId

string

ID pengguna yang diundang.

Jika ditentukan sebagai parameter permintaan, ID ini dapat ditetapkan ke salah satu dari berikut:

  • ID numerik untuk pengguna
  • alamat email pengguna
  • literal string "me", yang menunjukkan pengguna yang meminta
courseId

string

ID kursus yang akan diundang pengguna.
role

enum (CourseRole)

Peran yang akan diberikan kepada pengguna yang diundang. Tidak boleh COURSE_ROLE_UNSPECIFIED.

CourseRole

Kemungkinan peran yang dapat diundang untuk dimiliki pengguna.

Enum
COURSE_ROLE_UNSPECIFIED Tidak ada peran kursus.
STUDENT Siswa dalam kursus.
TEACHER Pengajar kursus.
OWNER Pemilik kursus.

Metode

accept

 Menerima undangan, menghapusnya, dan menambahkan pengguna yang diundang ke pengajar atau siswa (sebagaimana mestinya) dari kursus yang ditentukan.

create

 Membuat undangan.

delete

 Menghapus undangan.

get

 Menampilkan undangan.

list

 Menampilkan daftar undangan yang diizinkan untuk dilihat oleh pengguna yang meminta, yang dibatasi untuk undangan yang cocok dengan permintaan daftar.