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)

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

  • name
  • section
  • descriptionHeading
  • description
  • room
  • courseState
  • ownerId

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

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

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

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

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

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

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

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

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

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

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

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