- एचटीटीपी अनुरोध
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति के दायरे
- इसे आज़माएं!
उन न्योतों की सूची दिखाता है जिन्हें देखने का अनुरोध करने वाले उपयोगकर्ता को अनुमति है. यह सिर्फ़ सूची के अनुरोध से मेल खाने वाले न्योतों की सूची दिखाता है.
ध्यान दें: userId
या courseId
में से कम से कम एक दिया जाना चाहिए. दोनों फ़ील्ड दिए जा सकते हैं.
इस तरीके से गड़बड़ी के ये कोड दिखते हैं:
- ऐक्सेस से जुड़ी गड़बड़ियों के लिए
PERMISSION_DENIED
.
एचटीटीपी अनुरोध
GET https://classroom.googleapis.com/v1/invitations
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
userId |
इससे किसी खास उपयोगकर्ता को मिलने वाले न्योते पर पाबंदी लग जाती है. आइडेंटिफ़ायर इनमें से कोई एक हो सकता है:
|
courseId |
तय करता है कि किसी खास आइडेंटिफ़ायर वाले कोर्स के लिए, न्योते वाले न्योते नहीं दिखाए जाएंगे. |
pageSize |
लौटाने के लिए आइटम की ज़्यादा से ज़्यादा संख्या. अगर कोई वैल्यू नहीं दी गई है, तो डिफ़ॉल्ट वैल्यू 500 होती है या सर्वर, तय की गई संख्या से कम नतीजे दिखा सकता है. |
pageToken |
पिछले
|
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
न्योते की सूची बनाते समय जवाब देना.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
JSON के काेड में दिखाना |
---|
{
"invitations": [
{
object ( |
फ़ील्ड | |
---|---|
invitations[] |
सूची के अनुरोध से मेल खाने वाले न्योते. |
nextPageToken |
टोकन, जो दिखाए जाने वाले नतीजों के अगले पेज की पहचान करता है. अगर यह फ़ील्ड खाली है, तो कोई और नतीजा नहीं मिलेगा. |
अनुमति के दायरे
इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.