REST Resource: locations.admins

संसाधन: एडमिन

किसी खाते या जगह का एडमिन.

JSON के काेड में दिखाना
{
  "name": string,
  "admin": string,
  "account": string,
  "role": enum (AdminRole),
  "pendingInvitation": boolean
}
फ़ील्ड
name

string

इम्यूटेबल. संसाधन का नाम. खाते के एडमिन के लिए, यह फ़ॉर्म में है: accounts/{account_id}/admins/{admin_id}

जगह के एडमिन के लिए, यह फ़ॉर्म में है: locations/{locationId}/admins/{admin_id}

अगर एडमिन पेज बनाते समय इस फ़ील्ड को सेट किया जाता है, तो इसे अनदेखा कर दिया जाएगा.

admin

string

ज़रूरी नहीं. एडमिन का नाम. पहला न्योता देते समय, यह न्योता पाने वाले व्यक्ति का ईमेल पता होता है. अगर न्योता अब भी स्वीकार नहीं किया गया है, तो GET कॉल पर उपयोगकर्ता का ईमेल पता वापस भेजा जाता है. अगर ऐसा नहीं है, तो इसमें उपयोगकर्ता के नाम और सरनेम शामिल होंगे.

इस फ़ील्ड को सिर्फ़ एडमिन बनाने के दौरान सेट करने की ज़रूरत है.

account

string

इम्यूटेबल. खाते के उस संसाधन का नाम जिसके बारे में इस एडमिन ने बताया है. इसका इस्तेमाल तब किया जाता है, जब किसी LocationGroup को एडमिन के तौर पर न्योता देने के लिए locations.admins.create को कॉल किया जाता है.

अगर यह फ़ील्ड और admin, दोनों CREATE अनुरोधों पर सेट हैं, तो इस फ़ील्ड को प्राथमिकता दी जाती है और admin के ईमेल पते को अनदेखा कर दिया जाएगा.

फ़ॉर्मैट: accounts/{account}.

role

enum (AdminRole)

ज़रूरी है. इस एडमिन की भूमिका के बारे में पता चलता है. यह वह भूमिका है जो तय किए गए खाते या जगह की जानकारी के लिए इस्तेमाल की जाती है.

pendingInvitation

boolean

सिर्फ़ आउटपुट के लिए. इससे पता चलता है कि इस एडमिन के पास, बताए गए संसाधन के लिए न्योता बाकी है या नहीं.

तरीके

create

बताए गए उपयोगकर्ता को बताई गई जगह का एडमिन बनने के लिए न्योता देता है.

delete

बताए गए एडमिन को बताई गई जगह के मैनेजर के तौर पर हटाता है.

list

चुनी गई जगह के सभी एडमिन की सूची बनाता है.

patch

बताई गई जगह के एडमिन को अपडेट करता है.