retrieve-booking

Download Markdown for LLM

متد GetStatus

کاربرد این متد برای زمانی است که شما متد Book را فراخوانی نموده اید، ولی به هر دلیلی – مانند مشکلات شبکه و قطعی اینترنتی یا ریست شدن سرور – جوابی از سپهر دریافت نکرده اید، با استفاده از این متد می توانید وضعیت درخواست رزرو و اینکه آیا رزرو صادر شده است یا خیر را بررسی نمایید.

پیشنهاد می گردد اگر بعد از فراخوانی متد Book هیچ جوابی دریافت نکردید، حداقل 15 ثانیه صبر نموده و سپس از متد GetStatus استفاده نمایید. در صورتی که فاصله بین فراخوانی متد Book و متد GetStatus کمتر از 15 ثانیه باشد، احتمال اینکه متد GetStatus جواب اشتباهی را خروجی دهد زیاد است. و ممکن است رزرو شما در حال صادر شدن باشد ولی متد GetStatus در جواب پاسخ دهد که هیچ رزروی صادر نشده است. به بیان فنی تر می توان اینطور گفت که وقتی متد Book را فراخوانی می نمایید یک Timeout به میزان 15 ثانیه برای آن تنظیم نمایید و در صورتی که خطای timeout دریافت کردید آنگاه متد GetStatus را فراخوانی نمایید تا از نتیجه صادر شدن یا نشدن رزرو خود مطلع شوید.

این متد در صورت اعمال هرگونه تغییر در اطلاعات مسافران یا هتل, آخرین وضعیت رزرو (Last State) را خروجی میدهد.


API Endpoint

POST https://{SupplierWebsiteUrl}/api/Partners/Hotel/RetrieveBooking/V1/GetStatus

Request Parameters


Sample Request

curl -X POST https://SepehrApiTest.ir/api/Partners/Hotel/RetrieveBooking/V1/GetStatus \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip, deflate" \
  -d '{
  "Credential": {
    "Username": "testdev1",
    "Password": "25f9e794323b453885f5181f1b624d0b"
  },
  "YourLocalInventoryPnr": "24d3af03-bc90-4d77-bc4d-0a6c9230c36c"
}'

Response Parameters


Sample Response

