Changes for page 1. SearchTourPackages

Summary

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

Details

Page properties

Content

...	...	@@ -760,7 +760,7 @@
760	760
761	761	== Definitions ==
762	762
763		-Request Parameters
	763	+**Request Parameters **
764	764
765	765	(% class="table-bordered" %)
766	766	|=Field|=Type|=Description
...	...	@@ -795,17 +795,80 @@
795	795	|pageNumber|integer|The page number for paginated results.
796	796	|pageRowCount|integer|The number of rows per page for paginated results.
797	797
798		-
799	799	(% class="wikigeneratedid" %)
800		-Request Parameters
	799	+**Response Parameters**
801	801
	801	+(% class="table-bordered" %)
	802	+|=Field|=Type|=Description
	803	+|packages|array|An array of packages available. Each package contains:
	804	+|cacheKey|string|A unique identifier for the cache.
	805	+|id|string|A unique identifier for the package.
	806	+|priceCurrency|string|The currency in which the price is displayed.
	807	+|totalPrice|float|The total price of the package.
	808	+|agentCommissionPercent|float|The commission percentage for the agent.
	809	+|agentCommissionAmount|float|The commission amount for the agent.
	810	+|includedExtrasAmount|integer|The amount of extras included in the package.
	811	+|priceDifference|integer|The difference in price from the original price.
	812	+|hotel|object|An object containing details about the hotel.
	813	+|hotelPriceId|string|A unique identifier for the hotel price.
	814	+|providerId|integer|A unique identifier for the provider.
	815	+|hotelName|string|The name of the hotel.
	816	+|hotelCode|string|A unique code for the hotel.
	817	+|nigths|integer|The number of nights for the stay.
	818	+|mealPlan|string|The meal plan for the stay.
	819	+|hotelClass|string|The class or rating of the hotel.
	820	+|availabilityType|string|The availability type of the hotel.
	821	+|availableRoomsCount|integer|The number of available rooms in the hotel.
	822	+|fewRooms|boolean|Indicates whether there are few rooms left.
	823	+|roomCategoryCode|string|A unique code for the room category.
	824	+|roomCategoryName|string|The name of the room category.
	825	+|placementTypeName|string|The name of the placement type.
	826	+|checkInDate|string|The check-in date in ISO 8601 format.
	827	+|checkOutDate|string|The check-out date in ISO 8601 format.
	828	+|adults|integer|The number of adults for the stay.
	829	+|children|integer|The number of children for the stay.
	830	+|districtUID|string|A unique identifier for the district.
	831	+|districtName|string|The name of the district.
	832	+|cityUID|string|A unique identifier for the city.
	833	+|cityName|string|The name of the city.
	834	+|countryCode|string|The ISO 3166-1 alpha-2 country code.
	835	+|countryName|string|The name of the country.
	836	+|hasAlcohol|boolean|Indicates whether the hotel serves alcohol.
	837	+|hasFreeWifi|boolean|Indicates whether the hotel offers free Wi-Fi.
	838	+|hasMetro|boolean|Indicates whether the hotel is near a metro station.
	839	+|hasPool|boolean|Indicates whether the hotel has a pool.
	840	+|hasMall|boolean|Indicates whether the hotel is near a shopping mall.
	841	+|cancellationPolicyDescription|string|The description of the cancellation policy.
	842	+|cancellationPolicy|object|An object containing details about the cancellation policy.
	843	+|flight|object|An object containing details about the flight.
	844	+|id|string|A unique identifier for the flight.
	845	+|departureDate|string|The departure date in ISO 8601 format.
	846	+|returnDate|string|The return date in ISO 8601 format.
	847	+|departureTicketsLeft|integer|The number of departure tickets left.
	848	+|returnTicketsLeft|integer|The number of return tickets left.
	849	+|departureAvailabilityType|string|The availability type of the departure flight.
	850	+|returnAvailabilityType|string|The availability type of the return flight.
	851	+|isTwoWay|boolean|Indicates whether the flight is two-way.
	852	+|sameBaggageForAll|boolean|Indicates whether the same baggage is applicable for all passengers.
	853	+|totalBaggage|boolean|Indicates whether total baggage is included.
	854	+|departureSegments|array|An array of objects, each representing a departure segment.
	855	+|returnSegments|array|An array of objects, each representing a return segment.
	856	+|passengers|array|An array of objects, each representing a passenger.
	857	+|extraServices|array|An array of extra services included in the package.
	858	+|insurancePrice|object|An object containing details about the insurance price.
	859	+|pagingId|string|The paging ID for paginated results.
	860	+|pageNumber|integer|The page number for paginated results.
	861	+|pageCount|integer|The total number of pages.
	862	+|totalCount|integer|The total count of packages.
	863	+|error|boolean|Indicates whether there was an error.
802	802
	865	+
803	803	=== Paging and Caching ===
804	804
805	805	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:
806	806
807	807
808		-==== first request ====
	871	+==== First request ====
809	809
810	810	{{code language="Json"}}
811	811	{
...	...	@@ -815,10 +815,12 @@
815	815	}
816	816	{{/code}}
817	817
	881	+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.
818	818
	883	+
819	819	==== Request with caching ====
820	820
821		-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
	886	+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": "",
822	822
823	823	{{code language="Json"}}
824	824	{
...	...	@@ -829,7 +829,7 @@
829	829	{{/code}}
830	830
831	831
832		-=== search parameter options ===
	897	+=== Search parameter options ===
833	833
834	834	in the request body it's available to filter search results with parameters. parameter examples:
835	835
...	...	@@ -871,18 +871,18 @@
871	871	== Important ==
872	872
873	873	{{error}}
874		-It's Important to in every other request header, put Auth token
	939	+=== Implementing Authorization in Subsequent Requests ===
875	875
876		-**Key **- Authorization
	941	+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:
877	877
878		-**Value **- Bearer Token what is given in this response.
	943	+* **Header Key:** Authorization
	944	+* **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.
879	879
	946	+Additionally, to ensure your requests are properly formatted and recognized, include the following headers:
880	880
881		-**also note in headers that:**
	948	+* **Content-Type:** Specify this header as application/json to indicate the format of the request body.
	949	+* **Header Key:** X-nugios-timezone
	950	+* **Header Value:** 240 - Adjust this value to match your local timezone offset in minutes.
882	882
883		-Content-Type - application/json
884		-
885		-**Key - **X-nugios-timezone
886		-
887		-**Value **- 240
	952	+Incorporating these headers with their respective values is essential for the successful processing of your API requests.
888	888	{{/error}}