REST Resource: invitations

Kaynak: Davetiye

Bir derse katılma davetiyesi.

JSON gösterimi 
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
Alanlar
id

string

Classroom tarafından atanan tanımlayıcı.

Salt okunur.
userId

string

Davet edilen kullanıcının tanımlayıcısı.

Bir isteğin parametresi olarak belirtildiğinde bu tanımlayıcı aşağıdakilerden birine ayarlanabilir:

  • kullanıcının sayısal tanımlayıcısı
  • kullanıcının e-posta adresi
  • istekte bulunan kullanıcıyı gösteren "me" dize değeri
courseId

string

Kullanıcının davet edileceği dersin tanımlayıcısı.
role

enum (CourseRole)

Kullanıcıyı davet etmek için rol. COURSE_ROLE_UNSPECIFIED olmamalıdır.

CourseRole

Bir kullanıcının sahip olabileceği olası roller.

Sıralamalar
COURSE_ROLE_UNSPECIFIED Ders rolü yok.
STUDENT Dersteki öğrenci.
TEACHER Dersin öğretmeni.
OWNER Dersin sahibi.

Yöntemler

accept

 Davetiye kabul edilir, kaldırılır ve davet edilen kullanıcı belirtilen dersin öğretmen veya öğrencilerine (uygun olduğu şekilde) eklenir.

create

 Davetiye oluşturur.

delete

 Davetiyeyi siler.

get

 Bir davetiye döndürür.

list

 İstekte bulunan kullanıcının görüntülemesine izin verilen, liste isteğiyle eşleşenlerle sınırlı davetiyelerin listesini döndürür.