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

تغییرناپذیر. نام منبع حسابی که این مدیر به آن اشاره دارد. هنگام تماس با locations.admins.create برای دعوت از LocationGroup به عنوان سرپرست استفاده می شود.

اگر این فیلد و admin هر دو روی درخواست‌های CREATE تنظیم شده باشند، این فیلد اولویت دارد و آدرس ایمیل موجود در admin نادیده گرفته می‌شود.

قالب: accounts/{account} .

role

enum ( AdminRole )

مورد نیاز. نقشی را که این سرپرست با حساب یا مکان مشخص شده استفاده می‌کند، مشخص می‌کند.

pendingInvitation

boolean

فقط خروجی نشان می دهد که آیا این سرپرست دعوت نامه معلقی برای منبع مشخص شده دارد یا خیر.

روش ها

create

 کاربر مشخص شده را دعوت می کند تا مدیر مکان مشخص شده شود.

delete

 ادمین مشخص شده را به عنوان مدیر مکان مشخص شده حذف می کند.

list

 همه ادمین ها را برای مکان مشخص شده لیست می کند.

patch

 ادمین را برای مکان مشخص شده به روز می کند.