REST Resource: userProfiles.guardianInvitations

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

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

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

GuardianInvitationState

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

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

तरीके

create

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

get

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

list

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

patch

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