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)

此邀请的创建时间。

只读。

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

GuardianInvitationState

监护人邀请状态。

枚举
GUARDIAN_INVITATION_STATE_UNSPECIFIED 不应返回。
PENDING 此邀请处于有效状态,正在等待回复。
COMPLETE 此邀请已失效。它可能已被接受、拒绝、撤销,或者可能已过期。

方法

create

创建监护人邀请,并向监护人发送电子邮件,请他们确认自己是学生的监护人。

get

返回特定的监护人邀请。

list

返回发出请求的用户可以查看的监护人邀请列表(按提供的参数过滤)。

patch

修改监护人邀请。