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

غير قابل للتغيير. اسم مورد الحساب الذي يشير إليه هذا "المشرف" يتم استخدامه عند استدعاء المواقع الجغرافية.admins.create لدعوة مشرف إلى مجموعة مواقع جغرافية.

في حال ضبط كل من هذا الحقل واسم admin في طلبات CREATE، تكون الأولوية لهذا الحقل وسيتم تجاهل عنوان البريد الإلكتروني في admin.

تنسيق الملف: accounts/{account}

role

enum (AdminRole)

مطلوبة. يحدِّد الدور الذي يستخدمه هذا المشرف مع الحساب أو الموقع الجغرافي المحدّد.

pendingInvitation

boolean

النتائج فقط. يشير إلى ما إذا كان لدى هذا المشرف دعوة في انتظار المراجعة للمورد المحدَّد.

الطُرق

create

لدعوة المستخدم المحدَّد لكي يصبح مشرفًا للموقع الجغرافي المحدَّد.

delete

إزالة المشرف المحدد كمدير للموقع الجغرافي المحدد.

list

يسرد جميع المشرفين في الموقع الجغرافي المحدَّد.

patch

لتحديث المشرف للموقع الجغرافي المحدّد.