الطلبات والاستجابات

تتناول هذه الصفحة تنسيقات متن الطلب، وغلاف الاستجابة، وتقسيم الصفحات، وتنسيقات التواريخ والمبالغ، وكيفية تفسير رموز حالة HTTP.

متون الطلبات#

تستخدم نقاط النهاية أحد تنسيقين للمتن، وتوضّح صفحة المرجع الخاصة بكل نقطة نهاية التنسيق المعتمد.

تُكرَّر حقول المصفوفات في متون النماذج مع أقواس مربعة: childAges[]=7&childAges[]=12. ويجب أن تكون متون JSON بترميز UTF-8.

غلاف الاستجابة#

الاستجابات بتنسيق JSON، ويحمل معظمها مؤشر success؛ وتعود القوائم مع count وitems:

{
    "success": true,
    "count": 3,
    "items": [
        {
            "id": 1,
            "titleCode": "TRY",
            "symbol": "₺",
            "price": 1
        },
        {
            "id": 2,
            "titleCode": "EUR",
            "symbol": "€",
            "price": 47.85000000000000142108547152020037174224853515625
        }
    ]
}

عند إخفاق التحقق من قواعد العمل تُعاد success: false مع وصف للخطأ، بأحد شكلين:

{
    "success": false,
    "message": "online_cupon_is_not_found"
}

{
    "success": false,
    "errorMessage": "Invalid parameters.",
    "errorCode": 10022
}

الاستثناءات: تعيد نقطة نهاية بيانات الاتصال كائنًا مجردًا دون غلاف، ويعيد إرسال الحجز كائن BookingPushRS. وكلاهما موضّح في المرجع.

رموز حالة HTTP#

تقسيم الصفحات#

نقاط نهاية القوائم (/external/currencies، /external/languages، /external/online/social/media، /external/stock/packages) مقسّمة إلى صفحات حسب رقم الصفحة:

count هو العدد الإجمالي للسجلات؛ وتنتهي القائمة عندما يتحقق page × limit ≥ count.

التواريخ والأوقات والمبالغ#

لا يُحتسب تاريخ المغادرة ضمن الإقامة: من 18 إلى 20 أغسطس ليلتان. لا تجمع المبالغ باستخدام float؛ بل استخدم مكتبة للأعداد العشرية أو أعدادًا صحيحة بأصغر وحدة نقدية.

اللغة#

تستقبل قائمة الغرف الحقل language (ISO 639-1: tr، en، de…) وتعيد أسماء الغرف وعناوين المزايا ورسائل الأخطاء بتلك اللغة. أما قائمة الباقات فتتوقع languageID، وتؤخذ المعرّفات من نقطة النهاية اللغات.