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.

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

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

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