منبع: GuardianInvitation
دعوتنامه ای برای تبدیل شدن به سرپرست یک کاربر مشخص، که به یک آدرس ایمیل مشخص ارسال شده است.
| نمایندگی JSON |
|---|
{
"studentId": string,
"invitationId": string,
"invitedEmailAddress": string,
"state": enum ( |
| فیلدها | |
|---|---|
studentId | شناسه دانشجو (در قالب استاندارد) |
invitationId | شناسه منحصر به فرد برای این دعوت. فقط خواندنی |
invitedEmailAddress | آدرس ایمیلی که دعوتنامه به آن ارسال شده است. این فیلد فقط برای مدیران دامنه قابل مشاهده است. |
state | وضعیتی که این دعوتنامه در آن است. |
creationTime | زمانی که این دعوت نامه ایجاد شد. فقط خواندنی از RFC 3339 استفاده می کند، که در آن خروجی تولید شده همیشه با Z نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "Z" نیز پذیرفته می شود. مثال‌ها: |
GuardianInvitationState
وضعیت دعوت از قیم.
| Enums | |
|---|---|
GUARDIAN_INVITATION_STATE_UNSPECIFIED | هرگز نباید برگردانده شود. |
PENDING | دعوتنامه فعال است و در انتظار پاسخ است. |
COMPLETE | دعوت دیگر فعال نیست. ممکن است پذیرفته شده، رد شده باشد، پس گرفته شده باشد یا ممکن است منقضی شده باشد. |
روش ها | |
|---|---|
| یک دعوت نامه برای سرپرست ایجاد می کند، و یک ایمیل برای سرپرست ارسال می کند و از آنها می خواهد تأیید کند که سرپرست دانش آموز هستند. |
| دعوت نامه خاصی از قیم را برمی گرداند. |
| فهرستی از دعوت‌نامه‌های نگهبان را که کاربر درخواست‌کننده مجاز به مشاهده آنها است، با پارامترهای ارائه‌شده فیلتر می‌کند. |
| دعوت نامه سرپرست را اصلاح می کند. |