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

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