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

متد Get Aircraft List

Download Markdown for LLM

این متد برای دریافت لیست هواپیماهای موجود در سیستم استفاده می‌گردد.


API Endpoint

POST https://{SupplierWebsiteUrl}/api/B2M/Bot/Flight/Charter/FlightManagement/Aircraft/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 مراجعه کنید.


Sample Request

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

Response Parameters

  • aircraftList

    Array of aircrafts

    لیست هواپیماها

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

    • aircraftList.Id

      number

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

    • aircraftList.title

      string

      نام هواپیما

    • aircraftList.iataCode

      string

      کد یاتای نوع هواپیما

    • aircraftList.register

      string

      کد رجیستر هواپیما


Sample Response

{
    "aircraftList": [
        {
            "id": 1,
            "title": "McDonnell Douglas MD82",
            "iataCode": "M82 ",
            "register": "Y9-GHT"
        }
    ]
}