REST Resource: userProfiles.guardianInvitations

منبع: GuardianInvitation

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

نمایندگی JSON 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
فیلدها
student Id

string

شناسه دانشجو (در قالب استاندارد)

invitation Id

string

شناسه منحصر به فرد برای این دعوت.

فقط خواندنی

invited Email Address

string

آدرس ایمیلی که دعوتنامه به آن ارسال شده است. این فیلد فقط برای مدیران دامنه قابل مشاهده است.

state

enum ( GuardianInvitationState )

وضعیتی که این دعوتنامه در آن است.

creation Time

string ( Timestamp format)

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

فقط خواندنی

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

GuardianInvitationState

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

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

روش ها

create

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

get

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

list

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

patch

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