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 Value | Description |
---|---|
RESULT_STATUS_UNSPECIFIED | Results status not specified. |
RESULT_STATUS_COMPLETE | Results are now complete. |
RESULT_STATUS_INCOMPLETE | Results are not complete yet. |
RESULT_STATUS_FAILED | Search has failed. |
ResultAction
Enum Value | Description |
---|---|
RESULT_ACTION_UNSPECIFIED | Result action is not specified. |
RESULT_ACTION_REPLACED | Result action is to replace, as the results have been changed. |
RESULT_ACTION_NOT_MODIFIED | Result action is not to modify, as no changes have occurred. |
RESULT_ACTION_OMITTED | Results 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 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 Value | Description |
---|---|
PRICE_UNIT_UNSPECIFIED | Unit is not specified. |
PRICE_UNIT_WHOLE | Unit relation: 1. eg: A whole pound, euro, etc. |
PRICE_UNIT_CENTI | Unit relation: 100; eg: cents. |
PRICE_UNIT_MILLI | Unit relation: 1000 |
PRICE_UNIT_MICRO | Unit relation: 1000000 |
Flights Live Prices
These enums are used only by the create
and poll
Flights Live Prices endpoints
CabinClass
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 Value | Description |
---|---|
CABIN_CLASS_UNSPECIFIED | Cabin class is not specified. |
CABIN_CLASS_ECONOMY | Cabin class is economy. |
CABIN_CLASS_PREMIUM_ECONOMY | Cabin class is premium economy. |
CABIN_CLASS_BUSINESS | Cabin class is business. |
CABIN_CLASS_FIRST | Cabin class is first class. |
AgentType
Enum Value | Description |
---|---|
AGENT_TYPE_UNSPECIFIED | Unspecified agent type. |
AGENT_TYPE_TRAVEL_AGENT | Agent is a travel agent. |
AGENT_TYPE_AIRLINE | Agent 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 Value | Description |
---|---|
TRANSFER_TYPE_UNSPECIFIED | The transfer type is not specified. |
TRANSFER_TYPE_MANAGED | A 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_TRANSFER | A 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_TRANSFER | Self 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 Value | Description |
---|---|
DATE_TIME_GROUPING_TYPE_UNSPECIFIED | The date grouping is not specified (use the default). |
DATE_TIME_GROUPING_TYPE_BY_DATE | Group the quotes by day. |
DATE_TIME_GROUPING_TYPE_BY_MONTH | Group 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 Value | Description |
---|---|
TRANSMISSION_UNSPECIFIED | Transmission is not specified or unknown. |
TRANSMISSION_MANUAL | Vehicle transmission is manual. |
TRANSMISSION_AUTOMATIC | Vehicle transmission is automatic. |
Fuel type
Enum Value | Description |
---|---|
FUEL_TYPE_UNSPECIFIED | Indicates the fuel type mapping from the supplier's quote wasn't possible or is unknown. |
FUEL_TYPE_HYBRID | The fuel type is hybrid. |
FUEL_TYPE_ELECTRIC | The fuel type is electric. |
FUEL_TYPE_OTHER | The fuel type is none of the other possible values. |
Car Hire Live Prices
Pickup method
Enum Value | Description |
---|---|
PICKUP_METHOD_UNSPECIFIED | Indicates the pick-up method mapping from the supplier's quote wasn't possible. |
PICKUP_METHOD_KEYLESS | Keyless pickup method. |
PICKUP_METHOD_KEY_AND_GO | Key and go pickup method. |
PICKUP_METHOD_NORMAL | Normal pickup method. |
Pickup type
Enum Value | Description |
---|---|
PICKUP_TYPE_UNSPECIFIED | Indicates the pick-up method mapping from the supplier's quote wasn't possible. |
PICKUP_TYPE_DESK_IN_TERMINAL | The pick-up is at desk in terminal. |
PICKUP_TYPE_MEET_AND_GREET | The pick-up is by meet and greet method. |
PICKUP_TYPE_SHUTTLE | The pick-up is by shuttle. |
Fuel policy
Enum Value | Description |
---|---|
FUEL_POLICY_UNSPECIFIED | Indicates the fuel policy mapping from the supplier's quote wasn't possible or is unknown. |
FUEL_POLICY_FULL_TO_FULL | Fuel policy is full to full. |
FUEL_POLICY_FULL_TO_EMPTY | Fuel policy is full to empty. |
FUEL_POLICY_SAME_TO_SAME | Fuel policy is same to same. |
FUEL_POLICY_HALF_TO_HALF | Fuel policy is half to half. |
FUEL_POLICY_HALF_TO_EMPTY | Fuel policy is half to empty. |
FUEL_POLICY_QUARTER_TO_QUARTER | Fuel policy is quarter to quarter. |
FUEL_POLICY_QUARTER_TO_EMPTY | Fuel policy is quarter to empty. |
FUEL_POLICY_EMPTY_TO_EMPTY | Fuel policy is empty to empty. |
FUEL_POLICY_FREE_FULL_TANK | Fuel policy is free full tank. |
Pay type
Enum Value | Description |
---|---|
PAY_TYPE_UNSPECIFIED | Indicates the values is unspecified or unknown. |
PAY_TYPE_ARRIVAL_PAY | Pay at the counter, popular in US. |
PAY_TYPE_MIX_PAY | OTA charges upfront, travellers pays the rest at counter. |
PAY_TYPE_PRE_PAY | Traveller pays full rental rate to the broker. |
Car Hire Indicative Prices
Date time grouping type
Enum Value | Description |
---|---|
DATE_TIME_GROUPING_TYPE_UNSPECIFIED | The date grouping is not specified. |
DATE_TIME_GROUPING_TYPE_BY_DATE | Group the quotes by day. |
DATE_TIME_GROUPING_TYPE_BY_MONTH | Group the quotes by month. |
DATE_TIME_GROUPING_TYPE_BY_WEEK | Group the quotes by week. |
Aggregate type
Enum Value | Description |
---|---|
AGGREGATE_TYPE_UNSPECIFIED | Default value for aggregate type. Should never be returned. |
AGGREGATE_TYPE_CHEAPEST | Aggregate type is cheapest per day. |
AGGREGATE_TYPE_AVERAGE | Aggregate type is average per day. |
AGGREGATE_TYPE_TOTAL_CHEAPEST | Aggregate type is cheapest price in total. |
AGGREGATE_TYPE_TOTAL_AVERAGE | Aggregate type is total average price in total. |
AGGREGATE_TYPE_COUNTRY_AVERAGE | Aggregate type is price per day of the country where the location is located in. |
Vehicle type
For the below descriptions to make more sense please check https://www.acriss.org/car-codes/
Enum Value | Description |
---|---|
VEHICLE_TYPE_UNSPECIFIED | Default value of car type. This is an unexpected value and it shouldn't be returned as part of the response ever. |
VEHICLE_TYPE_SMALL | Vehicle size is one of: - (M) Mini - (N) Mini Elite - (E) Economy - (H) Economy Elite. |
VEHICLE_TYPE_MEDIUM | Vehicle size is one of: - (C) Compact - (D) Compact Elite - (I) Intermediate - (J) Intermediate Elite - (S) Standard - (R) Standard Elite. |
VEHICLE_TYPE_LARGE | Vehicle size is one of: - (F) Fullsize - (G) Fullsize Elite. |
VEHICLE_TYPE_LUXURY | Vehicle size is one of: - (P) Premium - (U) Premium Elite - (L) Luxury - (W) Luxury Elite - (O) Oversize - (X) Special. |
VEHICLE_TYPE_SUV | Number of doors for vehicle is (F) SUV. |
VEHICLE_TYPE_VAN | Number of doors for vehicle is (K) Commercial Van/ Truck. |