REST Resource: locations.admins

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

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

जेएसओएन के काेड में दिखाना
{
  "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

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

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

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

role

enum (AdminRole)

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

pendingInvitation

boolean

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

तरीके

create

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

delete

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

list

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

patch

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