الحصول على استلام معين من نموذج

سنوضح في هذا المقال كيف يمكنك استرجاع استلام معين في مركز المساعدة من خلال الواجهة البرمجية لزيتون.

الحصول على استلام معين من نموذج

يمكنك الحصول على استلام معين في مركز المساعدة من خلال إرسال طلب من نوع GET إلى نقطة الاتصال {form-submissions/{id/ مع تمرير الرقم التعريفي للاستلام id كمتغير مسار ضمن عنوان URL للطلب، كما يلي:

• عنوان URL لنقطة الاتصال:

https://{your_subdomain}/api/agent/v1/form-submissions/{id}.

• نوع الطلب: GET.
• معاملات المسار Path Parameters: مُعَامِل واحد هو الرقم التعريفي للاستلام id، نوعه عدد صحيح integer، وهو معامل إجباري.
• معاملات الاستعلام Query Parameters: مُعَامِل واحد هو notes_sort، نوعه سلسلة نصية string، وهو مُعَامِل اختياري، يساعدك على ترتيب الملاحظات المكتوبة عن الاستلام المعروض حسب تاريخ إنشائها من الأقدم إلى الأحدث (بإعطائه القيمة asc) أو من الأحدث إلى الأقدم (بإعطائه القيمة desc).

مثال

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

curl --header 'Authorization: Bearer your_token' 'https://al-munasib.zaetoon.com/api/agent/v1/form-submissions/292?notes_sort=desc'

تتضمن الاستجابة ما يلي:

• الرقم التعريفي للاستلام.
• إعدادات لغة الاستلام locale.
• اسم النموذج الذي ينتمي إليه (مثل "تواصل معنا").
• معلومات عن مُنشِئ الطلب سواء كان مستخدم أو جهة اتصال.
• معلومات عن النموذج الذي ينتمي إليه الاستلام.
• مستخدم مركز المساعدة المُسند إليه الاستلام.
• حالة الاستلام مفتوحة أو مؤرشفة أو غير ذلك.
• كافة حقول الاستلام مبينة ضمن المصفوفة "fields" التي توضح نوع كل حقل، ومواصفاته، وقيمته ضمن الاستلام.
• معلومات عن جهة الاتصال المعنية بالنموذج.
• السجل التاريخي history لكافة التغييرات التي طرأت على الاستلام، مثل عمليات الإنشاء، والإسناد، وتغيير الحالة وغيرها.
• الوسوم tags المضافة للاستلام.
• وقت وتاريخ إنشاء الاستلام.