REST Resource: invitations

Kaynak: Davetiye

Bir derse katılma daveti.

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ıdır.

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ıdır.
  • kullanıcının e-posta adresi
  • İstekte bulunan kullanıcıyı belirten "me" değişmez dizesi
courseId

string

Kullanıcıyı davet edilecek dersin tanımlayıcısıdır.
role

enum (CourseRole)

Kullanıcıyı davet ederken atanacak rol. COURSE_ROLE_UNSPECIFIED olmamalıdır.

CourseRole

Kullanıcıların davet edilebileceği olası roller.

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

Yöntemler

accept

 Daveti kabul eder, daveti kaldırır ve davet edilen kullanıcıyı belirtilen dersin öğretmenlerine veya öğrencilerine (uygun olduğu şekilde) ekler.

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 davetlerin listesini döndürür. Liste isteğiyle eşleşen davetlerle sınırlıdır.