Changes for page SearchTourPackages - Basic Version

Last modified by Giorgi Mdivnishvili on 2024/07/11 12:45

From 4.1 to 5.1 From 11.1 to 12.1

From version 5.1

edited by Giorgi Mdivnishvili
on 2024/04/11 09:45

Change comment: There is no comment for this version

To version 11.1

edited by Giorgi Mdivnishvili
on 2024/04/11 16:44

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -46,7 +46,35 @@
  }
  {{/code}}
++== Request example for 2Adults 2Child ==
++{{code language="Json"}}
++{
++    "departureCountryCode": "KZ",
++    "departureCityUID": "f0ba6324-f337-405c-8cc7-23d62cf664e8",
++    "arrivalCountryCode": "AE",
++    "adults": 2,
++    "children": 2,
++    "childrenAges": [
++        4,
++        8
++    ],
++    "departureDate": "2024-05-26T00:00:00",
++    "returnDate": "2024-06-02T00:00:00",
++    "departureAndReturnDaysCount": 7,
++    "checkInDate": "2024-05-26T00:00:00",
++    "checkOutDate": "2024-06-02T00:00:00",
++    "checkInAndCheckOutDaysCount": 7,
++    "directFlightsOnly": true,
++    "searchCurrency": "USD",
++
++    "pagingId": "",
++    "pageNumber": 1,
++    "pageRowCount":5
++}
++{{/code}}
++
++
  == Response Body ==
  {{code language="json"}}
@@ -713,6 +713,7 @@
  === **Request Parameters ** ===
++(% class="table-bordered" %)
  |=Key|=Type|=Nullable|=Description
  |departureCountryCode|String|No|The ISO 3166-1 alpha-2 code of the departure country. For example, "KZ" for Kazakhstan.
  |departureCityUID|String (UUID)|No|The unique identifier of the departure city. This is a UUID, such as "f0ba6324-f337-405c-8cc7-23d62cf664e8".
@@ -729,114 +729,90 @@
  |pageRowCount|Integer|No|The number of results to return per page. For example, 1 to return 1 result per page.
  |searchCurrency|String|No|The currency in which the search results should be displayed. For example, "USD" for United States Dollar.
