REST Resource: userProfiles.guardianInvitations

المورد: GuardianInvitation

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

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

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