{
  "StatusId": 1,
  "StatusDesc": "OK",
  "Pnr": "KV455G",
  "FailReason": null,
  "CharterRoomList": [
    {
      "HotelSepehrGlobalId": 101,
      "HotelName": "ميراژ",
      "RoomTypeSepehrGlobalId": 5004,
      "RoomTypeName": "يک تخته پرزيدنت",
      "CheckinDate": "2023-05-11",
      "CheckoutDate": "2023-05-14",
      "PassengerList": [
        {
          "FirstName": "SAYEDMOHAMMAD",
          "LastName": "KHORSAND",
          "AgeType": "ADL",
          "Gender": "M",
          "Birthdate": "1993-05-09",
          "NationalityCountry": null,
          "IranianCartMelli": {
            "CodeMelli": "0010752821"
          },
          "Passport": null
        },
        {
          "FirstName": "GITI",
          "LastName": "ZAHEDI KASHANI",
          "AgeType": "ADL",
          "Gender": "M",
          "Birthdate": "1993-05-09",
          "NationalityCountry": null,
          "IranianCartMelli": {
            "CodeMelli": "0011436301"
          },
          "Passport": null
        }
      ],
      "PriceList": [
        {
          "Date": "2023-05-11",
          "Room_PriceBreakdown": {
            "BoardPrice": 1000000,
            "CommissionPercent": 2,
            "CalculatedAmountOfCommissionPercent": 20000,
            "Discount": 0,
            "Surcharge": 0,
            "NetPrice_TaxExcluded": 980000,
            "VAT_Percent": 0,
            "VAT_Amount": 0,
            "NetPrice_TaxIncluded": 980000
          },
          "Extrabed_PriceBreakdown": {
            "BoardPrice": 1000000,
            "CommissionPercent": 2,
            "CalculatedAmountOfCommissionPercent": 20000,
            "Discount": 0,
            "Surcharge": 0,
            "NetPrice_TaxExcluded": 980000,
            "VAT_Percent": 0,
            "VAT_Amount": 0,
            "NetPrice_TaxIncluded": 980000
          }
        },
        {
          "Date": "2023-05-12",
          "Room_PriceBreakdown": {
            "BoardPrice": 1000000,
            "CommissionPercent": 2,
            "CalculatedAmountOfCommissionPercent": 20000,
            "Discount": 0,
            "Surcharge": 0,
            "NetPrice_TaxExcluded": 980000,
            "VAT_Percent": 0,
            "VAT_Amount": 0,
            "NetPrice_TaxIncluded": 980000
          },
          "Extrabed_PriceBreakdown": {
            "BoardPrice": 1000000,
            "CommissionPercent": 2,
            "CalculatedAmountOfCommissionPercent": 20000,
            "Discount": 0,
            "Surcharge": 0,
            "NetPrice_TaxExcluded": 980000,
            "VAT_Percent": 0,
            "VAT_Amount": 0,
            "NetPrice_TaxIncluded": 980000
          }
        },
        {
          "Date": "2023-05-13",
          "Room_PriceBreakdown": {
            "BoardPrice": 1000000,
            "CommissionPercent": 2,
            "CalculatedAmountOfCommissionPercent": 20000,
            "Discount": 0,
            "Surcharge": 0,
            "NetPrice_TaxExcluded": 980000,
            "VAT_Percent": 0,
            "VAT_Amount": 0,
            "NetPrice_TaxIncluded": 980000
          },
          "Extrabed_PriceBreakdown": {
            "BoardPrice": 1000000,
            "CommissionPercent": 2,
            "CalculatedAmountOfCommissionPercent": 20000,
            "Discount": 0,
            "Surcharge": 0,
            "NetPrice_TaxExcluded": 980000,
            "VAT_Percent": 0,
            "VAT_Amount": 0,
            "NetPrice_TaxIncluded": 980000
          }
        }
      ]
    },
    {
      "HotelSepehrGlobalId": 101,
      "HotelName": "ميراژ",
      "RoomTypeSepehrGlobalId": 5001,
      "RoomTypeName": "دو تخته رو به دريا",
      "CheckinDate": "2023-05-11",
      "CheckoutDate": "2023-05-14",
      "PassengerList": [
        {
          "FirstName": "ZAINAB",
          "LastName": "KHODAMORADIFARD",
          "AgeType": "ADL",
          "Gender": "M",
          "Birthdate": "1993-05-09",
          "NationalityCountry": null,
          "IranianCartMelli": {
            "CodeMelli": "0010387714"
          },
          "Passport": null
        },
        {
          "FirstName": "MAEDE",
          "LastName": "HOSSEINNIA SANJARANI",
          "AgeType": "ADL",
          "Gender": "M",
          "Birthdate": "1993-05-09",
          "NationalityCountry": null,
          "IranianCartMelli": {
            "CodeMelli": "0012025445"
          },
          "Passport": null
        }
      ],
      "PriceList": [
        {
          "Date": "2023-05-11",
          "Room_PriceBreakdown": {
            "BoardPrice": 2000000,
            "CommissionPercent": 0,
            "CalculatedAmountOfCommissionPercent": 0,
            "Discount": 0,
            "Surcharge": 0,
            "NetPrice_TaxExcluded": 2000000,
            "VAT_Percent": 0,
            "VAT_Amount": 0,
            "NetPrice_TaxIncluded": 2000000
          },
          "Extrabed_PriceBreakdown": null
        },
        {
          "Date": "2023-05-12",
          "Room_PriceBreakdown": {
            "BoardPrice": 2000000,
            "CommissionPercent": 0,
            "CalculatedAmountOfCommissionPercent": 0,
            "Discount": 0,
            "Surcharge": 0,
            "NetPrice_TaxExcluded": 2000000,
            "VAT_Percent": 0,
            "VAT_Amount": 0,
            "NetPrice_TaxIncluded": 2000000
          },
          "Extrabed_PriceBreakdown": null
        },
        {
          "Date": "2023-05-13",
          "Room_PriceBreakdown": {
            "BoardPrice": 2000000,
            "CommissionPercent": 0,
            "CalculatedAmountOfCommissionPercent": 0,
            "Discount": 0,
            "Surcharge": 0,
            "NetPrice_TaxExcluded": 2000000,
            "VAT_Percent": 0,
            "VAT_Amount": 0,
            "NetPrice_TaxIncluded": 2000000
          },
          "Extrabed_PriceBreakdown": null
        }
      ]
    }
  ]
}

Response common exceptions

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

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