تقوم كل استدعاء لواجهة برمجة التطبيقات بإرجاع كائن JSON يحتوي على المعلومات المطلوبة أو كائن يحتوي على زوج من الاسم/القيمة يعكس حالة العملية المطلوبة، والتي قد تحتوي أيضا على رسالة خطأ مع وصف.

يعكس الاسم الأول / القيمة الأولى إذا تم تنفيذ المكالمة بشكل صحيح:

  • “النجاح”: صحيح – في حال كان الطلب صحيحا (مقبولا) وتم تنفيذه بشكل صحيح.
  • “النجاح”: خطأ – حدث خطأ.

الاسم / القيمة الثانية يجلب نصا وصفيا قصيرا على أي نتيجة:

  • “النتيجة”: “موافق” – في حالة صحة الطلب (قبوله) وتنفيذه بشكل صحيح.
  • “ErrorDescription”: “وصف خطأ نصي” – في حالة حدوث خطأ.
مثال على الاستجابة للنجاح:

{
“النجاح”: صحيح ،
“النتيجة”: “تم تحديث عامل التصفية 1110”
}

أمثلة على الاستجابة للخطأ:

{
“النجاح”: خاطئ ،
“ErrorDescription”: [
“فشل تسجيل الدخول! تحقق من اسم المستخدم أو كلمة المرور”
] }

{ “النجاح”: false, “ErrorDescription”: “معرف محفوظات غير صالح” }

يوفر Dotcom-Monitor موارد لرموز الخطأ الإضافية التي تم شرحها. اقرأ المزيد عن أوصاف رمز الخطأ المحددة هنا على موقع ويكي الخاص بنا.