عرض سجل تغييرات إعدادات شخص
محتويات الصفحة
سنتعرف في هذه المقالة على طريقة لاستعراض سجل التغييرات التي نَفَّذها موظفو مركز المساعدة على إعدادات شخص معين، بدايةً من إضافته إلى جهات اتصال المركز، وضبط إعدادته المختلفة وتعديلها، ووصولًا إلى الحذف والأرشفة والدمج وغيرها بالإضافة إلى عمليات تسجيل دخوله إلى المركز.
عرض سجل التغييرات على إعدادت شخص
يمكنك التحكم بخيارات عرض سجل التغييرات تبعًا لتاريخ الحدث أو نوعه وفق التالي:
- عنوان URL:
https://al-munasib.zaetoon.com/api/agent/v1/contacts/{contact_id}/history. - نوع الطلب: GET.
- معاملات المسار Path Parameters: معامل واحد فقط هو contact_id الرقم التعريفي للشخص المراد عرض سجل تغييراته، نوع المعامل عدد صحيح integer، وهو معامل إجباري.
- معاملات الاستعلام Query Parameters: يوضحها الجدول التالي:
- after: نوعه مصفوفة array، يساعدك على عرض التغييرات التي يتجاوز رقمها التعريفي id حدّ معين، أو التي حدثت بعد وقت وتاريخ معينين، أو التي تحقق الشرطين معًا مثل:
["after[id]= 100","after[created_at]= datetimezone"] - before: نوعه مصفوفة array، يساعدك على عرض التغييرات التي يقل رقمها التعريفي id عن حدّ معين، أو التي حدثت قبل وقت وتاريخ معينين، أو التي تحقق الشرطين معًا مثل:
["before[id]= 100","before[created_at]= datetimezone"] - event: نوعه سلسلة نصية string، يساعدك في عرض التغييرات التي تتعلق بنوع معين من الأحداث. إذا أردت مثلًا عرض التغييرات الخاصة بإضافة عنوان بريد إلكتروني إلى إعدادات الشخص ستكتب (event=email.created) وإذا رغبت بعرض عمليات تسجيل الدخول ستكتب (event=login).
- limit: نوعه عدد صحيح integer، يساعدك على التحكم بعدد التغييرات التاريخية المعروضة في الاستجابة، ويقبل القيم من 1 إلى 100، وقيمته الافتراضية 6.
- sort: نوعه سلسلة نصية string، يساعدك على ترتيب التغييرات الحاصلة على إعدادات الشخص تصاعديًّا أو تنازليًّا بناءً على تاريخ حدوثها باستخدام created_at.desc أو created_at.asc.
- after: نوعه مصفوفة array، يساعدك على عرض التغييرات التي يتجاوز رقمها التعريفي id حدّ معين، أو التي حدثت بعد وقت وتاريخ معينين، أو التي تحقق الشرطين معًا مثل:
مثال
يبين المثال التالي كيفية الحصول على سجل بالتغييرات الحاصلة على إعدادات الشخص ذو الرقم "439582" في مركز مساعدة "المناسب" بين تاريخين:
curl --globoff --header 'Authorization: Bearer your_token' 'https://al-munasib.zaetoon.com/api/agent/v1/contacts/439582/history?limit=100&after[created_at]=2024-10-10T00%3A00%3A00&before[created_at]=2024-10-17T00%3A00%3A00