REST Resource: userProfiles.guardianInvitations

সম্পদ: গার্ডিয়ান ইনভাইটেশন

একটি নির্দিষ্ট ব্যবহারকারীর অভিভাবক হওয়ার জন্য একটি আমন্ত্রণ, একটি নির্দিষ্ট ইমেল ঠিকানায় পাঠানো হয়েছে৷

JSON প্রতিনিধিত্ব 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
ক্ষেত্র
student Id

string

ছাত্রের আইডি (স্ট্যান্ডার্ড ফর্ম্যাটে)

invitation Id

string

এই আমন্ত্রণের জন্য অনন্য শনাক্তকারী৷

শুধুমাত্র পঠনযোগ্য।

invited Email Address

string

যে ইমেল ঠিকানায় আমন্ত্রণ পাঠানো হয়েছে। এই ক্ষেত্রটি শুধুমাত্র ডোমেন প্রশাসকদের কাছে দৃশ্যমান।

state

enum ( GuardianInvitationState )

এই আমন্ত্রণ যে অবস্থায় আছে।

creation Time

string ( Timestamp format)

যে সময় এই আমন্ত্রণটি তৈরি করা হয়েছিল।

শুধুমাত্র পঠনযোগ্য।

RFC3339 UTC "জুলু" ফর্ম্যাটে একটি টাইমস্ট্যাম্প, ন্যানোসেকেন্ড রেজোলিউশন এবং নয়টি পর্যন্ত ভগ্নাংশের সংখ্যা। উদাহরণ: "2014-10-02T15:01:23Z" এবং "2014-10-02T15:01:23.045123456Z" ।

অভিভাবক আমন্ত্রণ রাজ্য

একটি অভিভাবক আমন্ত্রণ রাষ্ট্র.

Enums
GUARDIAN_INVITATION_STATE_UNSPECIFIED কখনই ফিরিয়ে দেওয়া উচিত নয়।
PENDING আমন্ত্রণটি সক্রিয় এবং একটি প্রতিক্রিয়ার জন্য অপেক্ষা করছে৷
COMPLETE আমন্ত্রণ আর সক্রিয় নয়। এটি গৃহীত, প্রত্যাখ্যান, প্রত্যাহার বা মেয়াদ শেষ হয়ে যেতে পারে।

পদ্ধতি

create

 একটি অভিভাবক আমন্ত্রণ তৈরি করে, এবং অভিভাবককে একটি ইমেল পাঠায় যাতে তারা নিশ্চিত করতে বলে যে তারা শিক্ষার্থীর অভিভাবক।

get

 একটি নির্দিষ্ট অভিভাবক আমন্ত্রণ ফেরত দেয়।

list

 প্রদত্ত পরামিতি দ্বারা ফিল্টার করা অভিভাবক আমন্ত্রণগুলির একটি তালিকা প্রদান করে যা অনুরোধকারী ব্যবহারকারীকে দেখার অনুমতি দেওয়া হয়েছে৷

patch

 একটি অভিভাবক আমন্ত্রণ পরিবর্তন করে৷