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)

न्योता बनाने का समय.

सिर्फ़ पढ़ने के लिए.

आरएफ़सी3339 यूटीसी के "Zulu" फ़ॉर्मैट में एक टाइमस्टैंप, नैनोसेकंड रिज़ॉल्यूशन और नौ दशमलव अंकों के साथ. उदाहरण के लिए: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

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

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

तरीके

create

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

get

 किसी खास अभिभावक को भेजा गया न्योता दिखाता है.

list

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

patch

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