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

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