تعرض قائمة بدعوات الأوصياء التي يُسمح للمستخدم الذي قدّم الطلب بعرضها، مع فلترتها حسب المعلَمات المُقدَّمة.
تعرض هذه الطريقة رموز الخطأ التالية:
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 |
رقم تعريف الطالب الذي يتم إرجاع دعوات الأوصياء إليه. يمكن أن يكون المعرّف واحدًا مما يلي:
|
معلمات طلب البحث
المَعلمات | |
---|---|
invitedEmailAddress |
إذا تم تحديدها، لن يتم عرض سوى النتائج ذات |
states[] |
إذا تم تحديدها، لن يتم عرض سوى النتائج ذات قيم |
pageToken |
تم عرض قيمة ويجب أن يكون طلب |
pageSize |
الحدّ الأقصى لعدد السلع المطلوب إرجاعها يشير الخيار "صفر" أو "غير محدّد" إلى أنّ الخادم قد يعيّن حدًّا أقصى. قد يعرض الخادم عددًا أقل من عدد النتائج المحدّد. |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
الردّ عند إدراج دعوات الأوصياء
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"guardianInvitations": [
{
object ( |
الحقول | |
---|---|
guardianInvitations[] |
دعوات الأوصياء التي تطابقت مع طلب القائمة |
nextPageToken |
رمز مميز يحدد الصفحة التالية من النتائج المطلوب عرضها إذا كان هذا الحقل فارغًا، لن يتم توفير أي نتائج أخرى. |
نطاقات التفويض
يتطلب استخدام أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
لمزيد من المعلومات، راجِع دليل التفويض.