Method: userProfiles.guardianInvitations.get

अभिभावक को न्योता देता है.

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

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

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

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

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