REST Resource: invitations

Kaynak: Davetiye

Derse katılım 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ı.

Bu tanımlayıcı, bir isteğin parametresi olarak belirtildiğinde 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ı belirten dize değişmez değeri ("me")
courseId

string

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

enum (CourseRole)

Kullanıcının davet edileceği rol. COURSE_ROLE_UNSPECIFIED olmamalıdır.

CourseRole

Kullanıcının davet edebileceği olası roller.

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

Yöntemler

accept

 Davetiye kabul edildiğinde, davetiye kaldırılır ve davet edilen kullanıcı belirtilen dersin öğretmenlerine veya öğrencilerine (uygun şekilde) eklenir.

create

 Davetiye oluşturur.

delete

 Bir 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şen davetiyelerin listesini döndürür.