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

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

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

enum (AdminRole)

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

boolean

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

שיטות

create

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

delete

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

list

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

patch

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