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