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가 아니어야 합니다.

과정 역할

사용자가 초대했을 수 있는 역할입니다.

열거형
COURSE_ROLE_UNSPECIFIED 과정 역할 없음
STUDENT 과정의 학생입니다.
TEACHER 과정의 교사입니다.
OWNER 과정 소유자

방법

accept

 초대를 수락하고, 초대를 수락하고, 지정된 사용자를 교사 또는 학생 (필요한 경우)에 추가합니다.

create

 초대를 만듭니다.

delete

 초대를 삭제합니다.

get

 초대를 반환합니다.

list

 요청한 사용자에게 목록 보기와 일치하는 초대로 볼 수 있는 초대 목록을 반환합니다.