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 Transcode.

معلّمات المسار

المعلّمات
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

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