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 tempat pengguna akan diundang.
role

enum (CourseRole)

Peran yang akan diundang untuk dimiliki pengguna. Tidak boleh COURSE_ROLE_UNSPECIFIED.

CourseRole

Peran yang mungkin dimiliki pengguna yang mungkin diundang.

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

Metode

accept

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

create

 Membuat undangan.

delete

 Menghapus undangan.

get

 Menampilkan undangan.

list

 Menampilkan daftar undangan yang boleh dilihat oleh pengguna yang meminta, terbatas untuk undangan yang cocok dengan permintaan daftar.