POST api/OnSaleThemed/Origins

Returns the list of valid MarketShortWithTally

Request Information

URI Parameters

None.

Body Parameters

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

OnSaleOriginsRequest
NameDescriptionTypeAdditional information
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:
{
  "TravelDateHigh": "2024-11-21T03:58:43.714301-06:00",
  "TravelDateLow": "2024-11-21T03:58:43.714301-06:00",
  "DealTypes": [
    1,
    2
  ],
  "SaleTypeFilter": {
    "IncludeNormalDeals": true,
    "IncludeLastMinuteDeals": true,
    "IncludeExclusiveDeals": true
  },
  "Vendors": [
    "sample string 1",
    "sample string 2"
  ]
}

text/xml

Sample:
<OnSaleOriginsRequest 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>
  <SaleTypeFilter>
    <IncludeExclusiveDeals>true</IncludeExclusiveDeals>
    <IncludeLastMinuteDeals>true</IncludeLastMinuteDeals>
    <IncludeNormalDeals>true</IncludeNormalDeals>
  </SaleTypeFilter>
  <TravelDateHigh>2024-11-21T03:58:43.714301-06:00</TravelDateHigh>
  <TravelDateLow>2024-11-21T03:58:43.714301-06: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>
</OnSaleOriginsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OnSaleOriginsResponse

OnSaleOriginsResponse
NameDescriptionTypeAdditional information
Origins

Collection of MarketShortWithTally

None.

Timing

Timings

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

text/xml

Sample:

Sample not available.