REST Resource: userProfiles.guardianInvitations

المرجع: GuardianAA

دعوة للانضمام إلى الوصي على مستخدم محدّد، يتم إرسالها إلى عنوان بريد إلكتروني محدّد

تمثيل 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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

حالة الدعوة المرسَلة إلى الوصي

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

الطُرق

create

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

get

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

list

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

patch

 يعدِّل دعوة وصي.