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

अभिभावक को भेजे गए न्योते की स्थिति.

Enums
GUARDIAN_INVITATION_STATE_UNSPECIFIED इसे कभी भी वापस नहीं लाना चाहिए.
PENDING न्योता चालू है और इसके जवाब का इंतज़ार किया जा रहा है.
COMPLETE यह न्योता अब मान्य नहीं है. ऐसा हो सकता है कि न्योते को स्वीकार या अस्वीकार कर दिया गया हो या उसे वापस ले लिया गया हो या उसकी समयसीमा खत्म हो गई हो.

तरीके

create

 यह कुकी, अभिभावक को न्योता देने के लिए बनाई जाती है. साथ ही, यह अभिभावक को एक ईमेल भेजती है. इसमें उनसे यह पुष्टि करने के लिए कहा जाता है कि वे छात्र या छात्रा के अभिभावक हैं.

get

 यह फ़ंक्शन, अभिभावक को भेजे गए किसी न्योते की जानकारी देता है.

list

 यह उन अभिभावकों के न्योतों की सूची दिखाता है जिन्हें अनुरोध करने वाला उपयोगकर्ता देख सकता है. यह सूची, दिए गए पैरामीटर के हिसाब से फ़िल्टर की जाती है.

patch

 अभिभावक को भेजे गए न्योते में बदलाव करता है.