REST Resource: invitations

संसाधन: न्योता

कोर्स में शामिल होने का न्योता.

जेएसओएन के काेड में दिखाना
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
फ़ील्ड
id

string

Classroom ने आइडेंटिफ़ायर को असाइन किया है.

सिर्फ़ पढ़ने के लिए.

userId

string

न्योता पाने वाले उपयोगकर्ता का आइडेंटिफ़ायर.

अनुरोध के पैरामीटर के तौर पर तय किए जाने पर, इस आइडेंटिफ़ायर को इनमें से किसी एक पर सेट किया जा सकता है:

  • उपयोगकर्ता के लिए न्यूमेरिक आइडेंटिफ़ायर
  • उपयोगकर्ता का ईमेल पता
  • स्ट्रिंग लिटरल "me", जो अनुरोध करने वाले उपयोगकर्ता को दिखाती है
courseId

string

लोगों को न्योता भेजने के लिए, कोर्स का आइडेंटिफ़ायर.

role

enum (CourseRole)

उपयोगकर्ता को आमंत्रित करने के लिए भूमिका. COURSE_ROLE_UNSPECIFIED नहीं होना चाहिए.

CourseRole

ऐसी संभावित भूमिकाएं जिन्हें पूरा करने के लिए किसी उपयोगकर्ता को न्योता भेजा जा सकता है.

Enums
COURSE_ROLE_UNSPECIFIED कोर्स में कोई भूमिका नहीं मिली.
STUDENT कोर्स में शामिल छात्र/छात्रा.
TEACHER पाठ्यक्रम का शिक्षक.
OWNER कोर्स का मालिक.

तरीके

accept

न्योता स्वीकार करता है और उसे हटाकर, न्योता पाने वाले उपयोगकर्ता को किसी खास कोर्स के शिक्षकों या छात्र-छात्राओं (जहां ज़रूरी हो) में जोड़ देता है.

create

एक न्योता बनाता है.

delete

न्योते को मिटा देता है.

get

न्योता लौटाता है.

list

उन न्योतों की सूची दिखाता है जिन्हें अनुरोध करने वाले उपयोगकर्ता के पास देखने की अनुमति है. यह सूची सिर्फ़ उन न्योतों की सूची होती है जो सूची के अनुरोध से मेल खाते हैं.