REST Resource: invitations

リソース: 招待

コースへの招待。

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

string

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

読み取り専用です。

userId

string

招待されたユーザーの ID。

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

  • ユーザーの数値 ID
  • ユーザーのメールアドレス
  • リクエストしているユーザーを示す文字列リテラル "me"
courseId

string

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

role

enum (CourseRole)

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

CourseRole

ユーザーに招待された可能性のあるロール。

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

Methods

accept

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

create

招待状を作成します。

delete

招待状を削除します。

get

招待を返します。

list

リクエスト元のユーザーが閲覧を許可されている招待状のリストを、リスト リクエストに一致するものに限定して返します。