xap-sdk/com.expediagroup.sdk.xap.operations/GetFlightListingsOperationParams

GetFlightListingsOperationParams

public final class GetFlightListingsOperationParams

Constructors

public GetFlightListingsOperationParams GetFlightListingsOperationParams(String partnerTransactionID, Integer adult, Integer senior, List<Integer> childrenAges, Integer infantInLap, Integer infantInSeat, String segment1Origin, String segment1Destination, LocalDate segment1DepartureDate, String segment1DepartureStartTime, String segment1DepartureEndTime, String segment2Origin, String segment2Destination, LocalDate segment2DepartureDate, String segment2DepartureStartTime, String segment2DepartureEndTime, String segment3Origin, String segment3Destination, LocalDate segment3DepartureDate, String segment3DepartureStartTime, String segment3DepartureEndTime, String segment4Origin, String segment4Destination, LocalDate segment4DepartureDate, String segment4DepartureStartTime, String segment4DepartureEndTime, String segment5Origin, String segment5Destination, LocalDate segment5DepartureDate, String segment5DepartureStartTime, String segment5DepartureEndTime, String segment6Origin, String segment6Destination, LocalDate segment6DepartureDate, String segment6DepartureStartTime, String segment6DepartureEndTime, String locale, GetFlightListingsOperationParams.CabinClass cabinClass, Integer numberOfStops, String sortType, Integer limit, List<String> selectedCarriers, List<String> accountCodes, Boolean agent, List<GetFlightListingsOperationParams.Links> links, Boolean refundable, Boolean filterNearByAirport, Boolean filterBasicEconomy, GetFlightListingsOperationParams.AnchorBy anchorBy, String selectedOffer, Boolean filterNonFlightOffers, Boolean enableSplitTicket)

Types

AnchorBy

public enum AnchorBy extends Enum<GetFlightListingsOperationParams.AnchorBy>

Builder

public final class Builder

CabinClass

public enum CabinClass extends Enum<GetFlightListingsOperationParams.CabinClass>

Links

public enum Links extends Enum<GetFlightListingsOperationParams.Links>

Properties

accountCodes

@Valid()

private final List<String> accountCodes

AlphaNumeric characters. Different codes separated by comma

adult

@Valid()

private final Integer adult

Number of Adult Travelers. Either one adult or one senior per itinerary is mandatory

agent

@Valid()

private final Boolean agent

Designates whether a telesales agent was involved in the transaction. true = telesales agent involved false = no telesales agent involved

anchorBy

private final GetFlightListingsOperationParams.AnchorBy anchorBy

Designates that the user is doing a Multi-step Search. Possible values are: segment1 | segment2 | segment3 | segment4 | segment5

cabinClass

private final GetFlightListingsOperationParams.CabinClass cabinClass

The desired cabin classes that the user would like to see offers for. Options can be: economy | first | business | premiumeconomy

childrenAges

@Valid()

private final List<Integer> childrenAges

Comma-separated list of the ages of all child travelers (ages 2 - 17).

enableSplitTicket

@Valid()

private final Boolean enableSplitTicket

if set to false, this parameter will filter out all the split ticket solutions from the Flight Offers. If set to true (by default it will be true), API response will include split ticket solutions if split ticket is enabled at key configuration level as well.

filterBasicEconomy

@Valid()

private final Boolean filterBasicEconomy

Filters out all the Basic Economy fare solutions in the flight search response. Note: default = false

filterNearByAirport

@Valid()

private final Boolean filterNearByAirport

Filters nearby airports ensuring only results from the requests airport code are returned. This request param is valid only for AirportCode-based searches. Note: default = false

filterNonFlightOffers

@Valid()

private final Boolean filterNonFlightOffers

If set to true, this parameter filters out all non-Flight Offers (offers with any of the legs comprising transit via Train, Bus or Boat) from flight search response. If the parameter is not present or is set to false, then Flight Offers may contain travel legs via means other than flight (Train, Bus or Boat). Default value is false

infantInLap

@Valid()

private final Integer infantInLap

Number of Infant travelers without a reserved seat. Age should be less than 2

