REST Resource: userProfiles.guardianInvitations

المورد: GuardianInvite

تم إرسال دعوة لتصبح الوصي على المستخدم المحدد إلى عنوان بريد إلكتروني محدد.

تمثيل JSON 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
الحقول
studentId

string

رقم تعريف الطالب (بالتنسيق القياسي)
invitationId

string

المعرّف الفريد لهذه الدعوة.

للقراءة فقط.
invitedEmailAddress

string

عنوان البريد الإلكتروني الذي تم إرسال الدعوة إليه. لا يظهر هذا الحقل إلا لمشرفي النطاق فقط.
state

enum (GuardianInvitationState)

الولاية التي تتضمنها هذه الدعوة.
creationTime

string (Timestamp format)

وقت إنشاء هذه الدعوة.

للقراءة فقط.

طابع زمني بتنسيق RFC3339 UTC "Zulu"، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

حالة الدعوة

حالة دعوة الوصي.

عمليات التعداد
GUARDIAN_INVITATION_STATE_UNSPECIFIED يجب عدم إرجاعها مطلقًا.
PENDING الدعوة نشطة وتنتظر ردًا.
COMPLETE لم تعد الدعوة نشطة. ربما تمّ قبوله أو رفضه أو سحبه أو انتهت صلاحيته.

الطُرق

create

 ينشئ دعوة وصي، ويرسل رسالة إلكترونية إلى الوصي لطلب تأكيد أنه وصي الطالب.

get

 لعرض دعوة وصي محدّدة.

list

 لعرض قائمة بدعوات الأوصياء التي يُسمح للمستخدم صاحب الطلب بالاطِّلاع عليها، باستخدام الفلاتر المقدَّمة.

patch

 لتعديل دعوة الوصي.