Method: userProfiles.guardianInvitations.list

عرض قائمة بدعوات الأوصياء التي يُسمح للمستخدم مقدِّم الطلب بالاطّلاع عليها، مع فلترتها حسب المَعلمات المقدَّمة

تُرجع هذه الطريقة رموز الخطأ التالية:

  • PERMISSION_DENIED في حال تحديد studentId، وعدم السماح للمستخدم الذي قدّم الطلب بالاطّلاع على دعوات الأوصياء لهذا الطالب، إذا تم تحديد "-" على أنّه studentId ولم يكن المستخدم مشرفًا للنطاق، أو إذا لم يتم تفعيل الأوصياء في النطاق المعنيّ، أو بسبب أخطاء الوصول الأخرى.
  • INVALID_ARGUMENT إذا تم تحديد studentId، ولكن لا يمكن التعرّف على تنسيقه (ليس عنوان بريد إلكتروني، ولا studentId من واجهة برمجة التطبيقات، ولا السلسلة الحرفية me). قد تُرجع أيضًا إذا تم تقديم pageToken أو state غير صالحَين.
  • NOT_FOUND إذا تم تحديد studentId، ويمكن التعرّف على تنسيقه، ولكن ليس لدى Classroom سجلّ لهذا الطالب.

طلب HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
studentId

string

رقم تعريف الطالب الذي سيتم عرض دعوات الأوصياء عليه يمكن أن يكون المعرّف واحدًا مما يلي:

  • المعرّف الرقمي للمستخدم
  • عنوان البريد الإلكتروني للمستخدم
  • السلسلة الحرفية "me"، للإشارة إلى المستخدم صاحب الطلب
  • السلسلة الحرفية "-"، ما يشير إلى أنّه يجب عرض النتائج لجميع الطلاب أنّ المستخدم الذي قدّم الطلب مسموح له بالاطّلاع على دعوات الأوصياء

معامِلات طلب البحث

المعلمات
invitedEmailAddress

string

وفي حال تحديدها، سيتم فقط عرض النتائج ذات السمة invitedEmailAddress المحددة.
states[]

enum (GuardianInvitationState)

وفي حال تحديدها، لن يتم عرض سوى النتائج ذات قيم state المحدَّدة. وبخلاف ذلك، يتم عرض النتائج التي تحتوي على state من PENDING.
pageToken

string

قيمة nextPageToken التي تم عرضها من طلب list سابق، للإشارة إلى أنه يجب عرض صفحة النتائج اللاحقة.

يجب أن يكون طلب list مطابقًا للطلب الذي نتج عنه هذا الرمز المميّز.
pageSize

integer

الحدّ الأقصى لعدد السلع المطلوب إرجاعها يشير "صفر" أو "غير محدَّد" إلى أنّ الخادم قد يعيّن حدًا أقصى.

قد يعرض الخادم عددًا أقل من العدد المحدّد من النتائج.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

الاستجابة عند إدراج دعوات الأوصياء

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
الحقول
guardianInvitations[]

object (GuardianInvitation)

دعوات الأوصياء التي تطابق طلب القائمة
nextPageToken

string

رمز مميز يحدد الصفحة التالية من النتائج المطلوب عرضها. إذا كان هذا الحقل فارغًا، لن تتوفّر أي نتائج أخرى.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.