Method: userProfiles.guardianInvitations.patch

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

در حال حاضر، تنها اصلاح معتبر این است که state از PENDING به COMPLETE تغییر دهید. این باعث پس گرفتن دعوت می شود.

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

  • PERMISSION_DENIED در صورتی که کاربر فعلی مجوز مدیریت سرپرستان را نداشته باشد، اگر نگهبان برای دامنه مورد نظر یا سایر خطاهای دسترسی فعال نباشد .
  • اگر پیوند نگهبان در وضعیت PENDING نباشد، FAILED_PRECONDITION .
  • اگر قالب شناسه دانشجویی ارائه شده قابل شناسایی نباشد (این یک آدرس ایمیل یا یک userId از این API نیست)، یا اگر GuardianInvitation تصویب شده state غیر از COMPLETE داشته باشد، یا اگر فیلدهایی غیر از state را تغییر دهد، INVALID_ARGUMENT .
  • NOT_FOUND اگر شناسه دانشجویی ارائه شده یک شناسه دانشجویی معتبر باشد، اما Classroom هیچ سابقه ای از آن دانش آموز نداشته باشد، یا اگر فیلد id به دعوت نامه سرپرست شناخته شده برای Classroom اشاره نداشته باشد.

درخواست HTTP

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

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

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

پارامترها
studentId

string

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

invitationId

string

قسمت id GuardianInvitation باید اصلاح شود.

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

پارامترها
updateMask

string ( FieldMask format)

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

  • state

هنگامی که در یک پارامتر query تنظیم می شود، این فیلد باید به صورت مشخص شود

updateMask=<field1>,<field2>,...

این فهرستی از نام‌های فیلدهای کاملاً واجد شرایط با کاما است. مثال: "user.displayName,photo" .

درخواست بدن

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

بدن پاسخگو

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

محدوده مجوز

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

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

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