بررسی آیتم جستجو شده قبل از خرید – Item Status

• دریافت از طریق API
• مقادیر ارسالی – Request Data
• سربرگ – Header
• مقادیر ارسالی – Request Data
• پاسخ صحیح – Response True
• پاسخ نادرست – Response False

دریافت از طریق API

عنوان	وضعیت	مقادیر	توضیحات
Method	اجباری	GET	متد ارسال درخواست
Domain	اجباری	نام دامنه ثبت شده در اتوماسیون
Api Url	اجباری	دامنه هسته مرکزی سرویس
Api version	اجباری	به نسخه فعلی سرویس API تلقی میشود که در قسمت پیش نیازهای اتوماسیون به ریز شرح داده شده است.
Authorization	اجباری	توکن JWT تولید شده	این توکن بصورت JWT تولید میشود.

در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید.

مقادیر ارسالی – Request Data

عنوان	نوع	وضعیت	مقادیر	توضیحات
items	Array	اجباری	چارتر های انتخابی	تعداد آیتم ها میتوانند متناسب با تعداد چارتر انتخابی افزایش یابند
items[index].main_id	Integer	اجباری	عطف چارتر
items[index].item_id	Integer	اجباری	آیدی کلاس چارتر
items[index].lock_id	Integer	اختیاری	آیدی قفل رزرو	اگر از قبل عملیات قفل رزرو انجام شده است این کلید را قرار دهید،در صورت قرار دادن این کلید تعداد آمار باقیمانده رزرو به صورت خودکار به روز میشود

{
    "items": [
        {
            "main_id": 10001,
            "item_id": 10001,
            "lock_id":1, // Integer
        },
        ...
    ]
}

سربرگ – Header

دریافت از طریق API

در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید.

{{Api Url}}/items/status

HEADER
GET /api/reservation/{{Api version}}/items/status HTTP/1.1
Host: {{Your Host}}
Content-Type: application/json
Authorization: Bearer JWTToken
Domain: {{Your Domain}}

API Url از طریق پنل کاربری قابل مشاهده خواهد بود.

مقادیر ارسالی – Request Data

عنوان	نوع	وضعیت	مقادیر	توضیحات
items	Array	اجباری	چارتر های انتخابی	تعداد آیتم ها میتوانند متناسب با تعداد چارتر انتخابی افزایش یابند
items[index].main_id	Integer	اجباری	عطف چارتر
items[index].item_id	Integer	اجباری	آیدی کلاس چارتر
items[index].lock_id	Integer	اختیاری	آیدی قفل رزرو	اگر از قبل عملیات قفل رزرو انجام شده است این کلید را قرار دهید،در صورت قرار دادن این کلید تعداد آمار باقیمانده رزرو به صورت خودکار به روز میشود

{
    "items": [
        {
            "main_id": 10001,
            "item_id": 10001,
            "lock_id":1, // Integer
        },
        ...
    ]
}

پاسخ صحیح – Response True

عنوان	نوع	مقادیر	توضیحات
items	Array
items[index].charter_id	Integer	عطف چارتر
items[index].item
items[index].item[index].item_id	Integer
items[index].item[index].statistics
items[index].item[index].statistics.capacity	Integer
items[index].item[index].statistics.waiting	Integer
items[index].item[index].financial
items[index].item[index].financial.adult
items[index].item[index].financial.adult.payable	Integer
items[index].item[index].financial.child
items[index].item[index].financial.child.payable	Integer
items[index].item[index].financial.infant
items[index].item[index].financial.infant.payable	Integer
items[index].status	Integer
meta
meta.timestamp	Timestamp	زمان تولید پاسخ	این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.

دریافت این پاسخ با Status Code 200 دریافت خواهد شد.

{
    "items": [
        {
            "charter_id": 10001,
            "item": {
                "item_id": 10001,
                "statistics": {
                    "capacity": 9,
                    "waiting": 0
                },
                "financial": {
                    "adult": {
                        "payable": 250000
                    },
                    "child": {
                        "payable": 20000
                    },
                    "infant": {
                        "payable": 6
                    }
                }
            },
            "status": "bookable"
        },
        ...
    ],
    "meta": {
        "timestamp": "Timestamp" // Timestamp
    }
}

 

پاسخ نادرست – Response False

عنوان	نوع	مقادیر	توضیحات
error
error.code	Integer	شماره خطا مربوطه	جهت استعلام خطا میتوانید از طریق این لینک اقدام کنید.
meta
meta.timestamp	Timestamp	زمان تولید پاسخ	این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.

{
  "error": {
    "code":"Error Code"
  },
  "meta": {
    "timestamp": "Timestamp" // Timestamp
  }
}

در صورت مشاهده Status Code 404 URL درخواست خود را به اشتباه وارد نموده اید.