POST api/OnSaleThemed/Destinations

Returns a list of RegionWithTally

Request Information

URI Parameters

None.

Body Parameters

OnSaleDestinationsRequest contains origin, list of vendors, travel date range, deal types, and Normal/Spotlight/Exclusive filter.

OnSaleDestinationsRequest
NameDescriptionTypeAdditional information
Origin

Three character Origin market code.

string

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.

Vendors

List of the 3 character code Vendor codes to get OnSale data.

Collection of string

Required

Request Formats

application/json, text/json

Sample:
{
  "Origin": "sample string 1",
  "TravelDateHigh": "2024-07-01T00:08:51.8010619-05:00",
  "TravelDateLow": "2024-07-01T00:08:51.8010619-05:00",
  "DealTypes": [
    1,
    2
  ],
  "SaleTypeFilter": {
    "IncludeNormalDeals": true,
    "IncludeLastMinuteDeals": true,
    "IncludeExclusiveDeals": true
  },
  "Vendors": [
    "sample string 1",
    "sample string 2"
  ]
}

text/xml

Sample:
<OnSaleDestinationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Trisept.UI.WebApi.VAXAgentApi.Models">
  <DealTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>1</d2p1:short>
    <d2p1:short>2</d2p1:short>
  </DealTypes>
  <Origin>sample string 1</Origin>
  <SaleTypeFilter>
    <IncludeExclusiveDeals>true</IncludeExclusiveDeals>
    <IncludeLastMinuteDeals>true</IncludeLastMinuteDeals>
    <IncludeNormalDeals>true</IncludeNormalDeals>
  </SaleTypeFilter>
  <TravelDateHigh>2024-07-01T00:08:51.8010619-05:00</TravelDateHigh>
  <TravelDateLow>2024-07-01T00:08:51.8010619-05:00</TravelDateLow>
  <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>
</OnSaleDestinationsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OnSaleRegionsAndDestinationsResponse

OnSaleRegionsAndDestinationsResponse
NameDescriptionTypeAdditional information
Regions

Collection of RegionWithTally

None.

Timing

Timings

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

text/xml

Sample:

Sample not available.