REST Resource: invitations

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

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

JSON के काेड में दिखाना 
{
  "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

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