Method: courses.studentGroups.patch

छात्र-छात्राओं के ग्रुप में एक या उससे ज़्यादा फ़ील्ड अपडेट करता है.

यह तरीका, गड़बड़ी के ये कोड दिखाता है:

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

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

PATCH https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{id}

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

पाथ पैरामीटर

पैरामीटर
courseId

string

ज़रूरी है. कोर्स का आइडेंटिफ़ायर.
id

string

ज़रूरी है. छात्र-छात्राओं के ग्रुप का आइडेंटिफ़ायर.

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

पैरामीटर
updateMask

string (FieldMask format)

ज़रूरी है. मास्क, यह तय करता है कि छात्र-छात्राओं के ग्रुप के किन फ़ील्ड को अपडेट करना है. अपडेट करने के लिए, यह फ़ील्ड भरना ज़रूरी है. अगर अमान्य फ़ील्ड दिए जाते हैं, तो अपडेट नहीं हो पाता.

शिक्षक इन फ़ील्ड की जानकारी दे सकते हैं:

  • title

यह फ़ील्ड के पूरी तरह से क्वालिफ़ाइड नामों की कॉमा से अलग की गई सूची है. उदाहरण: "user.displayName,photo".
previewVersion

enum (PreviewVersion)

ज़रूरी नहीं. एंडपॉइंट का प्रीव्यू वर्शन. इसे सेट करना ज़रूरी है, ताकि डेवलपर को Preview Program में उपलब्ध कराई गई नई एपीआई सुविधाओं का ऐक्सेस मिल सके.

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

अनुरोध के मुख्य भाग में StudentGroup का उदाहरण है.

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

कामयाब रहने पर, जवाब के मुख्य हिस्से में StudentGroup का एक इंस्टेंस शामिल किया जाता है.

अनुमति के स्कोप

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/classroom.rosters

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