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)

זה שינוי אופציונלי. גרסת התצוגה המקדימה של ה-API. צריך להגדיר את האפשרות הזו כדי לקבל גישה ליכולות חדשות של API שזמינות למפתחים בתוכנית התצוגה המקדימה.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

תשובה בעת הצגת העבודה בקורס.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג 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

מידע נוסף זמין במדריך להרשאות.