REST Resource: userProfiles.guardianInvitations

Tài nguyên: GuardianInvitation

Lời mời trở thành người giám hộ của một người dùng cụ thể, được gửi đến một địa chỉ email cụ thể.

Biểu diễn dưới dạng JSON 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
Trường
studentId

string

Giấy tờ tuỳ thân của học viên (ở định dạng chuẩn)
invitationId

string

Giá trị nhận dạng duy nhất của lời mời này.

Chỉ có thể đọc.
invitedEmailAddress

string

Địa chỉ email nhận được lời mời. Chỉ quản trị viên miền mới thấy trường này.
state

enum (GuardianInvitationState)

Trạng thái của lời mời này.
creationTime

string (Timestamp format)

Thời gian tạo lời mời này.

Chỉ có thể đọc.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

Trạng thái của lời mời người giám hộ.

Enum
GUARDIAN_INVITATION_STATE_UNSPECIFIED Không được trả về.
PENDING Lời mời đang hoạt động và đang chờ phản hồi.
COMPLETE Lời mời đó không còn hiệu lực nữa. Lời mời đó có thể đã được chấp nhận, từ chối, rút lại hoặc đã hết hạn.

Phương thức

create

 Tạo lời mời cho người giám hộ và gửi email cho người giám hộ để yêu cầu họ xác nhận rằng họ là người giám hộ của học viên.

get

 Trả về một lời mời dành riêng cho người giám hộ.

list

 Trả về danh sách lời mời của người giám hộ mà người dùng yêu cầu được phép xem, được lọc theo các tham số được cung cấp.

patch

 Sửa đổi lời mời dành cho người giám hộ.