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

متد Get Charter Quota List

Download Markdown for LLM

این متد برای دریافت لیست سهمیه‌های چارتر واگذار شده به آژانس‌های دیگر روی یک کلاس پروازی کاربرد دارد


API Endpoint

POST https://{SupplierWebsiteUrl}/api/B2M/Bot/Flight/Charter/FlightManagement/Flight/FlightClass/CharterQuota/GetList/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

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


Sample Request

curl -X POST https://SepehrApiTest.ir/api/B2M/Bot/Flight/Charter/FlightManagement/Flight/FlightClass/CharterQuota/GetList/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": 844418
}'

Response Parameters

  • charterQuotaList

    Array of charter quotas

    لیست سهمیه‌های چارتر

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

    • charterQuotaList.Id

      number

      شناسه منحصر به فرد یک سهمیه چارتر

    • charterQuotaList.agencyName

      string

      نام آژانسی که سهمیه به آن اختصاص یافته

    • charterQuotaList.seatCount

      number

      تعداد صندلی چارتر داده شده

    • charterQuotaList.remarks

      string

      ملاحظات


Sample Response

{
    "charterQuotaList": [
        {
            "id": 48112,
            "agencyName": "آژانس تستی",
            "seatCount": 10,
            "remarks": ""
        }
    ]
}