- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति के दायरे
- इसे आज़माएं!
यह विकल्प, अभिभावक के उन न्योतों की सूची दिखाता है जिन्हें अनुरोध करने वाले उपयोगकर्ता के पास देखने की अनुमति है. यह सूची, दिए गए पैरामीटर के हिसाब से फ़िल्टर की जाती है.
इस तरीके से ये गड़बड़ी कोड मिलते हैं:
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 |
उस छात्र/छात्रा का आईडी जिसके अभिभावक को न्योता भेजना है. आइडेंटिफ़ायर इनमें से कोई एक हो सकता है:
|
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
invitedEmailAddress |
तय किए जाने पर, सिर्फ़ तय |
states[] |
तय किए जाने पर, सिर्फ़ तय |
pageToken |
पिछले
|
pageSize |
लौटाए जाने वाले आइटम की ज़्यादा से ज़्यादा संख्या. शून्य या अनिर्दिष्ट यह बताता है कि सर्वर अधिकतम सीमा असाइन कर सकता है. सर्वर तय संख्या से कम नतीजे दिखा सकता है. |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
अभिभावक के न्योतों की सूची दिखाने पर जवाब देना.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
जेएसओएन के काेड में दिखाना |
---|
{
"guardianInvitations": [
{
object ( |
फ़ील्ड | |
---|---|
guardianInvitations[] |
अभिभावकों को दिए जाने वाले न्योते, जो सूची में दिए गए अनुरोध से मेल खाते हैं. |
nextPageToken |
वापस आने वाले नतीजों के अगले पेज की पहचान करने वाला टोकन. अगर खाली है, तो और नतीजे उपलब्ध नहीं होंगे. |
अनुमति देने के दायरे
इनमें से कोई एक OAuth स्कोप ज़रूरी है:
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.