REST Resource: userProfiles.guardianInvitations

แหล่งข้อมูล: คำเชิญผู้ปกครอง

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

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

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