REST Resource: userProfiles.guardianInvitations

리소스: GuardianInvitation

지정된 사용자에게 지정된 이메일 주소로 전송된 보호자 초대를 나타냅니다.

JSON 표현 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
필드
studentId

string

학생 ID (표준 형식)
invitationId

string

이 초대의 고유 식별자입니다.

읽기 전용입니다.
invitedEmailAddress

string

초대가 전송된 이메일 주소입니다. 이 필드는 도메인 관리자에게만 표시됩니다.
state

enum (GuardianInvitationState)

이 초대의 상태입니다.
creationTime

string (Timestamp format)

이 초대가 생성된 시간입니다.

읽기 전용입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.

GuardianInvitationState

보호자 초대 상태입니다.

열거형
GUARDIAN_INVITATION_STATE_UNSPECIFIED 반환되지 않아야 합니다.
PENDING 초대가 활성 상태이며 응답을 기다리고 있습니다.
COMPLETE 초대가 더 이상 활성 상태가 아닙니다. 수락, 거부, 철회되었거나 만료되었을 수 있습니다.

메서드

create

 보호자 초대를 생성하고 보호자에게 학생의 보호자인지 확인해 달라는 이메일을 보냅니다.

get

 특정 보호자 초대를 반환합니다.

list

 요청하는 사용자가 볼 수 있는 보호자 초대 목록을 반환합니다. 이 목록은 제공된 매개변수에 따라 필터링됩니다.

patch

 보호자 초대를 수정합니다.