REST Resource: userProfiles.guardianInvitations

แหล่งข้อมูล: Guardian็อก

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

การแสดง 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)

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

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

GuardianInvitationState

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

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

วิธีการ

create

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

get

 แสดงคำเชิญผู้ปกครองที่ระบุ

list

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

patch

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