POST api/OnSaleThemed/ThemedPage

Returns a page of OnSale items filtered by the OnSaleThemedRequest

Request Information

URI Parameters

None.

Body Parameters

OnSaleThemedRequest

Name	Description	Type	Additional information
Vendors	List of the 3 character code Vendor codes to get OnSale data.	Collection of string	Required
Destinations	List of three character code destination markets or numerical region codes.	Collection of string	None.
HotelRating	List of integer hotel ratings to include. The valid choices comes from the /Choices route.	Collection of integer	None.
TripAdvisorRatings	List of integer TripAdvisor ratings to include. The valid choices comes from the /Choices route. These values are 0-10 for 0, .5, 1.0, 1.5, etc.	Collection of integer	None.
NumberOfNights	List of integer number of nights to include. The valid choices comes from the /Choices route.	Collection of integer	None.
Origin	Three character Origin market code.	string	None.
PageNumber	Integer page number starting with 1	integer	None.
PageSize	PageSize is the quantity of OnSale items to be returned in each paging call.	integer	None.
PriceRanges	List of the OnSalePriceRanges to include or exclude in the paging call.	Collection of OnSalePriceRange	None.
SortDirection	Indicates to sort Ascending or Descending	SortDirection	None.
SortType	Integer value for the sort. The valid choices comes from the /Choices route.	integer	None.
Themes	List of integer themes to include. The valid choices comes from the /Choices route.	Collection of integer	None.
TravelDateHigh	TravelDate High limit.	date	None.
TravelDateLow	TravelDate Low limit.	date	None.
DealTypes	List of DealTypes. These values come from the Choices, for example 1="Hotel Only", 2="Hotel + Flight".	Collection of integer	None.
SaleTypeFilter	Indication of types of deals to include: normal, last-minute, and/or exclusive.	OnSaleTypeFilter	None.
HotelCodes	List of Hotel codes that should be included in the response.	Collection of string	None.
BypassOfferMerchandiser	Flag to bypass OfferMerchandiser. This shows the "definition" of the OnSale item's DepartureDate. You will see the actual 777777.77 or 99999 values that are the indicators for OfferMerchandiser to get the cached prices from CacheMasterReader.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Vendors": [
    "sample string 1",
    "sample string 2"
  ],
  "Destinations": [
    "sample string 1",
    "sample string 2"
  ],
  "HotelRating": [
    1,
    2
  ],
  "TripAdvisorRatings": [
    1,
    2
  ],
  "NumberOfNights": [
    1,
    2
  ],
  "Origin": "sample string 1",
  "PageNumber": 2,
  "PageSize": 3,
  "PriceRanges": [
    {
      "PriceHigh": 1.1,
      "PriceLow": 2.1,
      "Selected": true
    },
    {
      "PriceHigh": 1.1,
      "PriceLow": 2.1,
      "Selected": true
    }
  ],
  "SortDirection": 0,
  "SortType": 4,
  "Themes": [
    1,
    2
  ],
  "TravelDateHigh": "2024-12-03T02:05:18.0771299-06:00",
  "TravelDateLow": "2024-12-03T02:05:18.0771299-06:00",
  "DealTypes": [
    1,
    2
  ],
  "SaleTypeFilter": {
    "IncludeNormalDeals": true,
    "IncludeLastMinuteDeals": true,
    "IncludeExclusiveDeals": true
  },
  "HotelCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "BypassOfferMerchandiser": true
}

text/xml

Sample:

<OnSaleThemedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Trisept.UI.WebApi.VAXAgentApi.Models">
  <BypassOfferMerchandiser>true</BypassOfferMerchandiser>
  <DealTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>1</d2p1:short>
    <d2p1:short>2</d2p1:short>
  </DealTypes>
  <Destinations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Destinations>
  <HotelCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </HotelCodes>
  <HotelRating xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </HotelRating>
  <NumberOfNights xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </NumberOfNights>
  <Origin>sample string 1</Origin>
  <PageNumber>2</PageNumber>
  <PageSize>3</PageSize>
  <PriceRanges>
    <OnSalePriceRange>
      <PriceHigh>1.1</PriceHigh>
      <PriceLow>2.1</PriceLow>
      <Selected>true</Selected>
    </OnSalePriceRange>
    <OnSalePriceRange>
      <PriceHigh>1.1</PriceHigh>
      <PriceLow>2.1</PriceLow>
      <Selected>true</Selected>
    </OnSalePriceRange>
  </PriceRanges>
  <SaleTypeFilter>
    <IncludeExclusiveDeals>true</IncludeExclusiveDeals>
    <IncludeLastMinuteDeals>true</IncludeLastMinuteDeals>
    <IncludeNormalDeals>true</IncludeNormalDeals>
  </SaleTypeFilter>
  <SortDirection>Ascending</SortDirection>
  <SortType>4</SortType>
  <Themes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Themes>
  <TravelDateHigh>2024-12-03T02:05:18.0771299-06:00</TravelDateHigh>
  <TravelDateLow>2024-12-03T02:05:18.0771299-06:00</TravelDateLow>
  <TripAdvisorRatings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TripAdvisorRatings>
  <Vendors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Vendors>
</OnSaleThemedRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OnSaleThemedResponse

Name	Type	Additional information
Groups	Collection of OnSaleGroup	None.
Items	Collection of OnSaleItem	None.
Summary	OnSaleThemedResponseSummary	None.
Timing	Timings	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

text/xml

Sample:

Sample not available.