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 địa chỉ email được chỉ định.

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

string

Thẻ căn cước của học viên (ở định dạng chuẩn)
invitationId

string

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

Chỉ có thể đọc.
invitedEmailAddress

string

Địa chỉ email nhận 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ó thể đọc.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. 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 dành cho người giám hộ.

Enum
GUARDIAN_INVITATION_STATE_UNSPECIFIED Không bao giờ được trả lại.
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 hoạt động nữa. Mã này có thể đã được chấp nhận, bị từ chối, rút lại hoặc có thể đã hết hạn.

Phương thức

create

 Tạo lời mời dành cho người giám hộ rồi gửi email đến 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 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ộ.