Skip to main content

Enums

Below is a list of all the enums in use by the API.

Common​

These enums are used between multiple endpoints. For example, the values of the ResultStatus enum can be found in both Flights Live and Flights Indicative Pricing endpoints.

SearchAction​

Enum Value
SEARCH_ACTION_UNSPECIFIED
SEARCH_ACTION_CREATE
SEARCH_ACTION_POLL

ResultStatus​

Enum ValueDescription
RESULT_STATUS_UNSPECIFIEDResults status not specified.
RESULT_STATUS_COMPLETEResults are now complete.
RESULT_STATUS_INCOMPLETEResults are not complete yet.
RESULT_STATUS_FAILEDSearch has failed.

ResultAction​

Enum ValueDescription
RESULT_ACTION_UNSPECIFIEDResult action is not specified.
RESULT_ACTION_REPLACEDResult action is to replace, as the results have been changed.
RESULT_ACTION_NOT_MODIFIEDResult action is not to modify, as no changes have occurred.
RESULT_ACTION_OMITTEDResults for this vertical have been omitted.

InventoryType​

Values corresponding to the different inventory types supported by the API. Please note that some inventory types such as Stays (HOTELS_*) may not yet be available.

Enum Value
INVENTORY_TYPE_UNSPECIFIED
FLIGHTS_LIVE_PRICING
FLIGHTS_INDICATIVE_PRICING
HOTELS_LIVE_PRICING
HOTELS_INDICATIVE_PRICING
CULTURE_DATA
GEO_DATA
CARRIERS_DATA
CAR_HIRE_LIVE_PRICING
CAR_HIRE_INDICATIVE_PRICING
CAR_HIRE_LIVE_PRICING_CREATE
CAR_HIRE_LIVE_PRICING_POLL
CAR_HIRE_AGENTS

PlaceType​

Enum Value
PLACE_TYPE_UNSPECIFIED
PLACE_TYPE_AIRPORT
PLACE_TYPE_CITY
PLACE_TYPE_COUNTRY
PLACE_TYPE_CONTINENT

PriceUnit​

Enum ValueDescription
PRICE_UNIT_UNSPECIFIEDUnit is not specified.
PRICE_UNIT_WHOLEUnit relation: 1. eg: A whole pound, euro, etc.
PRICE_UNIT_CENTIUnit relation: 100; eg: cents.
PRICE_UNIT_MILLIUnit relation: 1000
PRICE_UNIT_MICROUnit relation: 1000000

Flights Live Prices​

These enums are used only by the create and poll Flights Live Prices endpoints

CabinClass​

info

CABIN_CLASS_UNSPECIFIED represents an internal status and must not be included in requests, as it will result in an error. In cases where a cabin class is not specified within a request, the API will automatically default to CABIN_CLASS_ECONOMY.

Used in the Flights Live endpoint to specify class. E.g.: economy, business, first.

Enum ValueDescription
CABIN_CLASS_UNSPECIFIEDCabin class is not specified.
CABIN_CLASS_ECONOMYCabin class is economy.
CABIN_CLASS_PREMIUM_ECONOMYCabin class is premium economy.
CABIN_CLASS_BUSINESSCabin class is business.
CABIN_CLASS_FIRSTCabin class is first class.

AgentType​

Enum ValueDescription
AGENT_TYPE_UNSPECIFIEDUnspecified agent type.
AGENT_TYPE_TRAVEL_AGENTAgent is a travel agent.
AGENT_TYPE_AIRLINEAgent is a airline.

TransferType​

The type of transfer when there are multiple segments on an itinerary (more than one flight to get from the a destination). More details here.

Enum ValueDescription
TRANSFER_TYPE_UNSPECIFIEDThe transfer type is not specified.
TRANSFER_TYPE_MANAGEDA protected transfer, managed by the agent. If a flights is delayed and the travellers miss their connection, the agent will find alternatives an no extra cost.
TRANSFER_TYPE_SELF_TRANSFERA non-protected transfer. The travellers will have multiple booking references. If a flights is delayed and the travellers miss their connection they will have to buy a whole new ticket.
TRANSFER_TYPE_PROTECTED_SELF_TRANSFERSelf transfer flights that are protected by the online travel agent rather than the airline. If a flights is delayed and the travellers miss their connection they can contact the travel agent to help with the rebooking.

Flights Indicative Prices​

These enums are used only by the Flights Indicative Prices search endpoint

DateTimeGroupingType (Indicative Pricing Endpoint)​

Enum ValueDescription
DATE_TIME_GROUPING_TYPE_UNSPECIFIEDThe date grouping is not specified (use the default).
DATE_TIME_GROUPING_TYPE_BY_DATEGroup the quotes by day.
DATE_TIME_GROUPING_TYPE_BY_MONTHGroup the quotes by month.

Autosuggest​

PlaceType​

In addition to the PlaceType enum above, the Autosuggest endpoints have additional specific PlaceType enums.

Enum Value
PLACE_TYPE_HOTEL
PLACE_TYPE_DISTRICT
PLACE_TYPE_ISLAND
PLACE_TYPE_FIRST_LEVEL_NATION_ADMINISTRATIVE_DIVISION
PLACE_TYPE_SECOND_LEVEL_NATION_ADMINISTRATIVE_DIVISION
PLACE_TYPE_SEA_COAST
PLACE_TYPE_MOUNTAIN_RANGE
PLACE_TYPE_SEA
PLACE_TYPE_TRAIN_STATION

