Method: courses.courseWork.list

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

دانشجویان دوره فقط می توانند کارهای دوره PUBLISHED را مشاهده کنند. معلمان دوره و مدیران دامنه ممکن است تمام کارهای دوره را مشاهده کنند.

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

  • اگر کاربر درخواست کننده اجازه دسترسی به دوره درخواستی یا خطاهای دسترسی را نداشته باشد، PERMISSION_DENIED .
  • اگر درخواست نادرست باشد INVALID_ARGUMENT .
  • اگر دوره درخواستی وجود نداشته باشد، NOT_FOUND .

درخواست HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork

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

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

پارامترها
course Id

string

شناسه دوره این شناسه می تواند شناسه اختصاص داده شده توسط Classroom یا alias باشد.

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

پارامترها
course Work States[]

enum ( CourseWorkState )

محدودیت در وضعیت کار برای بازگشت. فقط دوره‌های کاری که مطابقت دارند برگردانده می‌شوند. اگر مشخص نشده باشد، مواردی با وضعیت کاری PUBLISHED برگردانده می شوند.

order By

string

مرتب سازی اختیاری برای نتایج. فهرستی از فیلدهای جدا شده با کاما با کلمه کلیدی جهت مرتب سازی اختیاری. فیلدهای پشتیبانی شده updateTime و dueDate هستند. کلمات کلیدی جهت پشتیبانی شده asc و desc هستند. اگر مشخص نشده باشد، updateTime desc رفتار پیش‌فرض است. مثال‌ها: dueDate asc,updateTime desc , updateTime,dueDate desc

page Size

integer

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

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

page Token

string

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

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

preview Version

enum ( PreviewVersion )

اختیاری. نسخه پیش نمایش API. این باید برای دسترسی به قابلیت‌های API جدیدی که در برنامه پیش‌نمایش برای توسعه‌دهندگان در دسترس است، تنظیم شود.

درخواست بدن

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

بدن پاسخگو

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

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

نمایندگی JSON 
{
  "courseWork": [
    {
      object (CourseWork)
    }
  ],
  "nextPageToken": string
}
فیلدها
course Work[]

object ( CourseWork )

موارد کاری دوره که با درخواست مطابقت دارد.

next Page Token

string

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

محدوده مجوز

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

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

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