infantInSeat

@Valid()

private final Integer infantInSeat

Number of Infant travelers with reserved seat. Age should be less than 2

limit

@Valid()

private final Integer limit

The maximum number of Flight offers returned in the response. Must be an integer value greater than 0.Note: default = 1600

links

private final List<GetFlightListingsOperationParams.Links> links

Comma-separated list that indicates which HATEOAS links should be included in the response. WD (Website Details Page - included by default) AD (Details API link) ABF (Baggage Fee API) ASM (Seat Map API) WPS (Web Package Search)

locale

@Valid()

private final String locale

Indicates the language and country with which the user would like to see any translated information.

numberOfStops

@Valid()

private final Integer numberOfStops

Filter for the number of stops the user would like to see offers for. A value of 0 returns only non-stop flights in the search response, and a value of 1 returns offers

partnerTransactionID

@NotNull()

@Valid()

private final String partnerTransactionID

Partner-generated identifier.

refundable

@Valid()

private final Boolean refundable

Refundable solutions will be returned if and only if we pass refundable as true in the request.(refundable=true). (Not Yet Supported in Production)

segment1DepartureDate

@NotNull()

@Valid()

private final LocalDate segment1DepartureDate

Date, in ISO format YYYY-MM-DD, on which customer wants to depart.

segment1DepartureEndTime

@Valid()

private final String segment1DepartureEndTime

Upper limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

segment1DepartureStartTime

@Valid()

private final String segment1DepartureStartTime

Lower limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

segment1Destination

@NotNull()

@Valid()

private final String segment1Destination

3-letter IATA Airport code/Location name from where the passenger is arriving.

segment1Origin

@NotNull()

@Valid()

private final String segment1Origin

3-letter IATA Airport code/Location name from where the passenger is departing.

segment2DepartureDate

@Valid()

private final LocalDate segment2DepartureDate

Date, in ISO format YYYY-MM-DD, on which customer wants to depart.

segment2DepartureEndTime

@Valid()

private final String segment2DepartureEndTime

Upper limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

segment2DepartureStartTime

@Valid()

private final String segment2DepartureStartTime

Lower limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

segment2Destination

@Valid()

private final String segment2Destination

3-letter IATA Airport code/Location name from where the passenger is arriving.

segment2Origin

@Valid()

private final String segment2Origin

3-letter IATA Airport code/Location name from where the passenger is departing.

segment3DepartureDate

@Valid()

private final LocalDate segment3DepartureDate

Date, in ISO format YYYY-MM-DD, on which customer wants to depart.

segment3DepartureEndTime

@Valid()

private final String segment3DepartureEndTime

Upper limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

segment3DepartureStartTime

@Valid()

private final String segment3DepartureStartTime

Lower limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

segment3Destination

@Valid()

private final String segment3Destination

3-letter IATA Airport code/Location name from where the passenger is arriving.

segment3Origin

@Valid()

private final String segment3Origin

3-letter IATA Airport code/Location name from where the passenger is departing.

segment4DepartureDate

@Valid()

private final LocalDate segment4DepartureDate

Date, in ISO format YYYY-MM-DD, on which customer wants to depart.

segment4DepartureEndTime

@Valid()

private final String segment4DepartureEndTime

Upper limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

segment4DepartureStartTime

@Valid()

private final String segment4DepartureStartTime

Lower limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

segment4Destination

@Valid()

private final String segment4Destination

3-letter IATA Airport code/Location name from where the passenger is arriving.

segment4Origin

@Valid()

private final String segment4Origin

3-letter IATA Airport code/Location name from where the passenger is departing.

segment5DepartureDate

@Valid()

private final LocalDate segment5DepartureDate

Date, in ISO format YYYY-MM-DD, on which customer wants to depart.

segment5DepartureEndTime

@Valid()

private final String segment5DepartureEndTime

Upper limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

segment5DepartureStartTime

@Valid()

private final String segment5DepartureStartTime

Lower limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

segment5Destination

@Valid()

private final String segment5Destination

3-letter IATA Airport code/Location name from where the passenger is arriving.

