REST Resource: userProfiles.guardianInvitations

المرجع: GuardianGuardian

دعوة مُرسَلة إلى عنوان بريد إلكتروني محدّد لتصبح وصيًا على مستخدم معيَّن

تمثيل 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"

GuardianInvitationState

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

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

الطُرق

create

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

get

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

list

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

patch

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