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)

השעה שבה נוצרה ההזמנה.

קריאה בלבד.

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

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

טיפוסים בני מנייה (enum)
GUARDIAN_INVITATION_STATE_UNSPECIFIED אף פעם לא צריך להחזיר אותו.
PENDING ההזמנה פעילה וממתינה לתשובה.
COMPLETE ההזמנה כבר לא פעילה. יכול להיות שהיא אושרה, נדחתה, בוטלה או שפג תוקפה.

Methods

create

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

get

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

list

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

patch

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