Method: courses.list

অনুরোধকারী ব্যবহারকারী যে কোর্সগুলো দেখার অনুমতি রাখেন, তার একটি তালিকা ফেরত দেয়, যা শুধুমাত্র অনুরোধের সাথে মেলে এমন কোর্সগুলোর মধ্যেই সীমাবদ্ধ থাকে। ফেরত আসা কোর্সগুলো তৈরির সময় অনুসারে সাজানো থাকে, যেখানে সবচেয়ে নতুনটি প্রথমে আসে।

এই পদ্ধতিটি নিম্নলিখিত ত্রুটি কোডগুলি ফেরত দেয়:

  • অ্যাক্সেস ত্রুটির জন্য PERMISSION_DENIED ।
  • কোয়েরি আর্গুমেন্টটি ত্রুটিপূর্ণ হলে INVALID_ARGUMENT
  • কোয়েরি আর্গুমেন্টে উল্লেখিত কোনো ব্যবহারকারী বিদ্যমান না থাকলে NOT_FOUND ।

HTTP অনুরোধ

GET https://classroom.googleapis.com/v1/courses

URL-টিতে gRPC ট্রান্সকোডিং সিনট্যাক্স ব্যবহার করা হয়েছে।

কোয়েরি প্যারামিটার

প্যারামিটার
studentId

string

ফেরত আসা কোর্সগুলোকে শুধুমাত্র সেই কোর্সগুলোর মধ্যে সীমাবদ্ধ করে, যেগুলোতে নির্দিষ্ট শনাক্তকারীযুক্ত শিক্ষার্থী রয়েছে। শনাক্তকারীটি নিম্নলিখিতগুলোর মধ্যে একটি হতে পারে:

  • ব্যবহারকারীর সংখ্যাসূচক শনাক্তকারী
  • ব্যবহারকারীর ইমেল ঠিকানা
  • "me" স্ট্রিং লিটারেলটি, যা অনুরোধকারী ব্যবহারকারীকে নির্দেশ করে।

নির্দিষ্ট করা থাকলে, teacherId অবশ্যই খালি থাকতে হবে।

teacherId

string

ফেরত আসা কোর্সগুলোকে শুধুমাত্র সেই কোর্সগুলোর মধ্যে সীমাবদ্ধ করে, যেগুলোর শিক্ষকের নির্দিষ্ট শনাক্তকারী রয়েছে। শনাক্তকারীটি নিম্নলিখিতগুলোর মধ্যে একটি হতে পারে:

  • ব্যবহারকারীর সংখ্যাসূচক শনাক্তকারী
  • ব্যবহারকারীর ইমেল ঠিকানা
  • "me" স্ট্রিং লিটারেলটি, যা অনুরোধকারী ব্যবহারকারীকে নির্দেশ করে।

নির্দিষ্ট করা থাকলে, studentId অবশ্যই খালি থাকতে হবে।

courseStates[]

enum ( CourseState )

ফেরত আসা কোর্সগুলোকে নির্দিষ্ট অবস্থাগুলোর কোনো একটিতে থাকা কোর্সের মধ্যে সীমাবদ্ধ রাখে। ডিফল্ট মানগুলো হলো ACTIVE, ARCHIVED, PROVISIONED, DECLINED।

pageSize

integer

ফেরতযোগ্য আইটেমের সর্বোচ্চ সংখ্যা। শূন্য বা অনির্দিষ্ট থাকলে বোঝা যায় যে, সার্ভার একটি সর্বোচ্চ সংখ্যা নির্ধারণ করে দিতে পারে।

সার্ভার নির্দিষ্ট সংখ্যার চেয়ে কম ফলাফল ফেরত দিতে পারে।

pageToken

string

পূর্ববর্তী list কল থেকে ফেরত আসা nextPageToken মান, যা নির্দেশ করে যে ফলাফলের পরবর্তী পৃষ্ঠাটি ফেরত দেওয়া উচিত।

list অনুরোধটি অবশ্যই সেই অনুরোধের সাথে অন্যথায় অভিন্ন হতে হবে যার ফলে এই টোকেনটি তৈরি হয়েছে।

অনুরোধকারী শরীর

অনুরোধের মূল অংশ অবশ্যই খালি হতে হবে।

প্রতিক্রিয়া সংস্থা

কোর্স তালিকাভুক্ত করার সময় প্রাপ্ত প্রতিক্রিয়া।

সফল হলে, প্রতিক্রিয়া অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:

JSON উপস্থাপনা 
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
ক্ষেত্র
courses[]

object ( Course )

তালিকা অনুরোধের সাথে মেলে এমন কোর্সসমূহ।

nextPageToken

string

পরবর্তী ফলাফল পৃষ্ঠা শনাক্তকারী টোকেন। এটি খালি থাকলে, আর কোনো ফলাফল পাওয়া যাবে না।

অনুমোদনের পরিধি

নিম্নলিখিত OAuth স্কোপগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

আরও তথ্যের জন্য, অনুমোদন নির্দেশিকা দেখুন।