---
title: "Retrieve | ExcessBaggage | Bot | مستندات وب سرویس سپهر"
---

# ExcessBaggage Retrieve



این متد برای به بدست آوردن اضافه بار یک مسافر استفاده میشود.

<br>

API Endpoint

```http
POST https://{SupplierWebsiteUrl}/api/B2M/Bot/BookingManagement/Flight/Owned/ExcessBaggage/Retrieve/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) مراجعه کنید.
  :::

- `Culture`

  string enum

  [required]

  مشخص‌کننده زبان متن‌های بازگشتی در پاسخ سرویس. مقادیر پذیرفته شده عبارتند از: fa-IR ، en-US و ar-IQ  

- `TicketNumberList`

  List of string

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

<br>

## Sample Request

```curl
curl -X POST https://SepehrApiTest.ir/api/B2M/Bot/BookingManagement/Flight/Owned/ExcessBaggage/Retrieve/V1 \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip, deflate" \
  -d '{
    "UserName": "testdev1",
    "Password": "25f9e794323b453885f5181f1b624d0b",
    "Culture": "fa-IR",
    "TicketNumberList": [
      "1550011",
      "1550012"]
}'
```


<br>

## Response Data

- `ExcessBaggageAssignmentList`

  List of ExcessBaggageAssignment

  لیستی از شماره بلیت و صندلی های مربوط به هر کدام

  - `ExcessBaggageAssignmentList.TicketNumber`

    string

    شماره بلیت

  - `ExcessBaggageAssignmentList.ExcessBaggageWeightKg`

    integer

    میزان اضافه بار به کیلوگرم

<br>

## Sample Response

```json
{
  "ExcessBaggageAssignmentList": [
    {
      "TicketNumber": "1550011",
      "ExcessBaggageWeightKg": 22
    },
    {
      "TicketNumber": "1550012",
      "ExcessBaggageWeightKg": null
    }
  ]
}
```


<br>

## Response common exceptions

در جدول زیر لیستی از خطاهایی که ممکن است بعد از فراخوانی این متد برگشت داده شود، فهرست شده است.

| ExceptionType | توضیح خطا |
| :---: | :---: |
| Error1017-TicketNumberNotFound | شماره بلیت در سیستم پیدا نشد |
| Exception | خطای نامشخص. جهت دریافت اطلاعات بیشتر باید به ErrorMessage داخل json برگشتی مراجعه نمود. |

<br>