Car Hire (Common)​

Transmission​

Enum ValueDescription
TRANSMISSION_UNSPECIFIEDTransmission is not specified or unknown.
TRANSMISSION_MANUALVehicle transmission is manual.
TRANSMISSION_AUTOMATICVehicle transmission is automatic.

Fuel type​

Enum ValueDescription
FUEL_TYPE_UNSPECIFIEDIndicates the fuel type mapping from the supplier's quote wasn't possible or is unknown.
FUEL_TYPE_HYBRIDThe fuel type is hybrid.
FUEL_TYPE_ELECTRICThe fuel type is electric.
FUEL_TYPE_OTHERThe fuel type is none of the other possible values.

Car Hire Live Prices​

Pickup method​

Enum ValueDescription
PICKUP_METHOD_UNSPECIFIEDIndicates the pick-up method mapping from the supplier's quote wasn't possible.
PICKUP_METHOD_KEYLESSKeyless pickup method.
PICKUP_METHOD_KEY_AND_GOKey and go pickup method.
PICKUP_METHOD_NORMALNormal pickup method.

Pickup type​

Enum ValueDescription
PICKUP_TYPE_UNSPECIFIEDIndicates the pick-up method mapping from the supplier's quote wasn't possible.
PICKUP_TYPE_DESK_IN_TERMINALThe pick-up is at desk in terminal.
PICKUP_TYPE_MEET_AND_GREETThe pick-up is by meet and greet method.
PICKUP_TYPE_SHUTTLEThe pick-up is by shuttle.

Fuel policy​

Enum ValueDescription
FUEL_POLICY_UNSPECIFIEDIndicates the fuel policy mapping from the supplier's quote wasn't possible or is unknown.
FUEL_POLICY_FULL_TO_FULLFuel policy is full to full.
FUEL_POLICY_FULL_TO_EMPTYFuel policy is full to empty.
FUEL_POLICY_SAME_TO_SAMEFuel policy is same to same.
FUEL_POLICY_HALF_TO_HALFFuel policy is half to half.
FUEL_POLICY_HALF_TO_EMPTYFuel policy is half to empty.
FUEL_POLICY_QUARTER_TO_QUARTERFuel policy is quarter to quarter.
FUEL_POLICY_QUARTER_TO_EMPTYFuel policy is quarter to empty.
FUEL_POLICY_EMPTY_TO_EMPTYFuel policy is empty to empty.
FUEL_POLICY_FREE_FULL_TANKFuel policy is free full tank.

Pay type​

Enum ValueDescription
PAY_TYPE_UNSPECIFIEDIndicates the values is unspecified or unknown.
PAY_TYPE_ARRIVAL_PAYPay at the counter, popular in US.
PAY_TYPE_MIX_PAYOTA charges upfront, travellers pays the rest at counter.
PAY_TYPE_PRE_PAYTraveller pays full rental rate to the broker.

Car Hire Indicative Prices​

Date time grouping type​

Enum ValueDescription
DATE_TIME_GROUPING_TYPE_UNSPECIFIEDThe date grouping is not specified.
DATE_TIME_GROUPING_TYPE_BY_DATEGroup the quotes by day.
DATE_TIME_GROUPING_TYPE_BY_MONTHGroup the quotes by month.
DATE_TIME_GROUPING_TYPE_BY_WEEKGroup the quotes by week.

Aggregate type​

Enum ValueDescription
AGGREGATE_TYPE_UNSPECIFIEDDefault value for aggregate type. Should never be returned.
AGGREGATE_TYPE_CHEAPESTAggregate type is cheapest per day.
AGGREGATE_TYPE_AVERAGEAggregate type is average per day.
AGGREGATE_TYPE_TOTAL_CHEAPESTAggregate type is cheapest price in total.
AGGREGATE_TYPE_TOTAL_AVERAGEAggregate type is total average price in total.
AGGREGATE_TYPE_COUNTRY_AVERAGEAggregate type is price per day of the country where the location is located in.

Vehicle type​

info

For the below descriptions to make more sense please check https://www.acriss.org/car-codes/

Enum ValueDescription
VEHICLE_TYPE_UNSPECIFIEDDefault value of car type. This is an unexpected value and it shouldn't be returned as part of the response ever.
VEHICLE_TYPE_SMALLVehicle size is one of: - (M) Mini - (N) Mini Elite - (E) Economy - (H) Economy Elite.
VEHICLE_TYPE_MEDIUMVehicle size is one of: - (C) Compact - (D) Compact Elite - (I) Intermediate - (J) Intermediate Elite - (S) Standard - (R) Standard Elite.
VEHICLE_TYPE_LARGEVehicle size is one of: - (F) Fullsize - (G) Fullsize Elite.
VEHICLE_TYPE_LUXURYVehicle size is one of: - (P) Premium - (U) Premium Elite - (L) Luxury - (W) Luxury Elite - (O) Oversize - (X) Special.
VEHICLE_TYPE_SUVNumber of doors for vehicle is (F) SUV.
VEHICLE_TYPE_VANNumber of doors for vehicle is (K) Commercial Van/ Truck.