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

لمزيد من المعلومات، راجِع دليل التفويض.