REST Resource: userProfiles.guardianInvitations

ทรัพยากร: GuardianInvitation

คำเชิญให้เป็นผู้ปกครองของผู้ใช้ที่ระบุ ซึ่งส่งไปยังอีเมลที่ระบุ

การแสดง JSON 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
ช่อง
studentId

string

รหัสนักเรียน (ในรูปแบบมาตรฐาน)
invitationId

string

ตัวระบุที่ไม่ซ้ำกันสำหรับคำเชิญนี้

อ่านอย่างเดียว
invitedEmailAddress

string

อีเมลที่ได้รับคำเชิญ เฉพาะผู้ดูแลระบบโดเมนเท่านั้นที่จะเห็นช่องนี้
state

enum (GuardianInvitationState)

สถานะของคำเชิญนี้
creationTime

string (Timestamp format)

เวลาที่สร้างคำเชิญนี้

อ่านอย่างเดียว

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็น Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่าง: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

GuardianInvitationState

สถานะของคำเชิญผู้ปกครอง

Enum
GUARDIAN_INVITATION_STATE_UNSPECIFIED ไม่ควรแสดง
PENDING คำเชิญใช้งานได้และรอการตอบกลับ
COMPLETE คำเชิญนี้ใช้ไม่ได้แล้ว คำเชิญอาจได้รับการยอมรับ ถูกปฏิเสธ ถูกยกเลิก หรือหมดอายุแล้ว

เมธอด

create

 สร้างคำเชิญสำหรับผู้ปกครองและส่งอีเมลถึงผู้ปกครองเพื่อขอให้ยืนยันว่าเป็นผู้ปกครองของนักเรียน

get

 แสดงผลคำเชิญผู้ปกครองที่เฉพาะเจาะจง

list

 แสดงรายการคำเชิญผู้ปกครองที่ผู้ใช้ที่ขอมีสิทธิ์ดู โดยกรองตามพารามิเตอร์ที่ระบุ

patch

 แก้ไขคำเชิญให้ผู้ปกครอง