REST Resource: invitations

• সম্পদ: আমন্ত্রণ
  • JSON প্রতিনিধিত্ব
• কোর্সের ভূমিকা
• পদ্ধতি

সম্পদ: আমন্ত্রণ

একটি কোর্সে যোগদানের আমন্ত্রণ।

JSON প্রতিনিধিত্ব
{ "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	আমন্ত্রণগুলির একটি তালিকা ফেরত দেয় যা অনুরোধকারী ব্যবহারকারীকে দেখার অনুমতি দেওয়া হয়, তালিকা অনুরোধের সাথে মেলে সেইগুলির জন্য সীমাবদ্ধ৷