++===   ===
--=== **Response Parameters**  ===
++=== **Response Parameters** ===
--=== Packages ===
++(% class="table-bordered" %)
++|=Key|=Type|=Description
++|packages|Array|An array of travel packages. Each package includes various details about the package.
++|packages[].id|String|A unique identifier for the package. This is used to uniquely identify each package.
++|packages[].priceCurrency|String|The currency in which the price is denoted. This could be USD, EUR, etc.
++|packages[].totalPrice|Number|The total price of the package. This includes all costs associated with the package.
++|packages[].agentCommissionPercent|Number|The commission percentage for the agent. This is the percentage of the total price that the agent receives as commission.
++|packages[].agentCommissionAmount|Number|The commission amount for the agent. This is the actual amount the agent receives as commission.
++|packages[].includedExtrasAmount|Number|The amount for the included extras. This is the cost of any extra services included in the package.
++|packages[].priceDifference|Number|The price difference. This could be a discount or a price increase.
++|packages[].hotel|Object|An object containing details about the hotel included in the package. This includes information like the hotel name, class, availability, etc.
++|packages[].hotel.hotelPriceId|String|The price ID of the hotel. This is used to uniquely identify the price for the hotel.
++|packages[].hotel.hotelName|String|The name of the hotel. This is the actual name of the hotel.
++|packages[].hotel.hotelCode|String|The code of the hotel. This is a unique code used to identify the hotel.
++|packages[].hotel.nights|Number|The number of nights for the stay. This is the duration of the stay at the hotel.
++|packages[].hotel.mealPlan|String|The meal plan for the stay. This could be breakfast included, all inclusive, etc.
++|packages[].hotel.hotelClass|String|The class of the hotel. This could be 3-star, 4-star, 5-star, etc.
++|packages[].hotel.hotelColor|String|The color associated with the hotel. This could be used for categorization or visualization purposes.
++|packages[].hotel.availabilityType|String|The availability type of the hotel. This could be available, sold out, etc.
++|packages[].hotel.availableRoomsCount|Number|The count of available rooms. This is the number of rooms that are currently available at the hotel.
++|packages[].hotel.fewRooms|Boolean|A boolean indicating if there are few rooms left. If true, it means that there are only a few rooms left.
++|packages[].hotel.roomCategoryCode|String|The code of the room category. This is a unique code used to identify the room category.
++|packages[].hotel.roomCategoryName|String|The name of the room category. This is the actual name of the room category.
++|packages[].hotel.placementTypeName|String|The name of the placement type. This could be sea view, garden view, etc.
++|packages[].hotel.placementDescription|String|The description of the placement. This provides more details about the placement type.
++|packages[].hotel.checkInDate|String|The check-in date. This is the date when the stay at the hotel begins.
++|packages[].hotel.checkOutDate|String|The check-out date. This is the date when the stay at the hotel ends.
++|packages[].hotel.adults|Number|The number of adults. This is the number of adults that will be staying at the hotel.
++|packages[].hotel.children|Number|The number of children. This is the number of children that will be staying at the hotel.
++|packages[].hotel.districtUID|String|The UID of the district. This is a unique identifier for the district where the hotel is located.
++|packages[].hotel.districtName|String|The name of the district. This is the actual name of the district where the hotel is located.
++|packages[].hotel.cityUID|String|The UID of the city. This is a unique identifier for the city where the hotel is located.
++|packages[].hotel.cityName|String|The name of the city. This is the actual name of the city where the hotel is located.
++|packages[].hotel.countryCode|String|The code of the country. This is a unique code used to identify the country where the hotel is located.
++|packages[].hotel.countryName|String|The name of the country. This is the actual name of the country where the hotel is located.
++|packages[].hotel.hasAlcohol|Boolean|A boolean indicating if alcohol is available. If true, it means that alcohol is available at the hotel.
++|packages[].hotel.hasFreeWifi|Boolean|A boolean indicating if free Wi-Fi is available. If true, it means that free Wi-Fi is available at the hotel.
++|packages[].hotel.hasMetro|Boolean|A boolean indicating if metro is available. If true, it means that there is a metro station near the hotel.
++|packages[].hotel.hasPool|Boolean|A boolean indicating if a pool is available. If true, it means that the hotel has a pool.
++|packages[].hotel.hasMall|Boolean|A boolean indicating if a mall is available. If true, it means that there is a mall near the hotel.
++|packages[].hotel.infantMaxAge|Number|The maximum age for an infant. This is the maximum age at which a person is considered an infant.
++|packages[].hotel.childMinAge|Number|The minimum age for a child. This is the minimum age at which a person is considered a child.
++|packages[].hotel.childMaxAge|Number|The maximum age for a child. This is the maximum age at which a person is considered a child.
++|packages[].hotel.teenMinAge|Number|The minimum age for a teen. This is the minimum age at which a person is considered a teen.
++|packages[].hotel.teenMaxAge|Number|The maximum age for a teen. This is the maximum age at which a person is considered a teen.
++|packages[].hotel.adultMinAge|Number|The minimum age for an adult. This is the minimum age at which a person is considered an adult.
++|packages[].hotel.cancellationPolicyDescription|String|The description of the cancellation policy. This provides more details about the cancellation policy of the hotel.
++|packages[].hotel.cancellationPolicy|Object|An object containing details about the cancellation policy. This includes information like the cancellation deadline, cancellation fee, etc.
++|packages[].flight|Object|An object containing details about the flight included in the package. This includes information like the flight ID, departure date, return date, etc.
++|packages[].flight.id|String|The ID of the flight. This is used to uniquely identify the flight.
++|packages[].flight.departureDate|String|The departure date of the flight. This is the date when the flight departs.
++|packages[].flight.returnDate|String|The return date of the flight. This is the date when the flight returns.
++|packages[].flight.departureTicketsLeft|Number|The number of departure tickets left. This is the number of tickets that are still available for the departure flight.
++|packages[].flight.returnTicketsLeft|Number|The number of return tickets left. This is the number of tickets that are still available for the return flight.
++|packages[].flight.departureAvailabilityType|String|The availability type of the departure flight. This could be available, sold out, etc.
++|packages[].flight.returnAvailabilityType|String|The availability type of the return flight. This could be available, sold out, etc.
++|packages[].flight.isTwoWay|Boolean|A boolean indicating if the flight is two-way. If true, it means that the flight includes both departure and return.
++|packages[].flight.sameBaggageForAll|Boolean|A boolean indicating if the same baggage is for all. If true, it means that the same baggage allowance applies to all passengers.
++|packages[].flight.totalBaggage|Boolean|A boolean indicating if total baggage is included. If true, it means that the total baggage allowance is included in the price.
++|packages[].flight.isBlock|Boolean|A boolean indicating if the flight is blocked. If true, it means that the flight is currently blocked and cannot be booked.
++|packages[].flight.class|String|The class of the flight. This could be economy, business, first class, etc.
++|packages[].flight.departureSegments|Array|An array containing details about the departure segments. Each segment includes information like the departure airport, arrival airport, departure time, arrival time, etc.
++|packages[].flight.returnSegments|Array|An array containing details about the return segments. Each segment includes information like the departure airport, arrival airport, departure time, arrival time, etc.
++|packages[].flight.passengers|Array|An array containing details about the passengers. Each passenger includes information like the passenger type, baggage allowance, etc.
++|packages[].extraServices|Array|An array of any extra services included in the package. Each service includes information like the service name, service price, etc.
++|packages[].insurancePrice|Object|An object containing details about the insurance price included in the package. This includes information like the insurance type, insurance price, etc.
++|packages[].cacheKey|String|The cache key. This is used to cache the package details for faster retrieval.
++|packages[].sortCheckInOut|String|The check-in and check-out dates for sorting. This is used to sort the packages based on the check-in and check-out dates.
++|packages[].sortAirline|String|The airline for sorting. This is used to sort the packages based on the airline.
++|packages[].sortHotelName|String|The hotel name for sorting. This is used to sort the packages based on the hotel name.
++|packages[].sortDetails|String|The details for sorting. This is used to sort the packages based on various details.
++|packages[].sortPlacement|String|The placement for sorting. This is used to sort the packages based on the placement.
++|pagingId|String|An identifier for the page. This is used to uniquely identify each page of results.
++|pageNumber|Number|The current page number. This is the number of the current page of results.
++|pageCount|Number|The total number of pages. This is the total number of pages of results.
++|totalCount|Number|The total count of packages. This is the total number of packages in all pages of results.
++|error|Boolean|A boolean indicating whether there was an error. If true, it means that there was an error in retrieving the packages.
--|=Field|=Type|=Description
--|id|string|Unique identifier for the package
--|priceCurrency|string|Currency for the price
--|totalPrice|number|Total price of the package
--|agentCommissionPercent|number|Commission percentage for the agent
--|agentCommissionAmount|number|Commission amount for the agent
--|includedExtrasAmount|integer|Amount of included extras
--|priceDifference|integer|Price difference
--|hotel|object|Details about the hotel
--|flight|object|Details about the flight
--|extraServices|array|Extra services included in the package
--|insurancePrice|object|Details about the insurance price
--|cacheKey|string|Cache key
--|sortCheckInOut|string|Sorting parameter based on check-in and check-out dates
--|sortAirline|string|Sorting parameter based on airline
--|sortHotelName|string|Sorting parameter based on hotel name
--|sortDetails|string|Sorting parameter based on details
--|sortPlacement|string|Sorting parameter based on placement
++====   ====
--=== Hotel ===
--
--|=Field|=Type|=Description
--|hotelPriceId|string|Unique identifier for the hotel price
--|hotelName|string|Name of the hotel
--|hotelCode|string|Code of the hotel
--|nights|integer|Number of nights
--|mealPlan|string|Meal plan
--|hotelClass|string|Class of the hotel
--|hotelColor|string|Color associated with the hotel
--|availabilityType|string|Availability type of the hotel
--|availableRoomsCount|integer|Number of available rooms
--|fewRooms|boolean|Whether there are few rooms left
--|roomCategoryCode|string|Code of the room category
--|roomCategoryName|string|Name of the room category
--|placementTypeName|string|Name of the placement type
--|placementDescription|string|Description of the placement
--|checkInDate|string|Check-in date
--|checkOutDate|string|Check-out date
--|adults|integer|Number of adults
--|children|integer|Number of children
--|districtUID|string|Unique identifier for the district
--|districtName|string|Name of the district
--|cityUID|string|Unique identifier for the city
--|cityName|string|Name of the city
--|countryCode|string|Country code
--|countryName|string|Name of the country
--|hasAlcohol|boolean|Whether the hotel has alcohol
--|hasFreeWifi|boolean|Whether the hotel has free Wi-Fi
--|hasMetro|boolean|Whether the hotel is near a metro
--|hasPool|boolean|Whether the hotel has a pool
--|hasMall|boolean|Whether the hotel is near a mall
--|infantMaxAge|number|Maximum age for an infant
--|childMinAge|number|Minimum age for a child
--|childMaxAge|number|Maximum age for a child
--|teenMinAge|number|Minimum age for a teen
--|teenMaxAge|number|Maximum age for a teen
--|adultMinAge|number|Minimum age for an adult
--|cancellationPolicyDescription|string|Description of the cancellation policy
--|cancellationPolicy|object|Details about the cancellation policy
--
--=== Flight ===
--
--|=Field|=Type|=Description
--|id|string|Unique identifier for the flight
--|departureDate|string|Departure date
--|returnDate|string|Return date
--|departureTicketsLeft|integer|Number of departure tickets left
--|returnTicketsLeft|integer|Number of return tickets left
--|departureAvailabilityType|string|Availability type for the departure
--|returnAvailabilityType|string|Availability type for the return
--|isTwoWay|boolean|Whether the flight is two-way
--|sameBaggageForAll|boolean|Whether the same baggage is for all
--|totalBaggage|boolean|Whether the total baggage is included
--|isBlock|boolean|Whether the flight is blocked
--|class|string|Class of the flight
--|departureSegments|array|Details about the departure segments
--|returnSegments|array|Details about the return segments
--|passengers|array|Details about the passengers
--
--=== InsurancePrice ===
--
--|=Field|=Type|=Description
--|name|string|Name of the insurance
--|price|number|Price of the insurance
--|actualStartDate|string|Start date of the insurance
--|actualEndDate|string|End date of the insurance
--|optional|boolean|Whether the insurance is optional
--|includedInPackagePrice|boolean|Whether the insurance is included in the package price
--
--=== Paging ===
--
--|=Field|=Type|=Description
--|pagingId|string|Unique identifier for the paging
--|pageNumber|integer|Current page number
--|pageCount|integer|Total number of pages
--|totalCount|integer|Total count of items
--|error|boolean|Whether there is an error
--
--=== 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"}}
@@ -847,10 +847,12 @@
   }
  {{/code}}
++While making first search request, paging id should be empty,  "pageNumber":  and  "pageRowCount":10 means that, in response there will be returned maximum 10 packages per page.
++
  ==== 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
++after receiving response from first search request, in the end we can see pagingId- number, wchich we can use for caching, and (pageinatoin) for switch pagenumbers, and displaying results as we whant. For cleaning cache, it's important to make new request without cllear pagingID, like this  "pagingId": "",
  {{code language="Json"}}
   {
@@ -903,18 +903,18 @@
  == Important ==
  {{error}}
--It's Important to in every other request header, put Auth token
++=== Implementing Authorization in Subsequent Requests ===
--**Key **- Authorization
++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:
--**Value **- Bearer Token what is given in this response.
++* **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:
--**also note in headers that:**
++* **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.
--Content-Type - application/json
--
--**Key - **X-nugios-timezone
--
--**Value **- 240
++Incorporating these headers with their respective values is essential for the successful processing of your API requests.
  {{/error}}

Changes for page SearchTourPackages - Basic Version

Summary

Details

Applications

Navigation