Method: courses.patch

किसी कोर्स के एक या उससे ज़्यादा फ़ील्ड अपडेट करता है.

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

  • PERMISSION_DENIED अगर अनुरोध करने वाले उपयोगकर्ता को, अनुरोध किए गए कोर्स में बदलाव करने की अनुमति नहीं है या ऐक्सेस से जुड़ी गड़बड़ियां हैं.
  • अगर अनुरोध किए गए आईडी वाला कोई कोर्स मौजूद नहीं है, तो NOT_FOUND.
  • अगर अपडेट मास्क में अमान्य फ़ील्ड तय किए गए हैं या कोई अपडेट मास्क नहीं दिया गया है, तो INVALID_ARGUMENT.
  • अनुरोध में गड़बड़ी होने पर, FAILED_PRECONDITION निम्नलिखित अनुरोध में गड़बड़ी:
    • CourseNotModifiable
    • InactiveCourseOwner
    • IneligibleOwner
    • CourseTitleCannotContainUrl

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

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

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

पाथ पैरामीटर

पैरामीटर
id

string

अपडेट किए जाने वाले कोर्स का आइडेंटिफ़ायर. यह आइडेंटिफ़ायर, Classroom की ओर से असाइन किया गया आइडेंटिफ़ायर या कोई alias हो सकता है.

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

पैरामीटर
updateMask

string (FieldMask format)

मास्क, जिससे यह पता चलता है कि कोर्स के किन फ़ील्ड को अपडेट करना है. अपडेट करने के लिए, यह फ़ील्ड ज़रूरी है. अगर अमान्य फ़ील्ड तय किए जाते हैं, तो अपडेट नहीं हो पाएगा. ये फ़ील्ड मान्य हैं:

  • courseState
  • description
  • descriptionHeading
  • name
  • ownerId
  • room
  • section
  • subject
  • learningStandardSettings
  • levels

ध्यान दें: ownerId में किए गए बदलाव तुरंत लागू हो जाते हैं. हालांकि, असल में, इससे जुड़े सभी संसाधनों का मालिकाना हक ट्रांसफ़र होने में कुछ समय लग सकता है.

क्वेरी पैरामीटर में सेट होने पर, इस फ़ील्ड को इस तरह तय किया जाना चाहिए

updateMask=<field1>,<field2>,...

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

enum (PreviewVersion)

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

अनुरोध का मुख्य हिस्सा

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

जवाब का मुख्य हिस्सा

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

अनुमति पाने के लिंक

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

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

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