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 नहीं होनी चाहिए.

कोर्स की भूमिका

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

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

तरीके

accept

न्योता स्वीकार करने, उसे हटाने, और चुने गए कोर्स के टीचर या छात्र-छात्राओं को जोड़ने में मदद मिलती है.

create

न्योता बनाएं.

delete

न्योता मिटाएं.

get

न्योता भेजता है.

list

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