משאב: מאגר מותאם
הזמנה להפוך לאפוטרופוס של משתמש מסוים, שנשלחה לכתובת אימייל מסוימת.
ייצוג JSON |
---|
{
"studentId": string,
"invitationId": string,
"invitedEmailAddress": string,
"state": enum ( |
שדות | |
---|---|
studentId |
מזהה התלמיד (בפורמט סטנדרטי) |
invitationId |
המזהה הייחודי של ההזמנה. קריאה בלבד. |
invitedEmailAddress |
כתובת האימייל שאליה נשלחה ההזמנה. השדה הזה גלוי רק למנהלי דומיין. |
state |
המצב שבו ההזמנה הזו נמצאת. |
creationTime |
השעה שבה ההזמנה הזו נוצרה. קריאה בלבד. חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
GuardianInvitationState
מצב ההזמנה של האפוטרופוס.
טיפוסים בני מנייה (enums) | |
---|---|
GUARDIAN_INVITATION_STATE_UNSPECIFIED |
אין להחזיר אותם אף פעם. |
PENDING |
ההזמנה פעילה וממתינה לתשובה. |
COMPLETE |
ההזמנה לא פעילה יותר. יכול להיות שההזמנה אושרה, נדחתה, בוטלה או שהתוקף שלה פג. |
שיטות |
|
---|---|
|
יוצר הזמנה לאפוטרופוס ושולח אימייל לאפוטרופוס שבו הוא מבקש ממנו לאשר שהוא האפוטרופוס של התלמיד. |
|
מחזירה הזמנה ספציפית לאפוטרופוס. |
|
מחזירה רשימה של הזמנות לאפוטרופוסים שהמשתמש המבקש רשאי להציג, לאחר סינון לפי הפרמטרים שצוינו. |
|
שינוי ההזמנה של האפוטרופוס. |