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

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