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

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