Method: userProfiles.guardians.delete

किसी अभिभावक की जानकारी मिटाता है.

इसके बाद, अभिभावक को अभिभावक से जुड़ी सूचनाएं नहीं मिलेंगी. साथ ही, एपीआई की मदद से अभिभावक को ऐक्सेस नहीं किया जा सकेगा.

इस तरीके से, गड़बड़ी के ये कोड मिलते हैं:

  • PERMISSION_DENIED अगर अनुरोध करने वाले उपयोगकर्ता को, दिए गए studentId से मैच करने वाला कोई उपयोगकर्ता नहीं दिखता है, अगर अनुरोध करने वाले उपयोगकर्ता को studentId से पहचाने गए छात्र के लिए अभिभावकों को मैनेज करने की अनुमति नहीं है, अगर उस डोमेन के लिए अभिभावक की सुविधा चालू नहीं है या ऐक्सेस से जुड़ी अन्य गड़बड़ियों की वजह से ऐसा होता है.
  • INVALID_ARGUMENT अगर studentId दिया गया है, लेकिन उसका फ़ॉर्मैट पहचाना नहीं जा सकता (यह ईमेल पता नहीं है और न ही एपीआई से मिला studentId है).
  • NOT_FOUND अगर अनुरोध करने वाले उपयोगकर्ता को, अनुरोध किए गए studentId के लिए अभिभावकों की जानकारी में बदलाव करने की अनुमति है, लेकिन दिए गए guardianId के साथ उस छात्र के लिए कोई Guardian रिकॉर्ड मौजूद नहीं है.

एचटीटीपी अनुरोध

DELETE https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

पाथ पैरामीटर

पैरामीटर
studentId

string

वह छात्र या छात्रा जिसका अभिभावक मिटाना है. निम्न में से एक:

  • उपयोगकर्ता का अंकों वाला आइडेंटिफ़ायर
  • उपयोगकर्ता का ईमेल पता
  • स्ट्रिंग लिटरल "me", जो अनुरोध करने वाले उपयोगकर्ता की जानकारी देता है
guardianId

string

Guardian का id फ़ील्ड.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

अगर एपीआई सही से जुड़ जाता है, तो जवाब का मुख्य हिस्सा खाली होता है.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.