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

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