4.1. POSSIBLE SEARCH OPTIONS
- Yana Brilevskaya
4.1.1. SEARCH BY LOCATIONS
GP Travel HUB offers several alternatives of searching excursions by location:
| Search by | Description | Search example |
|---|---|---|---|
1 | City code from supplier context (one supplier) | Allows to specify city code of certain supplier and get excursion offers only from this supplier. You can use this case if you know exact location codes from suppliers and would like to get offers only from some supplier. | <Criterion>
<ExcursionRef ExcursionCityCode="1005" ExcursionCodeContext="supplierCode"/>
</Criterion> |
2 | City code from GEO context (one supplier) | When the ExcursionCodeContext is "GEO.<supplier>" then the ExcursionCityCode must be specified in GEO context, and then the search request goes only to the supplier specified. So, you can send a request to the particular supplier, even if you don’t know supplier-specific City Code (as described in p.1 above). | <Criterion>
<ExcursionRef ExcursionCityCode="12175" ExcursionCodeContext="GEO.supplierCode"/>
</Criterion> |
3 | City code from customer context | If it is agreed to support customer context, GP Travel HUB can do search by customer-specific city codes. In this case your application can provide your own city code, GP Travel HUB will resolve it via GEO-tree and send requests to supplier.
| <Criterion>
<ExcursionRef ExcursionCityCode="1005" ExcursionCodeContext="ABC.supplierCode"/>
</Criterion>
|
4 | Country code from supplier context | Allows to specify country code and get excursion offers from supplier. Note: This functionality supported for limited suppliers. Please check with GP Travel HUB development if you are interested in specific supplier. | |
5 | Country code from GEO context (one supplier) | When the ExcursionCodeContext is "GEO.<supplier>" then the ExcursionCountryCode must be specified in GEO context, and then the search request goes only to the supplier specified. So, you can send a request to the particular supplier, even if you don’t know supplier-specific Country Code (as described in p.4 above). | |
6 | Country code from customer context | If it is agreed to support customer context, GP Travel HUB can do search by customer-specific city codes. In this case your application can provide your own city code, GP Travel HUB will resolve it via GEO-tree and send requests to supplier. | |
7 | ExcursionCategoryCode | Allows to specify particular excursion category user is interested in. Note: ExcursionCategoryCode works for Search by country code and for Search by city code. | |
8 | ExcursionSubCategoryCode | Allows to specify particular excursion subcategory user is interested in. Is used together with the ExcursionCategoryCode attribute. See full list of excursion subcategories supported in HUB in Excursion Subcategories. | |
9 | Pagination search | Allows to receive results in parts. To start a pagination search AllowPartialAvail attribute should be true in Availability request. HUB returns available offers until MoreIndicator is true on Availability response. Pagination search can be interrupted after each Availability request. If part of received offers is enough no need to send other Availability requests despite the fact that the MoreIndicator is true on Availability response. Check diagram below for case when you should receive all available offers. Note: AllowPartialAvail=”true” works for Search by country code and for Search by city code. | You can see pagination search example after diagram below. |
Diagram 4.1.1.1. Pagination search process.
Pagination search can be interrupted after each Availability request. If part of received offers is enough no need to send other Availability requests despite the fact that the MoreIndicator is true on Availability response.
4.1.2. SEARCH BY EXCURSION CODE
Search by ExcursionCode works only within ExcursionCityCode:
Search by ExcursionCode works only within ExcursionCityCode and ExcursionCodeContext in GEO context:
4.1.3. SEARCH BY TOURNAMENT
| Search by | Description | Search example |
|---|---|---|---|
1 | Tournament code from supplier context | Allows to search excursions (event or sport match) by tournament code. E.g. by supplier code for Champions League, you’ll get all possible events for a specified date range. Can be only in supplier context! | |
2 | Pagination search | Allows to receive results in parts. To start a pagination search AllowPartialAvail attribute should be true in Availability request. HUB returns available offers until MoreIndicator is true on Availability response. Pagination search can be interrupted after each Availability request. If part of received offers is enough no need to send other Availability requests despite the fact that the MoreIndicator is true on Availability response. Check diagram above for case when you should receive all available offers. | You can see pagination search example after diagram above. |
3 | Country code (or city code) + Tournament code | Allows to search excursions by country or city code and tournament code. |
4.1.4. SEARCH BY COMPETITOR CODE
| Search by | Description | Search example |
|---|---|---|---|
1 | Competitor code from supplier context | Allows to specify particular competitor (code of sports teams or musical bands or individual performers), user is interested in. Can be only in supplier context! | |
2 | Pagination search | Allows to receive results in parts. To start a pagination search AllowPartialAvail attribute should be true in Availability request. HUB returns available offers until MoreIndicator is true on Availability response. Pagination search can be interrupted after each Availability request. If part of received offers is enough no need to send other Availability requests despite the fact that the MoreIndicator is true on Availability response. Check diagram above for case when you should receive all available offers. | You can see pagination search example after diagram above. |
3 | Country code(or city code) + Competitor code | Allows to search excursions by country or city code and competitor code. |
4.1.5. SEARCH BY VENUE
Search by ExcursionVenueCode. Allows to search excursions (event or sport match) by venue code in supplier context.