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-normalized ويستخدم 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

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