مستندات وب سرویس

متد Replace Flight Class Roundtrip Rules

Download Markdown for LLM

این متد برای ایجاد یا تغییر قوانین برگشت روی یک کلاس پروازی خاص استفاده می‌شود. در درخواست ارسالی، [null] به معنی هر پروازی بوده و [] به معنی عدم وجود قانون برگشت می‌باشد.

این متد قوانین برگشتِ کلاس پروازی را به‌صورت کامل جایگزین می‌کند (حذف قوانین موجود + درج قوانین جدید). فیلدهای OldFlightClassIdList برای بررسی تداخل (Optimistic Concurrency) استفاده می‌شوند و باید با وضعیت فعلی قوانین در سرور مطابقت داشته باشند؛ بنابراین اگر هنوز هیچ قانونی روی کلاس پروازی وجود ندارد، برای هر دو فیلد OldFlightClassIdList (در AllowedReturningFlightClass و DeniedReturningFlightClass) آرایه‌ی خالی [] ارسال کنید. قوانین جدید بر اساس محتوای NewFlightClassIdList درج می‌شوند؛ اگر NewFlightClassIdList هم خالی باشد، هیچ قانونی ایجاد نخواهد شد.

توجه نمایید درصورتی که بلافاصله پس از اعمال تغییر در قانون برگشت با این متد، اقدام به دریافت اطلاعات قانون برگشت همین کلاس پروازی با استفاده از متد Get Flight Class Roundtrip Data کنید، ممکن است قانون برگشت این کلاس پروازی را با اطلاعات قبلی مشاهده کنید. برای جلوگیری از این اتفاق می‌بایست «حداکثر 5 ثانیه» صبر نموده و سپس درخواست Get Flight Class Roundtrip Data را اجرا کنید.


API Endpoint

POST https://{SupplierWebsiteUrl}/api/B2M/Bot/Flight/Charter/FlightManagement/Flight/FlightClass/RoundtripRules/Replace/V1

Request Parameters

  • UserName

    string

    [conditional-required]

    نام کاربری

    در صورت استفاده از روش Username/Password Authentication ارسال این فیلد الزامی است.

  • Password

    string

    [conditional-required]

    رمز عبور به صورت MD5 شده

    در صورت استفاده از روش Username/Password Authentication ارسال این فیلد الزامی است.

  • AccessToken

    string

    [conditional-required]

    توکن احراز هویت دریافت‌شده از طریق Single Sign-On (SSO).

    در صورت استفاده از روش Token-based Authentication این فیلد را ارسال کنید. در این حالت نیازی به ارسال UserName و Password نیست.

    برای آشنایی با روش‌های احراز هویت و نحوه انتخاب و استفاده از هر روش، به مستندات Authentication مراجعه کنید.

  • FlightClassId

    number

    required

    شناسه منحصر به فرد کلاس پروازی

  • AllowedReturningFlightClass

    object

    required

    + نمایش ویژگی‌های زیرمجموعه

    • AllowedReturningFlightClass.OldFlightClassIdList

      array of flight class Ids

      required

      آرایه‌ای از Id کلاس پروازی‌ها

    • AllowedReturningFlightClass.NewFlightClassIdList

      array of flight class Ids

      required

      آرایه‌ای از Id کلاس پروازی‌ها

  • DeniedReturningFlightClass

    object

    required

    + نمایش ویژگی‌های زیرمجموعه

    • DeniedReturningFlightClass.OldFlightClassIdList

      array of flight class Ids

      required

      آرایه‌ای از Id کلاس پروازی‌ها

    • DeniedReturningFlightClass.NewFlightClassIdList

      array of flight class Ids

      required

      آرایه‌ای از Id کلاس پروازی‌ها


Sample Request

curl -X POST https://SepehrApiTest.ir/api/B2M/Bot/Flight/Charter/FlightManagement/Flight/FlightClass/RoundtripRules/Replace/V1 \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip, deflate" \
  -d '{
    "UserName": "sample-head-office-user",
    "Password": "25f9e794323b453885f5181f1b624d0b",
    "FlightClassId": 857348,
    "AllowedReturningFlightClass":{
        "OldFlightClassIdList": [],
        "NewFlightClassIdList": [45254, 452560]
    },
    "DeniedReturningFlightClass":{
        "OldFlightClassIdList": [null],
        "NewFlightClassIdList": []
    }
}'

Response Parameters

  • No Content

    http code 204

    ریسپانس فاقد بدنه می‌باشد


Sample Response

204 No Content