Method: courses.aliases.list

מחזירה רשימת כינויים של קורס.

השיטה הזו מחזירה את קודי השגיאה הבאים:

  • PERMISSION_DENIED אם המשתמש ששלח את הבקשה לא מורשה לגשת לקורס או אם יש שגיאות גישה.
  • NOT_FOUND אם הקורס לא קיים.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
courseId

string

מזהה הקורס. המזהה הזה יכול להיות המזהה שהוקצה על ידי Classroom או alias.

פרמטרים של שאילתה

פרמטרים
pageSize

integer

מספר הפריטים המקסימלי שיוחזרו. הערך 'אפס' או 'לא מוגדר' מציין שהשרת עשוי להקצות מקסימום.

השרת עשוי להחזיר פחות ממספר התוצאות שצוין.
pageToken

string

הערך של nextPageToken הוחזר מקריאה קודמת של list, שמציין שצריך להחזיר את דף התוצאות הבא.

הבקשה של list חייבת להיות זהה בכל מקרה אחר לבקשה שהובילה לאסימון הזה.

גוף הבקשה

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

גוף התשובה

תשובה כשמציגים כינויים של קורסים.

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

ייצוג JSON 
{
  "aliases": [
    {
      object (CourseAlias)
    }
  ],
  "nextPageToken": string
}
שדות
aliases[]

object (CourseAlias)

הכינויים של הקורס.
nextPageToken

string

אסימון המזהה את דף התוצאות הבא שיש להחזיר. אם השדה ריק, אין תוצאות נוספות.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

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