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

Mã nhận dạng của học viên (ở định dạng chuẩn)
invitationId

string

Giá trị nhận dạng riêng biệt của lời mời này.

Chỉ đọc.
invitedEmailAddress

string

Địa chỉ email nhận được lời mời. Chỉ quản trị viên miền mới nhìn 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.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

GuardianInvitationState

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

Enum
GUARDIAN_INVITATION_STATE_UNSPECIFIED Không bao giờ đượ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. 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 cụ thể dành cho người giám hộ.

list

 Trả về danh sách lời mời cho 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ố đã cung cấp.

patch

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