segment5Origin

@Valid()

private final String segment5Origin

3-letter IATA Airport code/Location name from where the passenger is departing.

segment6DepartureDate

@Valid()

private final LocalDate segment6DepartureDate

Date, in ISO format YYYY-MM-DD, on which customer wants to depart.

segment6DepartureEndTime

@Valid()

private final String segment6DepartureEndTime

Upper limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

segment6DepartureStartTime

@Valid()

private final String segment6DepartureStartTime

Lower limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

segment6Destination

@Valid()

private final String segment6Destination

3-letter IATA Airport code/Location name from where the passenger is arriving.

segment6Origin

@Valid()

private final String segment6Origin

3-letter IATA Airport code/Location name from where the passenger is departing.

selectedCarriers

@Valid()

private final List<String> selectedCarriers

Adding comma-separated list of IATA or Expedia airline codes will limit the search results to include flight offers only with the selected carriers.

selectedOffer

@Valid()

private final String selectedOffer

Captures the previously selected flight segments during a Multi-step Search.

senior

@Valid()

private final Integer senior

Number of Senior (age 65) Travelers

sortType

@Valid()

private final String sortType

Sort the search results according to one selected category. Only sort by price is supported at this time. Note: default = Price

Functions

builder

public final static GetFlightListingsOperationParams.Builder builder()

getAccountCodes

public final List<String> getAccountCodes()

AlphaNumeric characters. Different codes separated by comma

getAdult

public final Integer getAdult()

Number of Adult Travelers. Either one adult or one senior per itinerary is mandatory

getAgent

public final Boolean getAgent()

Designates whether a telesales agent was involved in the transaction. true = telesales agent involved false = no telesales agent involved

getAnchorBy

public final GetFlightListingsOperationParams.AnchorBy getAnchorBy()

Designates that the user is doing a Multi-step Search. Possible values are: segment1 | segment2 | segment3 | segment4 | segment5

getCabinClass

public final GetFlightListingsOperationParams.CabinClass getCabinClass()

The desired cabin classes that the user would like to see offers for. Options can be: economy | first | business | premiumeconomy

getChildrenAges

public final List<Integer> getChildrenAges()

Comma-separated list of the ages of all child travelers (ages 2 - 17).

getEnableSplitTicket

public final Boolean getEnableSplitTicket()

getFilterBasicEconomy

public final Boolean getFilterBasicEconomy()

Filters out all the Basic Economy fare solutions in the flight search response. Note: default = false

getFilterNearByAirport

public final Boolean getFilterNearByAirport()

Filters nearby airports ensuring only results from the requests airport code are returned. This request param is valid only for AirportCode-based searches. Note: default = false

getFilterNonFlightOffers

public final Boolean getFilterNonFlightOffers()

getHeaders

public Headers getHeaders()

getInfantInLap

public final Integer getInfantInLap()

Number of Infant travelers without a reserved seat. Age should be less than 2

getInfantInSeat

public final Integer getInfantInSeat()

Number of Infant travelers with reserved seat. Age should be less than 2

getLimit

public final Integer getLimit()

The maximum number of Flight offers returned in the response. Must be an integer value greater than 0.Note: default = 1600

getLinks

public final List<GetFlightListingsOperationParams.Links> getLinks()

getLocale

public final String getLocale()

Indicates the language and country with which the user would like to see any translated information.

getNumberOfStops

public final Integer getNumberOfStops()

Filter for the number of stops the user would like to see offers for. A value of 0 returns only non-stop flights in the search response, and a value of 1 returns offers

getPartnerTransactionID

public final String getPartnerTransactionID()

Partner-generated identifier.

getPathParams

public Map<String, String> getPathParams()

getQueryParams

public Parameters getQueryParams()

getRefundable

public final Boolean getRefundable()

Refundable solutions will be returned if and only if we pass refundable as true in the request.(refundable=true). (Not Yet Supported in Production)

getSegment1DepartureDate

public final LocalDate getSegment1DepartureDate()

Date, in ISO format YYYY-MM-DD, on which customer wants to depart.

