Method: userProfiles.guardianInvitations.list

यह विकल्प, अभिभावक के उन न्योतों की सूची दिखाता है जिन्हें अनुरोध करने वाले उपयोगकर्ता के पास देखने की अनुमति है. यह सूची, दिए गए पैरामीटर के हिसाब से फ़िल्टर की जाती है.

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

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

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

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

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

पाथ के पैरामीटर

पैरामीटर
studentId

string

उस छात्र/छात्रा का आईडी जिसके अभिभावक को न्योता भेजना है. आइडेंटिफ़ायर इनमें से कोई एक हो सकता है:

  • उपयोगकर्ता के लिए न्यूमेरिक आइडेंटिफ़ायर
  • उपयोगकर्ता का ईमेल पता
  • स्ट्रिंग लिटरल "me", जो अनुरोध करने वाले उपयोगकर्ता को दिखाती है
  • स्ट्रिंग की लिटरल "-", जो यह बताती है कि सभी छात्र-छात्राओं को नतीजे दिखाए जाने चाहिए कि अनुरोध करने वाले उपयोगकर्ता के पास अभिभावक के न्योते देखने की अनुमति है.

क्वेरी पैरामीटर

पैरामीटर
invitedEmailAddress

string

तय किए जाने पर, सिर्फ़ तय invitedEmailAddress वाले नतीजे दिखाए जाते हैं.
states[]

enum (GuardianInvitationState)

तय किए जाने पर, सिर्फ़ तय state वैल्यू वाले नतीजे दिखाए जाते हैं. ऐसा न होने पर, PENDING के state वाले नतीजे मिलते हैं.
pageToken

string

पिछले list कॉल से nextPageToken वैल्यू मिली है, जिससे पता चलता है कि नतीजों का अगला पेज दिखना चाहिए.

list के लिए किया गया अनुरोध, उस अनुरोध के जैसा होना चाहिए जिससे यह टोकन मिला था.
pageSize

integer

लौटाए जाने वाले आइटम की ज़्यादा से ज़्यादा संख्या. शून्य या अनिर्दिष्ट यह बताता है कि सर्वर अधिकतम सीमा असाइन कर सकता है.

सर्वर तय संख्या से कम नतीजे दिखा सकता है.

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

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

जवाब का मुख्य भाग

अभिभावक के न्योतों की सूची दिखाने पर जवाब देना.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
guardianInvitations[]

object (GuardianInvitation)

अभिभावकों को दिए जाने वाले न्योते, जो सूची में दिए गए अनुरोध से मेल खाते हैं.
nextPageToken

string

वापस आने वाले नतीजों के अगले पेज की पहचान करने वाला टोकन. अगर खाली है, तो और नतीजे उपलब्ध नहीं होंगे.

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

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

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

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