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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

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

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

שיטות

create

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

get

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

list

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

patch

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