Method: courses.courseWork.list

تعرض قائمة بأعمال الدورة الدراسية التي يُسمح لمقدّم الطلب بعرضها.

يمكن لطلاب الدورة التدريبية الاطّلاع على عمل واحد (PUBLISHED) فقط. يمكن لمعلّمي الدورة التدريبية ومشرفي النطاق الاطّلاع على جميع أعمال الدورة التدريبية.

تعرض هذه الطريقة رموز الخطأ التالية:

  • PERMISSION_DENIED إذا لم يكن مسموحًا للمستخدم الذي قدّم الطلب بالوصول إلى الدورة التدريبية المطلوبة أو بسبب أخطاء في الوصول.
  • INVALID_ARGUMENT إذا كان الطلب مكتوبًا بشكلٍ غير صحيح.
  • NOT_FOUND إذا لم تكن الدورة التدريبية المطلوبة متوفّرة.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
courseId

string

معرّف الدورة التدريبية. ويمكن أن يكون هذا المعرّف إمّا المعرّف الذي حدّده Classroom أو alias.

معلمات طلب البحث

المَعلمات
courseWorkStates[]

enum (CourseWorkState)

فرض قيود على حالة العمل المطلوب إرجاعها. لا يتم عرض سوى ناتج الدورة التدريبية الذي يطابقه. في حال عدم تحديد هذه السمة، يتم إرجاع السلع التي تكون حالة عملها هي PUBLISHED.
orderBy

string

ترتيب اختياري للنتائج قائمة حقول مفصولة بفواصل مع كلمة رئيسية اختيارية لتوجيه الترتيب. الحقلان المسموح بإدراجهما هما updateTime وdueDate. الكلمات الرئيسية المسموح بها للاتجاهات هما asc وdesc. إذا لم يتم تحديد السياسة، سيكون updateTime desc هو السلوك التلقائي. أمثلة: dueDate asc,updateTime desc وupdateTime,dueDate desc
pageSize

integer

الحدّ الأقصى لعدد السلع المطلوب إرجاعها يشير الخيار "صفر" أو "غير محدّد" إلى أنّ الخادم قد يعيّن حدًّا أقصى.

قد يعرض الخادم عددًا أقل من عدد النتائج المحدّد.
pageToken

string

تم عرض قيمة nextPageToken من استدعاء list سابق، للإشارة إلى أنه يجب عرض صفحة النتائج اللاحقة.

ويجب أن يكون طلب list مطابقًا للطلب الذي أدى إلى إنشاء هذا الرمز المميّز.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

رد عند إدراج عمل الدورة الدراسية.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "courseWork": [
    {
      object (CourseWork)
    }
  ],
  "nextPageToken": string
}
الحقول
courseWork[]

object (CourseWork)

عناصر عمل الدورة الدراسية التي تطابق الطلب.
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

لمزيد من المعلومات، راجِع دليل التفويض.