Direct Flight Search (SOAR web Integration)
- Kristian Luck
- Duy Doan
- Loi Ly
Many clients choose to operate and manage a corporate website / mobile site themselves. When taking this approach, they often want to permit visitors to provide their travel criteria in the corporate website and then transfer seamlessly to the InteliSys IBE. In the case of ameliaSOAR, this is facilitated by a page (/direct-flight-search) which accepts the travel criteria as querystring parameters. The table below provides the required information for a client to transfer a travel request to ameliaSOAR. Note that these parameters are a subset of parameters to the TravelOptions RESTful API (linked to from amelia API Documentation).
| Field Name | Description | Required or Optional | Format / Example | Additional Information |
|---|---|---|---|---|
| cityPair | The origin and destination airport city pair. | required | origin-destination | Enabling the multi-city search by providing more city pairs, split by e.g: |
| departure | The date of departure. This is relative to the origin airport. | required | yyyy-mm-dd e.g. 2017-12-15 | Enabling the multi-city search by providing more departure dates, split by e.g: 2017-12-15,2017-12-16 |
| return | The date of return. This is relative to the destination airport. | optional | yyyy-mm-dd | If not specified (or blank), the trip is assumed to be one-way; otherwise, the trip is assumed to be round trip. Note: This will be ignored in multi-city search request (multiple city pairs) |
| cabinClass | The cabin class code being requested. Also known as class of service or level of service. Multiple-cabin class support: If airline wants to search with more than 1 cabin class, then the comma-list array should be passed. For example: Y,C | optional | e.g. Y e.g. Y,C | If not provided (or blank), the default cabin class is assumed. All available cabin classes can be retrieved using the CabinClasses RESTful API. This parameter is ignored if the client is using the combined classes of service feature (i.e. multiple classes of service are searched for available fare options at the same time). |
| currency | The currency code for the currency amounts returned. | optional | e.g. CAD | If not provided (or blank), the default currency is assumed. All available currencies can be retrieved using the Currencies RESTful API. |
| promoCode | Promotion code to be validated and applied during fare retrieval. | optional | ||
| language | Language code to indicate what language the IBE should be initially displayed in. | optional | e.g. en | If not provided (or blank), the default language is assumed. All available languages can be retrieved using the Languages RESTful API. |
| saleAffiliateId | Sale Affiliate Id to indicate where that booking comes from. (e.g. Google Flights, ...) Rules: | optional | e.g. abc-123-abc | NOTE: This is a new capability that should be available in early 2022. |
| expandInterlineSearch | This is new flag to tell SOAR web to look up possible fare options outside of the ameliaRES system. A special SOAR web CMS configuration should be enabled to be able to use this flag. If the setup is in place and you provide the city pair that outside of the ameliaRES system, SOAR web will automatically set value to true and do the expanded search | optional | expected value: true or false | Available with SOAR web version #3454 |
With Passenger Type Codes Enabled
The following fields are involved when passenger type codes are in use by the given airline.
| Field Name | Description | Required or Optional | Format / Example | Additional Information |
|---|---|---|---|---|
| passengerCounts | The number of passengers to be booked, by passenger type code. | required | ADT:1,CHD:0,INF:0 | In this example, we are requesting one Adult (ADT), 0 Child (CHD), and 0 Infant (INF) passengers. |
As an example, suppose we have a fictional airline, Fiction Airlines with an ameliaSOAR base URL of https://m.fictionair.com. A valid direct flight search request to that ameliaSOAR could be https://m.fictionair.com/direct-flight-search?cityPair=XTF-XEG&departure=2018-10-23&passengerCounts=ADT:1.
With Passenger Type Codes Disabled
The following fields are involved when passenger type codes are not in use by the given airline.
| Field Name | Description | Required or Optional | Format / Example | Additional Information |
|---|---|---|---|---|
| adultCount | The number of adult passengers expected to reserve. 0 or above. | required | e.g. 1 | Required |
| childCount | The number of child passengers expected to reserve. 0 or above. | optional | If not provided (or blank), 0 is assumed. | |
| infantCount | The number of infant passengers expected to reserve. 0 or above. | optional | If not provided (or blank), 0 is assumed. |
As an example, suppose we have a fictional airline, Fiction Airlines with an ameliaSOAR base URL of https://m.fictionair.com. A valid direct flight search request to that ameliaSOAR could be https://m.fictionair.com/direct-flight-search?cityPair=XTF-XEG&departure=2018-10-23&adultCount=1.