Changes for page 2. CalcPackage

Last modified by Giorgi Mdivnishvili on 2024/04/12 18:58

From 2.1 to 1.1

From version 12.2

edited by Giorgi Mdivnishvili
on 2024/04/12 18:58

Change comment: There is no comment for this version

To version 2.1

edited by Giorgi Mdivnishvili
on 2023/12/14 12:07

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--2. CalcPackage
++CalcPackage

Content

@@ -6,13 +6,13 @@
  = Method Description =
--This method is used to calculate package only hotels, to recheck prices, availability, prices and cancelation policy before book.
++The initial method of the integration process is authorization. You will be provided with a test user username and password to generate the access token that you will need to pass in all the following methods.
--== Endpoint URL - [POST] ==
++== Endpoint URL - [GET] ==
  {{info}}
--[[https:~~/~~/integration.kazunion.com/api/OnlyHotelPackages/CalcPackage>>https://integration.kazunion.com/api/OnlyHotelPackages/CalcPackage]]
++[[http:~~/~~/online-api.kazunion.com/api/Catalogue/GetHotels>>http://online-api.kazunion.com/api/Catalogue/GetHotels]]
  {{/info}}
@@ -20,7 +20,12 @@
  (% class="box infomessage" %)
  (((
--None
++
++
++|**Key**|**Value**|**Request URL**
++|CountryCode|AE|[[http:~~/~~/online-api.kazunion.com/api/Catalogue/GetHotels?countryCode=AE>>http://online-api.kazunion.com/api/Catalogue/GetHotels?countryCode=AE]]
++
++
  )))
@@ -27,351 +27,112 @@
  == Request Body ==
  {{code language="Json"}}
--none{
--  "packageId": "string",
--  "extraServicePriceCodes": [
--    "string"
--  ]
--}
++none
  {{/code}}
--== (% id="cke_bm_10575S" style="display:none" %) (%%)Request Body example ==
--{{code language="Json"}}
--{
--    "packageId": "onlyhotel:25a0ce83-047e-485a-8fd7-f2b5a7a1fa37:9963330c-2346-4330-b9cf-7abbb0f64636",
--    "includeInsurance": false
--}
--{{/code}}
++== Response Body ==
--
--== Response ==
--
  {{code language="json"}}
--{
--  "error": true,
--  "errorCode": "string",
--  "errorDescription": "string",
--  "userErrorDescription": "string",
--  "package": {
--    "id": "string",
--    "priceCurrency": "string",
--    "totalPrice": 0,
--    "agentCommissionPercent": 0,
--    "agentCommissionAmount": 0,
--    "hotel": {
--      "hotelPriceId": "string",
--      "providerId": 0,
--      "hotelName": "string",
--      "hotelCode": "string",
--      "nigths": 0,
--      "mealPlan": "string",
--      "hotelClass": "string",
--      "availabilityType": "OnRequest",
--      "availableRoomsCount": 0,
--      "fewRooms": true,
--      "roomCategoryCode": "string",
--      "roomCategoryName": "string",
--      "placementTypeName": "string",
--      "placementDescription": "string",
--      "checkInDate": "2023-12-14T08:49:36.703Z",
--      "checkOutDate": "2023-12-14T08:49:36.703Z",
--      "adults": 0,
--      "children": 0,
--      "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "districtName": "string",
--      "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "cityName": "string",
--      "countryCode": "string",
--      "countryName": "string",
--      "hasAlcohol": true,
--      "hasFreeWifi": true,
--      "hasMetro": true,
--      "hasPool": true,
--      "hasMall": true,
--      "cancellationPolicyDescription": "string",
--      "cancellationPolicy": {
--        "cancellationPolicyCode": "string",
--        "noShowChargeValue": 0,
--        "noShowChargeValueType": "string",
--        "earlyDepartureChargeValue": 0,
--        "earlyDepartureChargeValueType": "string",
--        "conditions": [
--          {
--            "timeunits": 0,
--            "timeunitType": "string",
--            "timeOffsetTypeName": "string",
--            "chargeValue": 0,
--            "chargeValueType": "string"
--          }
--        ]
--      }
--    },
--    "extraServices": [
--      {
--        "extraServiceCode": "string",
--        "extraServiceTypeCode": "string",
--        "isMandatory": 0,
--        "extraServiceName": "string",
--        "minimalServiceAmount": 0,
--        "includedPriceCode": "string",
--        "prices": [
--          {
--            "extraServicePriceCode": "string",
--            "displayName": "string",
--            "restrictionInfo": "string",
--            "additionalInfo": "string",
--            "price": 0,
--            "extraPrice": 0,
--            "currency": "string"
--          }
--        ]
--      }
--    ]
++[
++  {
++    "hotelCode": "string",
++    "hotelName": "string",
++    "hotelClass": "string",
++    "cityUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "countryCode": "string",
++    "countryName": "string",
++    "districtUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "cityName": "string",
++    "districtName": "string",
++    "hotelType": "CityHotel",
++    "latitude": "string",
++    "longitude": "string",
++    "hasAlcohol": true,
++    "hasFreeWifi": true,
++    "hasMetro": true,
++    "hasPool": true,
++    "hasMall": true
    }
--}
++]
  {{/code}}
--=== Response example ===
++=== example ===
  {{code language="Json"}}
  {
--    "package": {
--        "id": "onlyhotel:25a0ce83-047e-485a-8fd7-f2b5a7a1fa37:9963330c-2346-4330-b9cf-7abbb0f64636",
--        "priceCurrency": "USD",
--        "totalPrice": 46.94,
--        "agentCommissionPercent": 0.00,
--        "agentCommissionAmount": 0.00,
--        "hotel": {
--            "hotelPriceId": "9963330c-2346-4330-b9cf-7abbb0f64636",
--            "hotelName": "Royal Continental Hotel",
--            "hotelCode": "03cf038c-df96-4926-af5f-0f285e600405",
--            "nigths": 1,
--            "mealPlan": "RO",
--            "hotelClass": "4",
--            "hotelColor": "#000000",
--            "availabilityType": "FreeSale",
--            "availableRoomsCount": 0,
--            "fewRooms": true,
--            "roomCategoryCode": "ff13e5ec-2116-46d1-9ff4-ae76be84ff91",
--            "roomCategoryName": "Superior King Room",
--            "placementTypeName": "DBL",
--            "checkInDate": "2024-06-30T00:00:00.000",
--            "checkOutDate": "2024-07-01T00:00:00.000",
--            "adults": 2,
--            "children": 0,
--            "districtUID": "aaff2238-fa72-4900-83f8-a16990415547",
--            "districtName": "Deira",
--            "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
--            "cityName": "Dubai",
--            "countryCode": "AE",
--            "countryName": "United Arab Emirates",
--            "hasAlcohol": false,
--            "hasFreeWifi": true,
--            "hasMetro": false,
--            "hasPool": true,
--            "hasMall": false,
--            "infantMaxAge": 5.99,
--            "childMinAge": 6.00,
--            "childMaxAge": 11.99,
--            "teenMinAge": 0.0,
--            "teenMaxAge": 0.0,
--            "adultMinAge": 12.00,
--            "cancellationPolicyDescription": "Cancellation Policy: 1 Day Before Arrival: 1.00 Night, Early Departure: 100.00 %, NoShow: 100.00 %",
--            "cancellationPolicy": {
--                "noShowChargeValue": 100.00,
--                "noShowChargeValueType": "%",
--                "earlyDepartureChargeValue": 100.00,
--                "earlyDepartureChargeValueType": "%",
--                "conditions": [
--                    {
--                        "timeunits": 1,
--                        "timeunitType": "Day",
--                        "timeOffsetTypeName": "Before Arrival",
--                        "chargeValue": 1.00,
--                        "chargeValueType": "Night"
--                    }
--                ]
--            }
--        },
--        "extraServices": [],
--        "insurancePrice": {
--            "name": "Insurance (10000 USD) with COVID coverage",
--            "price": 8.96,
--            "actualStartDate": "2024-06-30T00:00:00.000",
--            "actualEndDate": "2024-07-01T00:00:00.000",
--            "optional": true,
--            "includedInPackagePrice": false
--        },
--        "sortCheckInOut": "30.06.2024-01.07.2024",
--        "sortHotelName": "royal continental hotel",
--        "sortDetails": "ro",
--        "sortPlacement": "superior king room dbl"
++        "hotelCode": "cfbca5b5-4090-4bcd-805a-463d83423b86",
++        "hotelName": "Ramada Abu Dhabi Corniche",
++        "hotelClass": "4",
++        "cityUID": "28c794fe-3c7e-4da2-ba93-f24bd3d4730d",
++        "countryCode": "AE",
++        "districtUID": "ee402984-6d1d-4fcf-915d-f31b14fa8b0f",
++        "cityName": "Abu Dhabi",
++        "districtName": "Abu Dhabi",
++        "hotelType": "CityHotel",
++        "latitude": "24.503759",
++        "longitude": "54.374577",
++        "hasAlcohol": false,
++        "hasFreeWifi": true,
++        "hasMetro": false,
++        "hasPool": true,
++        "hasMall": false
      },
--    "refreshPriceResult": "Success",
--    "error": false
--}
++    {
++        "hotelCode": "c64b6082-2337-4519-8c33-4bcdef76b16b",
++        "hotelName": "Emirates Palace Mandarin Oriental, Abu Dhabi",
++        "hotelClass": "5",
++        "cityUID": "28c794fe-3c7e-4da2-ba93-f24bd3d4730d",
++        "countryCode": "AE",
++        "districtUID": "ee402984-6d1d-4fcf-915d-f31b14fa8b0f",
++        "cityName": "Abu Dhabi",
++        "districtName": "Abu Dhabi",
++        "hotelType": "BeachHotel",
++        "latitude": "24.461556",
++        "longitude": "54.317404",
++        "hasAlcohol": false,
++        "hasFreeWifi": true,
++        "hasMetro": false,
++        "hasPool": true,
++        "hasMall": false
++    },
  {{/code}}
  === Schema ===
--{{success}}
--CalcOnlyHotelPackageResponse{
--
--|error|boolean
--|errorCode|string
--nullable: true
--|errorDescription|string
--nullable: true
--|userErrorDescription|string
--nullable: true
--|package|OnlyHotelPackage{(((
--|id|string
--nullable: true
--|priceCurrency|string
--nullable: true
--|totalPrice|number($double)
--|agentCommissionPercent|number($double)
--|agentCommissionAmount|number($double)
--|hotel|PackageHotel{(((
--|hotelPriceId|string
--nullable: true
--|providerId|integer($int32)
--|hotelName|string
--nullable: true
--|hotelCode|string
--nullable: true
--|nigths|integer($int32)
--|mealPlan|string
--nullable: true
--|hotelClass|string
--nullable: true
--|availabilityType|RoomAvailabilityTypeEnumstringEnum:
--[ OnRequest, FreeSale, StopSale ]
--|availableRoomsCount|integer($int32)
--|fewRooms|boolean
--|roomCategoryCode|string
--nullable: true
--|roomCategoryName|string
--nullable: true
--|placementTypeName|string
--nullable: true
--|placementDescription|string
--nullable: true
--|checkInDate|string($date-time)
--|checkOutDate|string($date-time)
--|adults|integer($int32)
--|children|integer($int32)
--|districtUID|string($uuid)
--nullable: true
--|districtName|string
--nullable: true
--|cityUID|string($uuid)
--nullable: true
--|cityName|string
--nullable: true
--|countryCode|string
--nullable: true
--|countryName|string
--nullable: true
--|hasAlcohol|boolean
--|hasFreeWifi|boolean
--|hasMetro|boolean
--|hasPool|boolean
--|hasMall|boolean
--|cancellationPolicyDescription|string
--nullable: true
--|cancellationPolicy|CancellationPolicyExchange{(((
--|cancellationPolicyCode|string
--nullable: true
--|noShowChargeValue|number($double)
--nullable: true
--|noShowChargeValueType|string
--nullable: true
--|earlyDepartureChargeValue|number($double)
--nullable: true
--|earlyDepartureChargeValueType|string
--nullable: true
--|conditions|[
--nullable: trueCancellationPolicyConditionExchange{(((
--|timeunits|integer($int32)
--|timeunitType|string
--nullable: true
--|timeOffsetTypeName|string
--nullable: true
--|chargeValue|number($double)
--nullable: true
--|chargeValueType|string
--nullable: true
--
++{{code language="none"}}
++[Hotel{
++hotelCode string
++nullable: true
++hotelName string
++nullable: true
++hotelClass string
++nullable: true
++cityUID string($uuid)
++nullable: true
++countryCode string
++nullable: true
++countryName string
++nullable: true
++districtUID string($uuid)
++nullable: true
++cityName string
++nullable: true
++districtName string
++nullable: true
++hotelType HotelTypeEnumstring
++Enum:
++[ CityHotel, BeachHotel, SecondLineBeach ]
++latitude string
++nullable: true
++longitude string
++nullable: true
++hasAlcohol boolean
++hasFreeWifi boolean
++hasMetro boolean
++hasPool boolean
++hasMall boolean
  }]
--)))
--
--}
--)))
--
--}
--)))
--|extraServices|[
--nullable: trueHotelExtraServiceBase{(((
--|extraServiceCode|string
--nullable: true
--|extraServiceTypeCode|string
--nullable: true
--|isMandatory|integer($int32)
--|extraServiceName|string
--nullable: true
--|minimalServiceAmount|number($double)
--|includedPriceCode|string
--nullable: true
--|prices|[
--nullable: trueHotelExtraServicePriceBase{(((
--|extraServicePriceCode|string
--nullable: true
--|displayName|string
--nullable: true
--|restrictionInfo|string
--nullable: true
--|additionalInfo|string
--nullable: true
--|price|number($double)
--|extraPrice|number($double)
--|currency|string
--nullable: true
--
--}]
--)))
--
--}]
--)))
--
--}
--)))
--
--}
--{{/success}}
--
--
--
--== Important ==
--
--{{error}}
--=== Implementing Authorization in Subsequent Requests ===
--
--For every API request after the initial authentication, it's crucial to include the authorization token in the request header. This ensures your requests are authorized and can access the necessary resources. Here's how to properly include your token:
--
--* **Header Key:** Authorization
--* **Header Value:** Bearer [Your Token Here] - Use the bearer token provided in the initial authentication response. The authorization type should be specified as Bearer Token.
--
--Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
--
--* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
--* **Header Key:** X-nugios-timezone
--* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
--
--Incorporating these headers with their respective values is essential for the successful processing of your API requests.
--{{/error}}
--
--
++{{/code}}

Changes for page 2. CalcPackage

Summary

Details

Applications

Navigation