Method: courses.courseWork.studentSubmissions.list

فهرستی از موارد ارسالی دانشجویان که درخواست‌کننده مجاز به مشاهده آنهاست را با در نظر گرفتن محدوده‌های OAuth درخواست، برمی‌گرداند. می‌توان از یک خط تیره ( - ) به عنوان courseWorkId استفاده کرد تا موارد ارسالی دانشجویان برای چندین مورد کار درسی را شامل شود.

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

این متد کدهای خطای زیر را برمی‌گرداند:

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

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
courseId

string

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

courseWorkId

string

شناسه‌ی کار دانشجویی که باید درخواست شود. این شناسه می‌تواند روی رشته‌ی تحت‌اللفظی "-" تنظیم شود تا کار دانشجویی برای تمام کارهای دوره در دوره‌ی مشخص‌شده درخواست شود.

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

پارامترها
userId

string

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

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

enum ( SubmissionState )

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

late

enum ( LateValues )

مقدار تأخیر درخواستی. در صورت مشخص شدن، ارسال‌های برگشتی دانشجویان محدود به مقدار درخواستی می‌شود. در صورت مشخص نشدن، ارسال‌ها صرف نظر از مقدار late ، بازگردانده می‌شوند.

pageSize

integer

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

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

pageToken

string

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

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

previewVersion

enum ( PreviewVersion )

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

درخواست بدنه

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

بدنه پاسخ

پاسخ هنگام فهرست کردن مطالب ارسالی دانشجویان.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "studentSubmissions": [
    {
      object (StudentSubmission)
    }
  ],
  "nextPageToken": string
}
فیلدها
studentSubmissions[]

object ( StudentSubmission )

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

nextPageToken

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

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

مقادیر دیرهنگام

محدودیت‌های مربوط به ارزش دیرکرد اقلام مرجوعی.

انوم‌ها
LATE_VALUES_UNSPECIFIED هیچ محدودیتی برای مقادیر با تأخیر در ارسال مشخص نشده است.
LATE_ONLY در جایی که late مقدار true دارد، StudentSubmissions را برگردان.
NOT_LATE_ONLY در صورتی که مقدار late برابر با false باشد، StudentSubmissions را برمی‌گرداند.