REST Resource: userProfiles.guardianInvitations

Tài nguyên: nhạy cảm của người giám hộ

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 tới một địa chỉ email đã chỉ định.

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

string

Thẻ sinh 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.

invitedEmailAddress

string

Địa chỉ email nhận lời mời. Trường này chỉ hiển thị cho quản trị viên miền.

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.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""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 Sẽ 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 hoạt động nữa. Khoản tiền 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 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ề lời mời cụ thể dành cho người giám hộ.

list

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

patch

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