- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- इसे आज़माएं!
किसी खास अभिभावक की जानकारी दिखाता है.
इस तरीके से, गड़बड़ी के ये कोड मिलते हैं:
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 |
वह छात्र/छात्रा जिसके अभिभावक को न्योता भेजा जा रहा है. निम्न में से एक:
|
guardianId |
|
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य हिस्सा
कामयाब रहने पर, जवाब के मुख्य हिस्से में Guardian का एक इंस्टेंस शामिल किया जाता है.
अनुमति के दायरे
इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonlyhttps://www.googleapis.com/auth/classroom.guardianlinks.students.readonlyhttps://www.googleapis.com/auth/classroom.guardianlinks.students
ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.