Method: userProfiles.guardianInvitations.list

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

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

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

درخواست HTTP

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

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

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

پارامترها
student Id

string

شناسنامه دانش آموزی که قرار است دعوتنامه سرپرست او برگردانده شود. شناسه می تواند یکی از موارد زیر باشد:

  • شناسه عددی برای کاربر
  • آدرس ایمیل کاربر
  • رشته تحت اللفظی "me" که کاربر درخواست کننده را نشان می دهد
  • رشته تحت اللفظی "-" ، نشان می دهد که نتایج باید برای همه دانش آموزان بازگردانده شود که کاربر درخواست کننده مجاز به مشاهده دعوت نامه های نگهبان است.

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

پارامترها
invited Email Address

string

در صورت مشخص شدن، فقط نتایج با invitedEmailAddress مشخص شده برگردانده می‌شوند.

states[]

enum ( GuardianInvitationState )

در صورت مشخص شدن، فقط نتایج با مقادیر state مشخص شده برگردانده می شوند. در غیر این صورت، نتایج با state PENDING برگردانده می شوند.

page Token

string

مقدار nextPageToken برگردانده شده از فراخوانی list قبلی، نشان می دهد که صفحه بعدی نتایج باید برگردانده شود.

در غیر این صورت، درخواست list باید با درخواستی که منجر به این نشانه شده است، یکسان باشد.

page Size

integer

حداکثر تعداد اقلام برای بازگشت. صفر یا نامشخص نشان می دهد که سرور ممکن است حداکثر را اختصاص دهد.

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

درخواست بدن

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

بدن پاسخگو

هنگام فهرست کردن دعوت نامه های قیم پاسخ دهید.

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

نمایندگی JSON 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
فیلدها
guardian Invitations[]

object ( GuardianInvitation )

دعوت‌نامه‌های نگهبان که با درخواست فهرست مطابقت داشتند.

next Page Token

string

نشانه شناسایی صفحه بعدی نتایج برای بازگشت. اگر خالی باشد، نتیجه دیگری در دسترس نیست.

محدوده مجوز

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

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

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