عرض الملاحظات الخاصة باستلام نموذج

سنشرح في هذا المقال كيفية عرض الملاحظات الخاصة باستلام نموذج معين في مركز المساعدة، فقد تحتوي الملاحظات المسجلة عن كل استلام على تفاصيل توضيحية تفيد في مراجعة حالات الاستلام وتحليلها

عرض ملاحظات استلامات نموذج

تساعدك نقطة الاتصال form-submissions/{form_submission_id}/notes/ على عرض كافة الملاحظات المسجلة عن استلام معين، وفق التالي:

• عنوان URL لنقطة الاتصال:
  https://{your_subdomain}/api/agent/v1/form-submissions/{form_submission_id}/notes.
• نوع الطلب: GET.
• معاملات المسار Path Parameters: معامل واحد فقط form_submission_id يمثل الرقم التعريفي للاستلام المطلوب عرض ملاحظاته، وهو معامل إجباري.
• معاملات الاستعلام Query Parameters: وهي كما يلي:
• • after: نوعه مصفوفة array، يساعدك على عرض الملاحظات المكتوبة عن الاستلام بعد وقت وتاريخ معينين، أو التي يتجاوز رقمها التعريفي id حد معين، أو التي تحقق الشرطين معًا كما في المثال التالي:
    ["after[id] = 1","after[created_at] = datetimezone"]
  • before: نوعه مصفوفة array، يساعدك على عرض الملاحظات المكتوبة عن الاستلام قبل وقت وتاريخ معينين، أو التي يقل رقمها التعريفي id عن حد معين، أو التي تحقق الشرطين معًا كما في المثال التالي:
    ["before[id] = 1","before[created_at] = datetimezone"]
  • limit: نوعه عدد صحيح integer، يساعدك على التحكم بعدد الملاحظات المعروضة في الاستجابة، قيمته الافتراضية 6 ويمكنك إعطائه أي قيمة من 1 إلى 100.
  • sort: يمكن أن يقبل سلسلة نصية string أو مصفوفة array، وهو يساعدك على ترتيب الملاحظات تصاعديًا أو تنازليًا حسب:
  • • تاريخ إنشاء الملاحظة: من أقدم ملاحظة إلى أحدث ملاحظة أو العكس باستخدام created_at.desc أو created_at.asc.
    • الرقم التعريفي للملاحظة: من أصغر رقم إلى أكبر رقم أو العكس باستخدام id.asc أو id.desc.

مثال

لعرض الملاحظات المكتوبة عن الاستلام رقم "292" في مركز مساعدة تجريبي يدعى "المناسب al-munasib" له النطاق الفرعي al-munasib.zaetoon.com وذلك بعد تاريخ 2024/09/01 مع ترتيبها من الأقدم إلى الأحدث نكتب الطلب التالي:

curl --globoff --header 'Authorization: Bearer your_token' 'https://al-munasib.zaetoon.com/api/agent/v1/form-submissions/292/notes?after[created_at]=2024-09-01T00%3A00%3A00&limit=10&sort[created_at]=asc'