Method: userProfiles.guardians.get

تعرض وصيًا محددًا.

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

  • PERMISSION_DENIED إذا لم يظهر للمستخدم الذي قدّم الطلب أي مستخدم يتطابق مع studentId المقدَّم، أو إذا لم يكن مسموحًا للمستخدم الذي قدّم الطلب بالاطّلاع على معلومات الوصي الخاصة بالطالب المحدد من خلال studentId، أو في حال عدم تفعيل الأوصياء للنطاق المعنيّ، أو بسبب أخطاء أخرى في الوصول.
  • INVALID_ARGUMENT إذا تم تحديد studentId، ولكن لا يمكن التعرّف على تنسيقه (ليس عنوان بريد إلكتروني أو studentId من واجهة برمجة التطبيقات أو السلسلة الحرفية me).
  • NOT_FOUND إذا كان مسموحًا للمستخدم الذي قدّم الطلب بالاطّلاع على الأوصياء على studentId المطلوب، ولكن لا يتوفّر سجلّ Guardian لهذا الطالب الذي يتطابق مع guardianId المقدَّم.

طلب HTTP

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

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

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

المَعلمات
studentId

string

الطالب الذي يُطلب من الوصي عليه. يجب استخدام إحدى السمات التالية:

  • المعرّف الرقمي للمستخدم
  • عنوان البريد الإلكتروني للمستخدم
  • القيمة الحرفية للسلسلة "me"، ما يشير إلى المستخدم الذي قدّم الطلب
guardianId

string

الحقل id من Guardian.

نص الطلب

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

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Guardian.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

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