getSegment1DepartureEndTime

public final String getSegment1DepartureEndTime()

Upper limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

getSegment1DepartureStartTime

public final String getSegment1DepartureStartTime()

Lower limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

getSegment1Destination

public final String getSegment1Destination()

3-letter IATA Airport code/Location name from where the passenger is arriving.

getSegment1Origin

public final String getSegment1Origin()

3-letter IATA Airport code/Location name from where the passenger is departing.

getSegment2DepartureDate

public final LocalDate getSegment2DepartureDate()

Date, in ISO format YYYY-MM-DD, on which customer wants to depart.

getSegment2DepartureEndTime

public final String getSegment2DepartureEndTime()

Upper limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

getSegment2DepartureStartTime

public final String getSegment2DepartureStartTime()

Lower limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

getSegment2Destination

public final String getSegment2Destination()

3-letter IATA Airport code/Location name from where the passenger is arriving.

getSegment2Origin

public final String getSegment2Origin()

3-letter IATA Airport code/Location name from where the passenger is departing.

getSegment3DepartureDate

public final LocalDate getSegment3DepartureDate()

Date, in ISO format YYYY-MM-DD, on which customer wants to depart.

getSegment3DepartureEndTime

public final String getSegment3DepartureEndTime()

Upper limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

getSegment3DepartureStartTime

public final String getSegment3DepartureStartTime()

Lower limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

getSegment3Destination

public final String getSegment3Destination()

3-letter IATA Airport code/Location name from where the passenger is arriving.

getSegment3Origin

public final String getSegment3Origin()

3-letter IATA Airport code/Location name from where the passenger is departing.

getSegment4DepartureDate

public final LocalDate getSegment4DepartureDate()

Date, in ISO format YYYY-MM-DD, on which customer wants to depart.

getSegment4DepartureEndTime

public final String getSegment4DepartureEndTime()

Upper limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

getSegment4DepartureStartTime

public final String getSegment4DepartureStartTime()

Lower limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

getSegment4Destination

public final String getSegment4Destination()

3-letter IATA Airport code/Location name from where the passenger is arriving.

getSegment4Origin

public final String getSegment4Origin()

3-letter IATA Airport code/Location name from where the passenger is departing.

getSegment5DepartureDate

public final LocalDate getSegment5DepartureDate()

Date, in ISO format YYYY-MM-DD, on which customer wants to depart.

getSegment5DepartureEndTime

public final String getSegment5DepartureEndTime()

Upper limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

getSegment5DepartureStartTime

public final String getSegment5DepartureStartTime()

Lower limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

getSegment5Destination

public final String getSegment5Destination()

3-letter IATA Airport code/Location name from where the passenger is arriving.

getSegment5Origin

public final String getSegment5Origin()

3-letter IATA Airport code/Location name from where the passenger is departing.

getSegment6DepartureDate

public final LocalDate getSegment6DepartureDate()

Date, in ISO format YYYY-MM-DD, on which customer wants to depart.

getSegment6DepartureEndTime

public final String getSegment6DepartureEndTime()

Upper limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

getSegment6DepartureStartTime

public final String getSegment6DepartureStartTime()

Lower limit of desired departure time window, expressed in the local time of the departure location, in standard ISO format.

getSegment6Destination

public final String getSegment6Destination()

3-letter IATA Airport code/Location name from where the passenger is arriving.

getSegment6Origin

public final String getSegment6Origin()

3-letter IATA Airport code/Location name from where the passenger is departing.

getSelectedCarriers

public final List<String> getSelectedCarriers()

Adding comma-separated list of IATA or Expedia airline codes will limit the search results to include flight offers only with the selected carriers.

getSelectedOffer

public final String getSelectedOffer()

Captures the previously selected flight segments during a Multi-step Search.

getSenior

public final Integer getSenior()

Number of Senior (age 65) Travelers

getSortType

public final String getSortType()

Sort the search results according to one selected category. Only sort by price is supported at this time. Note: default = Price

toBuilder

public final GetFlightListingsOperationParams.Builder toBuilder()