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

ExcessBaggage Update

Download Markdown for LLM

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

ویرایش و کنسل کردن

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

برای کنسل کردن اضافه بار، شماره بلیت موردنظر را در TicketNumber ارسال کرده و مقدار ExcessBaggageWeightKg را خالی ارسال کنید.


API Endpoint

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

  • Culture

    string enum

    required

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

  • ExcessBaggageAssignmentList

    List of ExcessBaggageAssignment

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

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

    • ExcessBaggageAssignmentList.TicketNumber

      string

      شماره بلیت

    • ExcessBaggageAssignmentList.ExcessBaggageWeightKg

      integer

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


Sample Request

curl -X POST https://SepehrApiTest.ir/api/B2M/Bot/BookingManagement/Flight/Owned/ExcessBaggage/Update/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",
    "Culture": "fa-IR",
    "ExcessBaggageAssignmentList": [
    {
      "TicketNumber": "1550011",
      "ExcessBaggageWeightKg": 22
    },
    {
      "TicketNumber": "1550012",
      "ExcessBaggageWeightKg": 5
    }]
}'

Response Data

No Content

http code 204

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


Sample Response

204 No Content

Response common exceptions

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

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