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

Tanımlayıcı, Classroom tarafından atandı.

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
  • İstekte bulunan kullanıcıyı belirten "me" dizesi değişmez değeri
courseId

string

Kullanıcıyı davet etmek için kursun tanımlayıcısı.

role

enum (CourseRole)

Kullanıcıyı sahip olmaya davet etmek için kullanılan rol. COURSE_ROLE_UNSPECIFIED olmamalıdır.

KursRolü

Bir kullanıcının sahip olabileceği davet edilmiş olabilecek roller.

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

Yöntemler

accept

Daveti kabul eder, kaldırır ve davet edilen kullanıcıyı belirtilen dersin öğretmenlerine veya öğrencilerine ekler.

create

Bir davetiye oluşturur.

delete

Bir davetiyeyi siler.

get

Bir davetiye döndürür.

list

İstekte bulunan kullanıcının görüntüleyebileceği, liste isteğiyle eşleşen davetiyelerin listesini gösterir.