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