Method: userProfiles.guardianInvitations.get

किसी खास अभिभावक के लिए भेजा गया न्योता दिखाता है.

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

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

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

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

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

पाथ पैरामीटर

पैरामीटर
studentId

string

उस छात्र/छात्रा का आईडी जिसका अभिभावक/अभिभावक को न्योता भेजने का अनुरोध किया जा रहा है.
invitationId

string

GuardianInvitation का id फ़ील्ड, जिसके लिए अनुरोध किया जा रहा है.

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

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

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

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

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

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

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

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