Method: invitations.create

एक न्योता बनाता है. किसी उपयोगकर्ता और कोर्स के लिए एक बार में सिर्फ़ एक न्योता हो सकता है. बदलाव करने के लिए कोई न्योता मिटाएं और उसे फिर से बनाएं.

इस तरीके से ये गड़बड़ी कोड मिलते हैं:

  • PERMISSION_DENIED, अगर अनुरोध करने वाले उपयोगकर्ता को इस कोर्स या ऐक्सेस से जुड़ी गड़बड़ियों के लिए न्योते बनाने की अनुमति नहीं है.
  • NOT_FOUND, अगर कोर्स या उपयोगकर्ता मौजूद न हो.
  • FAILED_PRECONDITION:
    • अगर अनुरोध किए गए उपयोगकर्ता का खाता बंद कर दिया गया है.
    • अगर उपयोगकर्ता के पास पहले से ही यह भूमिका है या ज़्यादा अनुमतियों वाली कोई भूमिका है.
    • अनुरोध से जुड़ी गड़बड़ियों के लिए:
      • IneligibleOwner
  • ALREADY_EXISTS, अगर खास उपयोगकर्ता और कोर्स के लिए न्योता पहले से मौजूद है.

एचटीटीपी अनुरोध

POST https://classroom.googleapis.com/v1/invitations

यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

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

अनुरोध के मुख्य भाग में Invitation का उदाहरण है.

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

कामयाब होने पर, रिस्पॉन्स के मुख्य हिस्से में Invitation का नया इंस्टेंस शामिल किया जाता है.

अनुमति देने के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/classroom.rosters

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