Method: courses.courseWork.list

यह फ़ंक्शन उस कोर्स वर्क की सूची दिखाता है जिसे देखने का अनुरोध करने वाले के पास अनुमति है.

कोर्स के छात्र-छात्राएं सिर्फ़ PUBLISHED कोर्स वर्क देख सकते हैं. कोर्स के शिक्षक और डोमेन एडमिन, कोर्स के सभी काम देख सकते हैं.

इस तरीके से ये गड़बड़ी कोड मिलते हैं:

  • PERMISSION_DENIED, अगर अनुरोध करने वाले उपयोगकर्ता को, अनुरोध किए गए कोर्स या ऐक्सेस से जुड़ी गड़बड़ियों को ऐक्सेस करने की अनुमति नहीं है.
  • INVALID_ARGUMENT, अगर अनुरोध गलत तरीके से किया गया है.
  • अगर अनुरोध किया गया कोर्स मौजूद नहीं है, तो NOT_FOUND.

एचटीटीपी अनुरोध

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

यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

पैरामीटर
courseId

string

कोर्स का आइडेंटिफ़ायर. यह आइडेंटिफ़ायर, Classroom से असाइन किया गया आइडेंटिफ़ायर या alias हो सकता है.

क्वेरी पैरामीटर

पैरामीटर
courseWorkStates[]

enum (CourseWorkState)

वापस करने के लिए काम की स्थिति पर प्रतिबंध. सिर्फ़ CourseWork की वैल्यू दिखाई जाती है जो मेल खाती है. अगर कोई जानकारी नहीं दी गई, तो PUBLISHED काम करने की स्थिति वाले आइटम लौटाए जाते हैं.

orderBy

string

नतीजों को क्रम से लगाने का वैकल्पिक तरीका. फ़ील्ड की कॉमा-सेपरेटेड लिस्ट, जिसमें वैकल्पिक क्रम में लगाने की दिशा बताने वाला कीवर्ड होता है. updateTime और dueDate को फ़ील्ड में इस्तेमाल किया जा सकता है. asc और desc इस्तेमाल किए जा सकते हैं. अगर कोई वैल्यू तय नहीं की गई है, तो updateTime desc डिफ़ॉल्ट तरीका होता है. उदाहरण: dueDate asc,updateTime desc, updateTime,dueDate desc

pageSize

integer

लौटाए जाने वाले आइटम की ज़्यादा से ज़्यादा संख्या. शून्य या अनिर्दिष्ट यह बताता है कि सर्वर अधिकतम सीमा असाइन कर सकता है.

सर्वर तय संख्या से कम नतीजे दिखा सकता है.

pageToken

string

पिछले list कॉल से nextPageToken वैल्यू मिली है, जिससे पता चलता है कि नतीजों का अगला पेज दिखना चाहिए.

list के लिए किया गया अनुरोध, उस अनुरोध के जैसा होना चाहिए जिससे यह टोकन मिला था.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

कोर्स के काम की सूची बनाने पर जवाब देना.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना
{
  "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

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.