Method: userProfiles.guardianInvitations.patch

अभिभावक को भेजे गए न्योते में बदलाव करता है.

फ़िलहाल, state को PENDING से COMPLETE में बदलना ही मान्य बदलाव है. इससे न्योता वापस ले लिया जाता है.

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

  • PERMISSION_DENIED अगर मौजूदा उपयोगकर्ता के पास, अभिभावकों को मैनेज करने की अनुमति नहीं है, तो सवाल में दिए गए डोमेन के लिए अभिभावक की सुविधा चालू नहीं है या ऐक्सेस से जुड़ी अन्य गड़बड़ियों की वजह से ऐसा हो सकता है.
  • FAILED_PRECONDITION अगर अभिभावक का लिंक PENDING स्टेटस में नहीं है.
  • INVALID_ARGUMENT अगर छात्र/छात्रा के दिए गए आईडी के फ़ॉर्मैट की पहचान नहीं की जा सकती (यह ईमेल पता नहीं है और न ही इस एपीआई से मिला userId है), या सबमिट किए गए GuardianInvitation में COMPLETE के अलावा कोई दूसरा state है या state के अलावा किसी दूसरे फ़ील्ड में बदलाव किया गया है.
  • NOT_FOUND अगर दिया गया स्टूडेंट आईडी मान्य है, लेकिन Classroom में उस छात्र/छात्रा का कोई रिकॉर्ड नहीं है या id फ़ील्ड में, Classroom के पास मौजूद अभिभावक के न्योते का रेफ़रंस नहीं है.

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

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

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

पाथ पैरामीटर

पैरामीटर
studentId

string

उस छात्र/छात्रा का आईडी जिसकी अभिभावक के लिए भेजे गए न्योते में बदलाव करना है.
invitationId

string

GuardianInvitation का id फ़ील्ड, जिसमें बदलाव करना है.

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

पैरामीटर
updateMask

string (FieldMask format)

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

  • state

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

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

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

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

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

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

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

अनुमति के दायरे

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

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

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