Method: userProfiles.guardians.get

किसी खास अभिभावक की जानकारी दिखाता है.

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

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

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

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

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

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

पैरामीटर
studentId

string

जिस छात्र/छात्रा के अभिभावक से अनुरोध किया गया है. इनमें से कोई एक:

  • उपयोगकर्ता के लिए न्यूमेरिक आइडेंटिफ़ायर
  • उपयोगकर्ता का ईमेल पता
  • स्ट्रिंग लिटरल "me", जो अनुरोध करने वाले उपयोगकर्ता को दिखाती है
guardianId

string

Guardian का id फ़ील्ड.

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

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

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

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

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

इनमें से कोई एक OAuth स्कोप ज़रूरी है:

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

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