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)

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

للقراءة فقط.

يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول العناصر غير "Z". أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

GuardianInvitationState

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

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

الطُرق

create

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

get

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

list

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

patch

 تعديل دعوة أحد الأوصياء