Method: invitations.list

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

توجه: حداقل یکی از userId یا courseId باید ارائه شود. هر دو زمینه قابل عرضه است.

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

درخواست HTTP

GET https://classroom.googleapis.com/v1/invitations

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

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

پارامترها
userId

string

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

  • شناسه عددی برای کاربر
  • آدرس ایمیل کاربر
  • رشته تحت اللفظی "me" که کاربر درخواست کننده را نشان می دهد
courseId

string

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

pageSize

integer

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

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

pageToken

string

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

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

درخواست بدن

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

بدن پاسخگو

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

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

نمایندگی JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ],
  "nextPageToken": string
}
فیلدها
invitations[]

object ( Invitation )

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

nextPageToken

string

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

محدوده مجوز

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

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

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