View Categories

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

مدت زمان تخمینی مطالعه : 1 حداقل زمان مطالعه

در این بخش شما میتوانید آیتم جستجو شده ی خود را جهت رزرو قفل کنید.


قفل آیتم از طریق 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}}
JSON

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

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

عنواننوعوضعیتمقادیرتوضیحات
chartersArrayاجباریآیتم های این کلید متناسب با تعداد چارتر های انتخاب شده تغییر میکند.
charters[index].idIntegerاجباری
charters[index].item_idIntegerاجباری
charters[index].passengers
charters[index].passengers.adultIntegerاجباری
charters[index].passengers.infantIntegerاجباری
{
  "charters": [
    {
      "id": 10002,
      "item_id": 10005,
      "passengers": {
        "adult": 2,
        "infant": 1
      }
    },
    ...
  ]
}
JSON

پاسخ صحیح – Response True #

عنواننوعمقادیرتوضیحات
itemsArray
items[index].idInteger
items[index].statusBooleantrue/falseممکن است مقدارش true باشد و ممکن است بعضی از ایتم ها قفل نشوند بنابراین مقدار این کلید در آن آیتم ها false خواهد بود.
items[index].lock_idIntegerآیدی قفل رزروهنگامی که کلید status true باشد این کلید وجود دارد
items[index].durationIntegerمدت زمان قفل رزروهنگامی که کلید status true باشد این کلید وجود دارد
items[index].expirationStringزمان انقضای قفل رزروهنگامی که کلید status true باشد این کلید وجود دارد
items[index].codeIntegercode errorهنگامی که کلید status false باشد این کلید وجود دارد که مثل رویه های قبلی باید به صفحه error handling برای مشاهده دلیل ارور خود مراجعه فرمایید.
meta
meta.timestampTimestamp  زمان تولید پاسخ  این زمان بر اساس 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
    }
}
JSON

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

عنواننوعمقادیرتوضیحات
error
error.codeIntegerشماره خطا مربوطهجهت استعلام خطا میتوانید از طریق این لینک اقدام کنید.
meta
meta.timestampTimestamp  زمان تولید پاسخ  این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.
{
  "error": {
    "code":"Error Code"
  },
  "meta": {
    "timestamp": "Timestamp" // Timestamp
  }
}
JSON

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

به‌روزرسانی در بهمن 1, 1403
Shopping Basket
خانه
وبلاگ
جست‌وجو
درخواست