﻿---
title: "GetPassengerList | Flight Bot B2M | پرواز | مستندات وب سرویس سپهر"
---
# get-passenger-list



## متد GetPassengerList

این متد به منظور دریافت لیست مسافران یک پرواز همراه با اطلاعات تکمیلی رزرو هر مسافر اعم از اطلاعات مالی و … مورد استفاده می‌باشد

<br>

API Endpoint

```http
POST https://{SupplierWebsiteUrl}/api/B2M/Bot/Flight/Charter/FlightManagement/Flight/Reports/GetPassengerList/V1
```

<br>

## 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 نیست.

  :::info
  برای آشنایی با روش‌های احراز هویت و نحوه انتخاب و استفاده از هر روش، به مستندات [Authentication](/fa/b2m/bot/authentication.md) مراجعه کنید.
  :::

- `FlightId`

  number

  required

  شناسه منحصر به فرد پرواز

<br>

## Sample Request

```curl
curl -X POST https://SepehrApiTest.ir/api/B2M/Bot/Flight/Charter/FlightManagement/Flight/Reports/GetPassengerList/V1 \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip, deflate" \
  -d '{
    "UserName": "testdev1",
    "Password": "25f9e794323b453885f5181f1b624d0b",
    "FlightId": 844418
}'
```

<br>

## Response Parameters

- `flightNumber`

  string

  شماره پرواز

- `departureDateTime`

  string

  زمان خروج پرواز از مبدا. با فرمت yyyy-MM-dd HH:mm به صورت میلادی و بر اساس ناحیه زمانی مبدا

- `originIataCode`

  string

  کد سه حرفی یاتای مبدا

- `destinationIataCode`

  string

  کد سه حرفی یاتای مقصد

- `airlineIataCode`

  string

  کد یاتای ایرلاین

- `passengerList`

  Array Of Passengers

  لیست مسافران

  - `passengerList.firstName`

    string

    نام کوچک مسافر

  - `passengerList.lastName`

    string

    نام خانوادگی مسافر

  - `passengerList.ageTypeCode`

    string

    کد گروه سنی مسافر: ADL , CHD , INF

  - `passengerList.birthDate`

    string

    تاریخ تولد مسافر با فرمت yyyy-MM-dd به صورت میلادی

  - `passengerList.gender`

    string

    جنسیت مسافر: M , F

  - `passengerList.pnr`

    string

    رفرنس رزرو مسافر

  - `passengerList.ticketNumber`

    string

    شماره بلیت منحصر به فرد این مسافر

  - `passengerList.reserveDateTime`

    string

    زمان انجام رزرو. با فرمت yyyy-MM-dd HH:mm به صورت میلادی و بر اساس ناحیه زمانی UTC

  - `passengerList.phone`

    string

    شماره موبایل مسافر

  - `passengerList.email`

    string

    آدرس پست الکترونیک مسافر

  - `passengerList.nationalityCountryCode`

    string

    کد دو حرفی ملیت مسافر. مانند : IR , FR و…

  - `passengerList.passport`

    string

    شماره پاسپورت مسافر. این فیلد در صورتی دارای مقدار خواهد بود که یا پرواز بین المللی باشد و یا مسافر غیر ایرانی باشد

  - `passengerList.iranianCodeMelli`

    string

    کد ملی مسافر. این فیلد در صورتی دارای مقدار خواهد بود که پرواز داخلی ایران بوده و ضمنا مسافر نیز ایرانی باشد

  - `passengerList.hotelName`

    string

    درصورتی رزرو مسافر شامل هتل هم باید نام هتل در این فیلد نمایش داده می‌شود

  - `passengerList.oppositeFlight_Id`

    number

    درصورتی که رزرو مسافر رفت و برگشتی باشد شناسه منحصر به فرد پرواز مقابل در این فیلد نمایش داده می‌شود

  - `passengerList.oppositeFlight_Number`

    string

    درصورتی که رزرو مسافر رفت و برگشتی باشد شماره پرواز مقابل در این فیلد نمایش داده می‌شود

  - `passengerList.oppositeFlight_DepartureDateTime`

    string

    درصورتی که رزرو مسافر رفت و برگشتی باشد زمان خروج پرواز مقابل در این فیلد با فرمت yyyy-MM-dd HH:mm به صورت میلادی و بر اساس ناحیه زمانی مبدا نمایش داده می‌شود

  - `passengerList.reserveByUserId`

    number

    شناسه منحصر به فرد کاربر صادر کننده رزرو

  - `passengerList.reserveByUserName`

    string

    نام کاربر صادر کننده رزرو

  - `passengerList.reserveForAgencyId`

    number

    شناسه منحصر به فرد آژانس طرف حساب رزرو

  - `passengerList.reserveForAgencyName`

    string

    نام آژانس طرف حساب رزرو

  - `passengerList.cabinType`

    string

    نوع کابین. مانند Economy ، Business و…

  - `passengerList.bookingCode`

    string

    بوکینگ کد

  - `passengerList.fareName`

    string

    نام fare

  - `passengerList.priceBreakdown`

    object

    جزئیات نرخی مربوط به این مسافر

    - `passengerList.priceBreakdown.baseFare`

      decimal

      مبلغ پایه fare

    - `passengerList.priceBreakdown.tax`

      decimal

      مجموع مبالغ مالیات‌ها

    - `passengerList.priceBreakdown.totalFare`

      decimal

      مبلغ نهایی fare که مجموع baseFare و tax می‌باشد

    - `passengerList.priceBreakdown.commission`

      decimal

      مبلغ کمیسیون

    - `passengerList.priceBreakdown.discount`

      decimal

      مبلغ تخفیف

    - `passengerList.priceBreakdown.surcharge`

      decimal

      مبلغ اضافه بها

    - `passengerList.priceBreakdown.payable`

      decimal

      مبلغ نهایی قابل پرداخت برای این مسافر

    - `passengerList.priceBreakdown.currencyCode`

      string

      کد سه حرفی ارز این fare. مانند IRR ، USD و…

<br>

## Sample Response

```json
{
    "flightNumber": "3333",
    "departureDateTime": "2025-02-25 15:00",
    "originIataCode": "IFN",
    "destinationIataCode": "AWZ",
    "airlineIataCode": "B9",
    "passengerList": [
        {
            "firstName": "AHMAD",
            "lastName": "AHMADI",
            "ageTypeCode": "ADL",
            "birthDate": "1984-08-20",
            "gender": "M",
            "pnr": "B66U88",
            "ticketNumber": "1538051",
            "reserveDateTime": "2025-02-03 12:40:10",
            "phone": "+989122953473",
            "email": "info@sepehrsystems.net",
            "nationalityCountryCode": "IR",
            "passport": null,
            "iranianCodeMelli": "0010420207",
            "hotelName": null,
            "oppositeFlight_Id": null,
            "oppositeFlight_Number": null,
            "oppositeFlight_DepartureDatetime": null,
            "reserveByUserId": 5277,
            "reserveByUserName": "فروش نقدي اينترنتي",
            "reserveForAgencyId": 2822,
            "reserveForAgencyName": "فروش نقدي اينترنتي",
            "cabinType": "Economy",
            "bookingCode": "Y",
            "fareName": "THRAWZ IS 120",
            "priceBreakdown": {
                "baseFare": 1200000.00,
                "tax": 0.00,
                "totalFare": 1200000.00,
                "commission": 120000.00,
                "discount": 0.00,
                "surcharge": 0.00,
                "payable": 1080000.00,
                "currencyCode": "IRR"
            }
        }
    ]
}
```

<br>
