REST Resource: invitations

リソース: Invite

コースに参加するための招待状。

JSON 表現 
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
フィールド
id

string

Classroom によって割り当てられた ID。

読み取り専用です。
userId

string

招待されたユーザーの識別子。

リクエストのパラメータとして指定する場合、この識別子は次のいずれかに設定できます。

  • ユーザーの数値識別子
  • ユーザーのメールアドレス
  • リクエスト元のユーザーを示す文字列リテラル "me"
courseId

string

ユーザーを招待するコースの ID。
role

enum (CourseRole)

ユーザーを招待するためのロール。COURSE_ROLE_UNSPECIFIED にすることはできません。

CourseRole

ユーザーが招待される可能性のある役割。

列挙型
COURSE_ROLE_UNSPECIFIED コースの役割がありません。
STUDENT コースの受講生。
TEACHER コースの教師。
OWNER コースのオーナー。

メソッド

accept

 招待を承諾して招待を削除し、招待したユーザーを（必要に応じて）指定したコースの教師または生徒に追加します。

create

 招待状を作成します。

delete

 招待状を削除します。

get

 招待状を返します。

list

 リクエスト元のユーザーに表示が許可されている招待のリストを返します。このリストは、リクエストされた招待に一致するものに限られます。