Method: userProfiles.guardianInvitations.create

अभिभावक को न्योता देता है और अभिभावक को ईमेल भेजकर, छात्र/छात्रा के अभिभावक की पुष्टि करने के लिए कहता है.

न्योता स्वीकार करने के बाद, अभिभावक का state बदलकर COMPLETED हो जाएगा और उन्हें अभिभावक से जुड़ी सूचनाएं मिलने लगेंगी. सक्रिय अभिभावक का प्रतिनिधित्व करने के लिए, एक Guardian संसाधन भी बनाया जाएगा.

अनुरोध ऑब्जेक्ट में studentId और invitedEmailAddress फ़ील्ड सेट होने चाहिए. ये फ़ील्ड सेट न कर पाने या अनुरोध में कोई दूसरा फ़ील्ड सेट करने पर, गड़बड़ी हो जाएगी.

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

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

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

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

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

पाथ के पैरामीटर

पैरामीटर
guardianInvitation.studentId

string

छात्र/छात्रा का आईडी (स्टैंडर्ड फ़ॉर्मैट में)

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

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

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

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

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

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

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

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