REST Resource: invitations

리소스: 초대

강의에 참여해 달라는 초대입니다.

JSON 표현
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
필드
id

string

클래스룸에서 할당한 식별자입니다.

읽기 전용입니다.

userId

string

초대된 사용자의 식별자입니다.

요청의 매개변수로 지정되는 경우 이 식별자는 다음 중 하나로 설정될 수 있습니다.

  • 사용자의 숫자 식별자입니다.
  • 사용자의 이메일 주소
  • 요청하는 사용자를 나타내는 문자열 리터럴 "me"
courseId

string

사용자를 초대할 과정의 식별자입니다.

role

enum (CourseRole)

사용자에게 부여할 역할입니다. COURSE_ROLE_UNSPECIFIED이 아니어야 합니다.

CourseRole

사용자에게 초대를 받을 수 있는 역할입니다.

열거형
COURSE_ROLE_UNSPECIFIED 과정 역할이 없습니다.
STUDENT 과정에 학생으로 참여합니다.
TEACHER 이 과정의 교사입니다.
OWNER 수업의 소유자입니다.

방법

accept

초대를 수락하여 초대를 삭제하고 초대된 사용자를 지정된 강의의 교사 또는 학생에게 추가합니다 (해당하는 경우).

create

초대를 만듭니다.

delete

초대를 삭제합니다.

get

초대를 반환합니다.

list

요청하는 사용자에게 보기가 허용된 초대 목록 중 목록 요청과 일치하는 것으로 제한된 초대 목록을 반환합니다.