Method: userProfiles.guardianInvitations.get

تعرض دعوة معيّنة للأوصياء.

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

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

طلب HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

يستخدم عنوان URL بنية gRPC Transcode.

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

المعلّمات
studentId

string

رقم تعريف الطالب الذي يُطلب منه دعوة الوصي

invitationId

string

الحقل id من GuardianInvitation المطلوب.

نص الطلب

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

نص الاستجابة

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

نطاقات الأذونات

يتطلب ذلك أحد نطاقات OAuth التالية:

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

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