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 दिया गया है, तो सिर्फ़ उस invitedEmailAddress वाले नतीजे दिखाए जाते हैं.
states[]

enum (GuardianInvitationState)

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

string

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

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

integer

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

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

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

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

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

अभिभावक के न्योते की सूची बनाते समय मिलने वाला जवाब.

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

JSON के काेड में दिखाना 
{
  "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

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