Method: courses.students.get

دانشجوی یک دوره را برمی گرداند.

این روش کدهای خطای زیر را برمی گرداند:

  • PERMISSION_DENIED اگر کاربر درخواست کننده مجاز به مشاهده دانشجویان این دوره یا خطاهای دسترسی نباشد.
  • NOT_FOUND اگر هیچ دانشجوی این دوره شناسه درخواستی را نداشته باشد یا دوره وجود نداشته باشد.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
course Id

string

شناسه دوره این شناسه می تواند شناسه اختصاص داده شده توسط Classroom یا alias باشد.

user Id

string

شناسه دانش آموز برای بازگشت. شناسه می تواند یکی از موارد زیر باشد:

  • شناسه عددی برای کاربر
  • آدرس ایمیل کاربر
  • رشته تحت اللفظی "me" که کاربر درخواست کننده را نشان می دهد

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Student است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.