Method: userProfiles.guardianInvitations.create

• درخواست HTTP
• پارامترهای مسیر
• درخواست بدن
• بدن پاسخگو
• محدوده مجوز
• آن را امتحان کنید!

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

هنگامی که سرپرست دعوت نامه را پذیرفت، state آنها به COMPLETED تغییر می کند و آنها شروع به دریافت اعلان های قیم خواهند کرد. یک منبع Guardian نیز برای نمایندگی قیم فعال ایجاد خواهد شد.

شی درخواست باید دارای فیلدهای studentId و invitedEmailAddress باشد. تنظیم نکردن این فیلدها یا تنظیم هر فیلد دیگری در درخواست منجر به خطا می شود.

این روش کدهای خطای زیر را برمی گرداند:

• PERMISSION_DENIED اگر کاربر فعلی مجوز مدیریت سرپرستان را نداشته باشد، اگر سرپرست مورد نظر قبلاً درخواست‌های زیادی را برای آن دانش‌آموز رد کرده باشد، اگر سرپرستان برای دامنه مورد نظر فعال نشده باشند، یا برای سایر خطاهای دسترسی .
• RESOURCE_EXHAUSTED اگر دانش آموز یا سرپرست از حد مجاز پیوند قیم فراتر رفته باشد.
• اگر آدرس ایمیل INVALID_ARGUMENT معتبر نباشد (به عنوان مثال، اگر خیلی طولانی باشد)، یا اگر قالب شناسه دانشجویی ارائه شده قابل شناسایی نباشد (این آدرس ایمیل یا userId از این API نیست). اگر فیلدهای فقط خواندنی تنظیم شده باشند، یا اگر فیلد state روی مقداری غیر از PENDING تنظیم شده باشد، این خطا نیز برگردانده خواهد شد.
• NOT_FOUND اگر شناسه دانشجویی ارائه شده یک شناسه دانشجویی معتبر باشد، اما Classroom هیچ سابقه ای از آن دانش آموز ندارد.
• اگر قبلاً دعوت‌نامه سرپرست معلقی برای دانش‌آموز وجود داشته باشد و invitedEmailAddress ارائه شده باشد، یا اگر invitedEmailAddress با حساب Google یک Guardian موجود برای این کاربر مطابقت داشته باشد، ALREADY_EXISTS .

درخواست HTTP

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
guardianInvitation.studentId	string شناسه دانشجو (در قالب استاندارد)

درخواست بدن

بدنه درخواست شامل یک نمونه از GuardianInvitation است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک نمونه جدید از GuardianInvitation است.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

• https://www.googleapis.com/auth/classroom.guardianlinks.students

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.