Method: userProfiles.guardianInvitations.get

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

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

  • PERMISSION_DENIED در صورتی که کاربر درخواست کننده مجاز به مشاهده دعوت نامه های سرپرست دانش آموز شناسایی شده توسط studentId نباشد، اگر سرپرستان برای دامنه مورد نظر فعال نشده باشند، یا برای سایر خطاهای دسترسی .
  • اگر studentId مشخص شده باشد، INVALID_ARGUMENT ، اما قالب آن قابل شناسایی نیست (این یک آدرس ایمیل، نه یک studentId از API، و نه رشته تحت اللفظی me است).
  • NOT_FOUND اگر Classroom نتواند سابقه ای از دانش آموز یا invitationId پیدا کند. در صورت وجود دانش آموز نیز ممکن است برگردانده شود، اما کاربر درخواست کننده دسترسی به دیدن آن دانش آموز را ندارد.

درخواست HTTP

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

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

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

پارامترها
studentId

string

شناسه دانش آموزی که دعوت نامه سرپرست وی درخواست شده است.

invitationId

string

فیلد id GuardianInvitation در حال درخواست است.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

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

محدوده مجوز

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

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

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