Changes for page 1. SearchHotelPrices

Last modified by Giorgi Mdivnishvili on 2024/11/06 10:47

From 2.1 to 1.1 From 15.1 to 14.1

From version 14.1

edited by Giorgi Mdivnishvili
on 2024/04/11 17:55

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 @@
--1. SearchHotelPrices
++SearchHotelPrices

Content

@@ -6,37 +6,13 @@
  = Method Description =
++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.
--This method is specifically designed for the retrieval of hotel pricing information. It supports queries for both current date prices and for prices over a specified date range.
--**Parameters:**
++== Endpoint URL - [GET] ==
--* stayDays (integer): Indicates the starting point of the stay duration in days. A default value of 0 signifies immediate date pricing retrieval.
--* stayDaysTo (integer): Specifies the endpoint of the stay duration in days. The initial value is set to 0, indicating the system will fetch prices for the immediate date by default.
--
--**Constraints:**
--
--* The difference between stayDays and stayDaysTo must not exceed 7 days. This limitation is imposed to optimize the query performance and ensure the relevance of the returned data.
--
--**Implementation:**
--
--1. **Query Initialization**: Begin by defining the stayDays and stayDaysTo parameters to frame your search criteria. These parameters enable the system to understand the desired duration for which the hotel pricing information is required.
--1. **Data Retrieval**: Execute the method with the provided parameters. The system processes the input and queries the database for hotel prices that match the specified duration, taking into account the constraint on the maximum duration difference.
--1. **Result Processing**: Upon successful retrieval, the system presents the hotel pricing data. This data is either for the current date (when both parameters are set to 0) or for the defined date range, adhering to the specified duration constraints.
--
--**Example Usage:** (Examples of API calls or function usage would typically be provided here, demonstrating how to correctly implement the method to retrieve hotel prices based on immediate dates or a specified date range.)
--
--**Notes:**
--
--* This method ensures efficient access to hotel pricing information, catering to both immediate and short-term planning needs by leveraging a simple, parameter-driven query mechanism.
--
--This documentation provides a detailed guide for developers on utilizing the hotel pricing retrieval method, emphasizing parameter usage, operational constraints, and the process flow for executing queries and handling results.
--
--
--== Endpoint URL - [POST] ==
--
  {{info}}
--[[https:~~/~~/integration.kazunion.com/api/OnlyHotelPackages/SearchHotelPrices>>https://integration.kazunion.com/api/OnlyHotelPackages/SearchHotelPrices]]
++[[http:~~/~~/online-api.kazunion.com/api/Catalogue/GetHotels>>http://online-api.kazunion.com/api/Catalogue/GetHotels]]
  {{/info}}
@@ -44,106 +44,22 @@
  (% class="box infomessage" %)
  (((
--None
--)))
++
--== Request Body ==
++|**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]]
--{{code language="Json"}}
--{
--  "countryCode": "string",
--  "locations": [
--    {
--      "type": "string",
--      "parent": "string",
--      "label": "string",
--      "subLabel": "string",
--      "value": "string",
--      "tag": "string"
--    }
--  ],
--  "checkInDate": "2023-12-14",
--  "checkInDateTo": "2023-12-14",
--  "checkOutDate": "2023-12-14",
--  "stayDays": 0,
--  "stayDaysTo": 0,
--  "adults": 0,
--  "children": 0,
--  "childrenAges": [
--    0
--  ],
--  "extendedSearch": true,
--  "totalPriceFrom": 0,
--  "totalPriceTo": 0,
--  "recommended": true,
--  "popular": true,
--  "freeSale": true,
--  "groupByHotel": true,
--  "hotelCodes": [
--    "string"
--  ],
--  "mealPlans": [
--    "string"
--  ],
--  "hotelClasses": [
--    "string"
--  ],
--  "hotelTypes": [
--    "CityHotel"
--  ],
--  "hotelServices": [
--    "HasAlcohol"
--  ],
--  "pagingId": "string",
--  "pageNumber": 0,
--  "pageRowCount": 0
--}
--{{/code}}
++
++)))
--== Request Body example ==
++== Request Body ==
  {{code language="Json"}}
--{
--  "countryCode": "AE",
--  "checkInDate": "2024-02-15",
--  "checkInDateTo": "2024-02-20",
--
--  "stayDays": 4,
--  "stayDaysTo": 6,
--  "adults": 1,
--  "children": 1,
--  "childrenAges": [
--    1
--  ],
--  "extendedSearch": false,
--  "totalPriceFrom": 10,
--  "totalPriceTo": 10000,
--  "recommended": false,
--  "popular": true,
--  "freeSale": true,
--  "groupByHotel": true,
--  "hotelCodes": [
--
--  ],
--  "mealPlans": [
--
--  ],
--  "hotelClasses": [
--
--  ],
--  "hotelTypes": [
--
--  ],
--  "hotelServices": [
--
--  ],
--  "pagingId": "",
--  "pageNumber": 3,
--  "pageRowCount": 10
--}
++none
  {{/code}}
