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)

زمانی که این دعوت نامه ایجاد شد.

فقط خواندنی

از RFC 3339 استفاده می کند، که در آن خروجی تولید شده همیشه با Z نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "Z" نیز پذیرفته می شود. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

GuardianInvitationState

وضعیت دعوت از قیم.

Enums
GUARDIAN_INVITATION_STATE_UNSPECIFIED هرگز نباید برگردانده شود.
PENDING دعوتنامه فعال است و در انتظار پاسخ است.
COMPLETE دعوت دیگر فعال نیست. ممکن است پذیرفته شده، رد شده باشد، پس گرفته شده باشد یا ممکن است منقضی شده باشد.

روش ها

create

 یک دعوت نامه برای سرپرست ایجاد می کند، و یک ایمیل برای سرپرست ارسال می کند و از آنها می خواهد تأیید کند که سرپرست دانش آموز هستند.

get

 دعوت نامه خاصی از قیم را برمی گرداند.

list

 فهرستی از دعوت‌نامه‌های نگهبان را که کاربر درخواست‌کننده مجاز به مشاهده آن‌ها است، با پارامترهای ارائه‌شده فیلتر می‌کند.

patch

 دعوت نامه سرپرست را اصلاح می کند.