- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- इसे आज़माएं!
किसी खास अभिभावक की जानकारी दिखाता है.
इस तरीके से, गड़बड़ी के ये कोड मिलते हैं:
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 ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
पैरामीटर | |
---|---|
student |
वह छात्र/छात्रा जिसके अभिभावक से अनुरोध किया जा रहा है. निम्न में से एक:
|
guardian |
|
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य हिस्सा
कामयाब रहने पर, जवाब के मुख्य हिस्से में 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
ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.