++
  == Response Body ==
  {{code language="json"}}
@@ -171,253 +171,81 @@
  {{/code}}
--=== Response Body example ===
++=== example ===
  {{code language="Json"}}
  {
--    "packages": [
--        {
--            "id": "onlyhotel:c4e23e7e-3d54-4efa-a3db-88508230ce91:504f63ca-6dd5-4d84-8245-cf7e77ccff73",
--            "priceCurrency": "USD",
--            "totalPrice": 381.7,
--            "agentCommissionPercent": 0.0,
--            "agentCommissionAmount": 0.0,
--            "hotel": {
--                "hotelPriceId": "504f63ca-6dd5-4d84-8245-cf7e77ccff73",
--                "providerId": 13,
--                "hotelName": "Golden Tulip Al Barsha Hotel",
--                "hotelCode": "ed0820c5-29b0-4e1b-8bcf-9f3c181e7961",
--                "nigths": 4,
--                "mealPlan": "RO",
--                "hotelClass": "4",
--                "availabilityType": "FreeSale",
--                "availableRoomsCount": 0,
--                "fewRooms": true,
--                "roomCategoryCode": "e63ea5ac-4883-4059-bb0a-795a534bbbfb",
--                "roomCategoryName": "Superior Twin",
--                "placementTypeName": "SNGL + CHILD(6-11.99)sharing",
--                "checkInDate": "2024-02-17T08:00:00.000Z",
--                "checkOutDate": "2024-02-21T08:00:00.000Z",
--                "adults": 1,
--                "children": 1,
--                "districtUID": "4c65f6ed-902b-4fd8-9419-af7884c22c5e",
--                "districtName": "Al Barsha",
--                "cityUID": "f5185fa3-3f56-44ed-bf6b-80386a33caa2",
--                "cityName": "Dubai",
--                "countryCode": "AE",
--                "countryName": "United Arab Emirates",
--                "hasAlcohol": true,
--                "hasFreeWifi": true,
--                "hasMetro": false,
--                "hasPool": true,
--                "hasMall": false,
--                "cancellationPolicyDescription": "Cancellation Policy: 15 Day Before Arrival: 100.00 %, Early Departure: 100.00 %, NoShow: 100.00 %",
--                "cancellationPolicy": {
--                    "noShowChargeValue": 100.0,
--                    "noShowChargeValueType": "%",
--                    "earlyDepartureChargeValue": 100.0,
--                    "earlyDepartureChargeValueType": "%",
--                    "conditions": [
--                        {
--                            "timeunits": 15,
--                            "timeunitType": "Day",
--                            "timeOffsetTypeName": "Before Arrival",
--                            "chargeValue": 100.0,
--                            "chargeValueType": "%"
--                        }
--                    ]
--                }
--            },
--            "extraServices": []
--        },
++        "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
++    },
++    {
++        "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}}
--SearchOnlyHotelPackagesResponse{
--
--|packages|[
--nullable: trueOnlyHotelPackage{(((
--|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
--
--}]
--)))
--
--}]
--)))
--
--}]
--)))
--|pagingId|string
--nullable: true
--|pageNumber|integer($int64)
--|pageCount|integer($int64)
--
--}
--{{/success}}
--
--
--== Definitions ==
--
--
--=== Paging and Caching ===
--
--During the first request, Paging id must be  empty like this  ( "pagingId": "",)  pagenumber is the number of the page, pagerowcount means number of the given result in one page. So in the first request we can search like this:
--
--
--==== first request ====
--
--{{code language="Json"}}
-- {
--  "pagingId": "",
--  "pageNumber": 1,
--  "pageRowCount":10
-- }
  {{/code}}
--
--
--==== Request with caching ====
--
--as we receive response, in the end we can see pagingId- number, chich we can use for caching, and then just switch pagenumbers. for cleaning cache, it's important to make new request without pagingID
--
--{{code language="Json"}}
-- {
--  "pagingId": "80",
--  "pageNumber": 1,
--  "pageRowCount":10
-- }
--{{/code}}
--
--
--
--== Important ==
--
--{{error}}
--It's Important to in every other request header, put Auth token
--
--**Key **- Authorization
--
--**Value **- Bearer Token what is given in this response.
--
--
--**also note in headers that:**
--
--Content-Type - application/json
--
--**Key - **X-nugios-timezone
--
--**Value **- 240
--{{/error}}

Changes for page 1. SearchHotelPrices

Summary

Details

Applications

Navigation