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 مطابقًا للطلب الذي نتج عنه هذا الرمز المميّز.
previewVersion

enum (PreviewVersion)

اختياريّ. إصدار المعاينة من واجهة برمجة التطبيقات. ويجب ضبط هذا الخيار للوصول إلى إمكانات واجهة برمجة التطبيقات الجديدة المتوفّرة للمطوّرين في "برنامج المعاينة".

نص الطلب

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

نص الاستجابة

هي الاستجابة عند سرد عمل الدورة التدريبية.

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

تمثيل 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

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.