قفل آیتم جستجو شده – Lock

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

قفل آیتم از طریق API

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

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

سربرگ – Header

{{Api Url}}/lock

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

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

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

عنوان	نوع	وضعیت	مقادیر	توضیحات
charters	Array	اجباری		آیتم های این کلید متناسب با تعداد چارتر های انتخاب شده تغییر میکند.
charters[index].id	Integer	اجباری
charters[index].item_id	Integer	اجباری
charters[index].passengers
charters[index].passengers.adult	Integer	اجباری
charters[index].passengers.infant	Integer	اجباری

{
  "charters": [
    {
      "id": 10002,
      "item_id": 10005,
      "passengers": {
        "adult": 2,
        "infant": 1
      }
    },
    ...
  ]
}

پاسخ صحیح – Response True

عنوان	نوع	مقادیر	توضیحات
items	Array
items[index].id	Integer
items[index].status	Boolean	true/false	ممکن است مقدارش true باشد و ممکن است بعضی از ایتم ها قفل نشوند بنابراین مقدار این کلید در آن آیتم ها false خواهد بود.
items[index].lock_id	Integer	آیدی قفل رزرو	هنگامی که کلید status true باشد این کلید وجود دارد
items[index].duration	Integer	مدت زمان قفل رزرو	هنگامی که کلید status true باشد این کلید وجود دارد
items[index].expiration	String	زمان انقضای قفل رزرو	هنگامی که کلید status true باشد این کلید وجود دارد
items[index].code	Integer	code error	هنگامی که کلید status false باشد این کلید وجود دارد که مثل رویه های قبلی باید به صفحه error handling برای مشاهده دلیل ارور خود مراجعه فرمایید.
meta
meta.timestamp	Timestamp	زمان تولید پاسخ	این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.

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

{
    "items": [
        {
            "id": 10001,
            "status": true,
            "lock_id": 20018,
            "duration": 5,
            "expiration": "2025-01-20 13:30:47"
        },
        {
            "id": 10002,
            "status": false,
            "code": 1002
        },
        ...
    ],
    "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 درخواست خود را به اشتباه وارد نمود اید.