Method: courses.students.create

किसी उपयोगकर्ता को कोर्स में छात्र के तौर पर जोड़ता है.

डोमेन एडमिन, अपने डोमेन के उपयोगकर्ताओं को सीधे तौर पर अपने डोमेन के कोर्स में छात्र/छात्रा के तौर पर जोड़ सकते हैं. छात्र-छात्राओं को कोर्स में शामिल होने के लिए, रजिस्ट्रेशन कोड का इस्तेमाल करके खुद को जोड़ने की अनुमति होती है.

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

  • PERMISSION_DENIED अगर अनुरोध करने वाले उपयोगकर्ता को इस कोर्स में छात्र-छात्राओं को जोड़ने की अनुमति नहीं है या ऐक्सेस से जुड़ी गड़बड़ियों की वजह से.
  • NOT_FOUND अगर अनुरोध किया गया कोर्स आईडी मौजूद नहीं है.
  • FAILED_PRECONDITION अगर अनुरोध किए गए उपयोगकर्ता का खाता बंद है, तो इन अनुरोध से जुड़ी गड़बड़ियों के लिए:
    • CourseMemberLimitReached
    • CourseNotModifiable
    • UserGroupsMembershipLimitReached
    • InactiveCourseOwner
  • ALREADY_EXISTS अगर उपयोगकर्ता पहले से ही कोर्स में छात्र या शिक्षक है.

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

POST https://classroom.googleapis.com/v1/courses/{courseId}/students

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

पाथ पैरामीटर

पैरामीटर
courseId

string

उस कोर्स का आइडेंटिफ़ायर जिसमें छात्र/छात्रा को जोड़ना है. यह आइडेंटिफ़ायर, Classroom से असाइन किया गया आइडेंटिफ़ायर या alias हो सकता है.

क्वेरी पैरामीटर

पैरामीटर
enrollmentCode

string

उस कोर्स का रजिस्ट्रेशन कोड जिसमें छात्र/छात्रा को जोड़ना है. अगर userId, अनुरोध करने वाले उपयोगकर्ता से जुड़ा है, तो यह कोड ज़रूरी है. अगर अनुरोध करने वाले उपयोगकर्ता के पास किसी भी उपयोगकर्ता के लिए छात्र बनाने की एडमिन अनुमतियां हैं, तो इस कोड को छोड़ा जा सकता है.

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

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

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

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

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

इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

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