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 ההזמנה כבר לא פעילה. יכול להיות שהיא אושרה, נדחתה, בוטלה או שפג תוקפה.

Methods

create

 יוצר הזמנה להורה או לאפוטרופוס ושולח אימייל להורה או לאפוטרופוס עם בקשה לאשר שהוא ההורה או האפוטרופוס של התלמיד/ה.

get

 מחזירה הזמנה ספציפית להורה או לאפוטרופוס.

list

 הפונקציה מחזירה רשימה של הזמנות להצטרפות כהורה או אפוטרופוס שהמשתמש ששולח את הבקשה מורשה לראות, מסוננות לפי הפרמטרים שסופקו.

patch

 שינוי של הזמנה להורה או לאפוטרופוס.