CancelRq

Represents the data structure for a hotel booking cancellation request, encapsulating the necessary input details and configuration settings required for processing.

Properties

Name	Type	Description
Input	CancelInput	Gets or initializes the input details for the cancellation request, including specific information about the booking to be canceled. Such as the access, booking reference, and accommodation code.
Input/AccessCode	String	Access code associated with the cancellation request. This property is deprecated and should not be used in new implementations.
Input/Language	String	Gets or sets the language code for the cancellation request.
Input/AccommodationRq	AccommodationRQ	Details of the accommodation associated with the cancellation request, such as the accommodation type and code.
Input/AccommodationRq/Type	AccommodationType	Specifies the type of accommodation being requested, such as Hotel or Rental.
Input/AccommodationRq/Code	String	Represents a unique code identifying the accommodation in the request.
Input/Reference	Reference	Reference information containing client, supplier, or hotel locators for the booking associated with the cancellation request. Validation of these locators is performed based on the metadata restriction information.
Input/Reference/ClientLocator	String	The booking locator provided by the client.This is typically used to match the booking in the client's internal systems.
Input/Reference SupplierLocator	String	The booking locator provided by the supplier.This identifier is used to reference the booking in the supplier's system.
Input/Reference/HotelLocator	String	The booking locator specific to the hotel, provided by the supplier. (Optional)This may be required in cases where the hotel system uses its own unique identifiers.
Settings	Settings	Gets or initializes the platform-specific settings required for processing the cancellation request. These settings include credentials, API endpoints, parameters, and details about the client, supplier, and platform involved in the request.
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).