REST Resource: userProfiles.guardianInvitations

संसाधन: अभिभावक के लिए न्योता

किसी खास उपयोगकर्ता का अभिभावक बनने का न्योता, तय ईमेल पते पर भेजा गया.

जेएसओएन के काेड में दिखाना 
{
  "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 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक तक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

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

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

तरीके

create

 अभिभावक को न्योता देता है और अभिभावक को ईमेल भेजकर, छात्र/छात्रा के अभिभावक की पुष्टि करने के लिए कहता है.

get

 अभिभावक को न्योता देता है.

list

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

patch

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