REST Resource: userProfiles.guardianInvitations

משאב: GuardInvite

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

ייצוג JSON 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
שדות
studentId

string

כרטיס התלמיד/ה (בפורמט הסטנדרטי)
invitationId

string

המזהה הייחודי של ההזמנה הזו.

קריאה בלבד.
invitedEmailAddress

string

כתובת האימייל שאליה נשלחה ההזמנה. השדה הזה גלוי רק למנהלי דומיינים.
state

enum (GuardianInvitationState)

המדינה (State) של ההזמנה.
creationTime

string (Timestamp format)

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

קריאה בלבד.

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

GuardianInvitationState

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

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

שיטות

create

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

get

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

list

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

patch

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