SearchRq
Represents the request object for performing hotel searches in the Connectors domain. This class is used to define the parameters and settings for searching available hotel options.
Properties
| Name | Type | Description |
|---|---|---|
| SearchCriteria | SearchCriteria | Gets the search criteria for the hotel search. |
| SearchCriteria/CheckIn | String | The check-in date for the operation, represented as a string in ISO 8601 format (yyyy-MM-dd). |
| SearchCriteria/CheckOut | String | The check-out date for the operation, represented as a string in ISO 8601 format (yyyy-MM-dd). |
| SearchCriteria CheckInAsDateTime | String | The check-in date parsed as a DateTime object. |
| SearchCriteria CheckOutAsDateTime | String | The check-out date parsed as a DateTime object. |
| SearchCriteria/TotalNights | Integer | The total number of nights for the stay, calculated as the difference between check-in and check-out dates. |
| SearchCriteria/Language | String | The language code for the operation, represented as a 2-character ISO 639-1 code (e.g., "en", "es"). |
| SearchCriteria/Currency | Currency | The preferred currency for the operation, defined as an optional Currency value. |
| SearchCriteria/Nationality | String | The nationality code of the client, represented as a 2-character ISO 3166-1 alpha-2 country code (e.g., "US", "FR"). |
| SearchCriteria/Destinations | Destinations | Gets the destinations for the search. These can be specific hotels or locations. |
| SearchCriteria/Destinations Accommodations | Array<AccommodationRQ> | Collection of accommodations for the search request. |
| SearchCriteria/Destinations Accommodations/Type | AccommodationType | Specifies the type of accommodation being requested, such as Hotel or Rental. |
| SearchCriteria/Destinations Accommodations/Code | String | Represents a unique code identifying the accommodation in the request. |
| SearchCriteria/Destinations Locations | Array<Location> | Collection of locations for the search request. |
| SearchCriteria/Destinations Locations/Code | String | The unique code identifying the location. |
| SearchCriteria/Destinations Locations/Country | String | The ISO 3166-1 alpha-2 country code where the location is situated. |
| SearchCriteria/Destinations Locations/Longitude | Double | The longitude coordinate of the location, expressed in decimal degrees. |
| SearchCriteria/Destinations Locations/Latitude | Double | The latitude coordinate of the location, expressed in decimal degrees. |
| SearchCriteria/Occupancies | Array<Occupancy> | Gets the occupancy details for the search.Indicates the number of rooms, passengers, and their respective ages. |
| SearchCriteria/Occupancies OccupancyId | Integer | The unique identifier for the occupancy. |
| SearchCriteria/Occupancies Paxes | Array<PaxInput> | The collection of passenger inputs (paxes) for the occupancy. |
| SearchCriteria/Occupancies Paxes/Age | Integer | Age of the passenger. This value is required and plays a critical role in determining eligibility for child or adult pricing as defined by the supplier. |
| SearchCriteria/Markets | Array | Gets the markets associated with the search.Represents ISO 3166-1 alpha-2 country codes. |
| Settings | SearchSettings | Gets the search settings for the hotel search. |
| Settings/Supplier | String | Identifies the supplier associated with the hotel operation. This is a unique code generated by Travelgate within its system to represent the supplier. |
| Settings/Platform | String | Represents the platform on which the hotel operation is performed.Platforms are collections of suppliers, and the platform code is generated by Travelgate to define the operational context. |
| Settings/Client | String | Represents the client performing the hotel operation.This is a unique client code assigned by Travelgate to identify the client within its system. |
| Settings/Access | Access | Contains access information required for the operation, including API credentials, endpoints, and other connection details specific to the supplier's integration. |
| Settings/Access/Code | Integer | The unique code identifying the access configuration. |
| Settings/Access/User | String | The username used for authentication with the supplier. |
| Settings/Access/Password | String | The password used for authentication with the supplier. |
| Settings/Access/ApiKey | String | The API key used for authentication or authorization. |
| Settings/Access/Urls | Urls | The URLs associated with the access configuration. |
| Settings/Access/Urls/Book | String | The URL used for booking operations. |
| Settings/Access/Urls/Search | String | The URL used for search operations. |
| Settings/Access/Urls/Quote | String | The URL used for quote operations. |
| Settings/Access/Urls/Generic | String | A generic URL for additional operations. |
| Settings/Access/Parameters | AccessParameters | Additional parameters related to the connection. |
| Settings/BusinessRules | BusinessRules | Specifies the business rules to be applied during the operation. These rules define operational constraints and behavior, such as quota limits or prioritization criteria. |
| Settings/BusinessRules OptionsQuota | Integer | The maximum number of options that can be returned for a search operation. |
| Settings/BusinessRules BusinessRuleType | BusinessRulesType | The business rule type that determines how search results are prioritized or filtered. |
| Settings/Timeout | String | Defines the timeout period for the operation as a string value.This indicates the maximum amount of time to wait for a supplier's response before timing out.The value must be provided in timestamp format (e.g., "00:05:00" for 5 minutes). |
| Settings/TimeoutAsTimeSpan | String | Converts the timeout value from the string representation (Timeout) into a TimeSpan for use in time-based operations. |
| Settings IncludeProviderTransactions | Boolean | Indicates whether detailed traces of provider transactions should be included in the operation's response.If enabled, the ProviderAudit field in responses will contain the transaction logs (e.g., requests and responses exchanged with the supplier). |
| Filters | Filters | Gets the filters to be applied to the hotel search results. |
| Filters/Status | StatusFilter | Filter for hotel statuses to include or exclude specific booking statuses in the search results. |
| Filters/Status/Includes | Array<Status> | The statuses to include in the response. |
| Filters/Status/Excludes | Array<Status> | The statuses to exclude from the response. |
| Filters/RateRuleFilter | RateRuleFilter | Filter for rate rules to include or exclude specific rate restrictions in the search results. |
| Filters/RateRuleFilter Excludes | Array<RateRule> | The collection of rate rules that should be excluded from the search results. |
| Filters/RateRuleFilter Includes | Array<RateRule> | The collection of rate rules that should be included in the search results. |
| Filters/RateRuleFilter IncludeEmptyRateRulesOptions | Boolean | Specifies whether options without rate rules should be included in the results when Includes is null. |