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 כדי להזמין קבוצת מיקומים כאדמין.

אם השדה הזה וגם admin מוגדרים בבקשות CREATE, השדה הזה יקבל עדיפות ותתעלם מכתובת האימייל ב-admin.

פורמט: accounts/{account}.
role

enum (AdminRole)

חובה. ההגדרה מציינת את התפקיד של האדמין הזה בחשבון או במיקום שצוינו.
pendingInvitation

boolean

פלט בלבד. הערך מציין אם לאדמין הזה יש הזמנה בהמתנה למשאב שצוין.

שיטות

create

 הזמנה של המשתמש שצוין להפוך לאדמין במיקום שצוין.

delete

 מסיר את מנהל המערכת שצוין כמנהל של המיקום שצוין.

list

 רשימה של כל האדמינים במיקום שצוין.

patch

 עדכון האדמין למיקום שצוין.