REST Resource: invitations

リソース: Invitation

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

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

string

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

読み取り専用です。
userId

string

招待したユーザーの ID。

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

  • ユーザーの数字 ID
  • お客様のメールアドレス
  • リクエスト元のユーザーを示す文字列リテラル "me"
courseId

string

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

enum (CourseRole)

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

CourseRole

ユーザーに招待できるロール。

列挙型
COURSE_ROLE_UNSPECIFIED コースでのロールなし。
STUDENT コースに登録している生徒。
TEACHER コースの教師。
OWNER コースのオーナー。

メソッド

accept

 招待を承認し、招待を削除して、招待したユーザーを指定されたコースの教師または生徒（該当する場合）に追加します。

create

 招待状を作成します。

delete

 招待を削除します。

get

 招待状を返します。

list

 リクエスト元のユーザーが表示を許可されている招待状のリストを返します。リスト リクエストに一致する招待状のみが返されます。