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-normalized เสมอ และใช้ตัวเลขทศนิยม 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

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