HotelSettingsInput
Settings are the common configurations used to construct requests to the supplier/s. By default, we apply the same configuration to all Hotel-X clients in our back system.
input HotelSettingsInput {
context: String
client: ID
timeout: Int
operationTimeout: Int
auditTransactions: Boolean
businessRules: BusinessRulesInput
suppliers: [HotelXSupplierInput!]
plugins: [PluginStepInput!]
testMode: Boolean
clientTokens: [String!]
commitRequired: Boolean
}
Fields
HotelSettingsInput.context
● String
scalar
Indicates the context of the I/O codes (hotel, board, room and rates)
HotelSettingsInput.client
● ID
scalar
Client name set in TGX, present only if the authorization header is of the JWT type. It is used to modify the user initially set in the preload.
HotelSettingsInput.timeout
● Int
scalar
Specifies the time limit, in milliseconds, for connecting with suppliers. If multiple suppliers are involved, this timeout applies to all of them. If a supplier exceeds this time limit, the connection to that supplier will be cut. However, Travelgate will keep the connection with the client even if this timeout is exceeded. If not set, the value saved in your Hotel-X API default settings will be used.
HotelSettingsInput.operationTimeout
● Int
scalar
Defines the maximum time, in milliseconds, before an operation is cancelled by our system. Once this time is reached, the operation will be aborted and an error will be returned. This timeout is for the Hotel-X layer and should be set to a higher value than the timeout for suppliers. For example, you could specify timeout as 20000ms and operationTimeout as 22000ms. This means that we will send a timeout of 20000ms to the suppliers and will close the connection at 22000ms if the operationTimeout is exceeded. Optional.
HotelSettingsInput.auditTransactions
● Boolean
scalar
Returns all the transactions exchanged with the supplier.
HotelSettingsInput.businessRules
● BusinessRulesInput
input
Business rules
HotelSettingsInput.suppliers
● [HotelXSupplierInput!]
list input
Array of suppliers. Each one contains its own code, settings and accesses.
HotelSettingsInput.plugins
● [PluginStepInput!]
list input
Array of plugins to execute.
HotelSettingsInput.testMode
● Boolean
scalar
This flag is only allowed to be used for the access checked as 'TEST.' By default, it is set to 'LIVE.'
HotelSettingsInput.clientTokens
● [String!]
list scalar
Used to identify the origin of the request. This is solely used in plugins.
HotelSettingsInput.commitRequired
● Boolean
scalar
Indicates if the book will be confirmed in 1 or 2 steps. It only should be used in Book.