Hotels
Query Overview
The hotelsSetUp query returns configurations from hotels of a specific client-seller relation in Inventory. The returned fields include:
idhotelCodecontextCodeactivesendNotificationemailNotificationemailNotificationCcemailNotificationSupport
1. Criteria
When building your query, you need to provide the following input fields:
Mandatory Input
clientCodesupplierCodehotelCodes
Optional Input
contextCode
2. Settings
To retrieve hotel configurations, provide the necessary client and supplier codes along with the hotel codes to filter results.
Response Considerations
The query returns a collection of hotel configurations along with a success status and possible advise messages.
HotelsSetupRs (OBJECT)
hotels(InventoryHotelSetup) - A collection of retrieved hotels.id(Int) - Unique identifier.hotelCode(String) - Associated hotel code.contextCode(String) - Context code for the hotel.active(Boolean) - Indicates if the hotel is active.sendNotification(Boolean) - Indicates if booking notifications should be sent.emailNotification(String) - Email addresses for notifications.emailNotificationCc(String) - CC email addresses for notifications.emailNotificationSupport(String) - Support contact emails.
success(Boolean) - Indicates if the operation was successful.adviseMessages(AdviseMessage) - Messages related to the operation.
Query Inputs
InventoryHotelSetupFilterInput (INPUT_OBJECT)
Hotels setup filter input.
Hotels setup filter input.
hotelCodes * (String)
Hotel codes of the rooms to retrieve.
Hotel codes of the rooms to retrieve.
clientCode * (String)
Client code.
Client code.
supplierCode * (String)
Travelgate Supplier/Channel code.
Travelgate Supplier/Channel code.
contextCode (String)
Travelgate Supplier/Channel context code.
Travelgate Supplier/Channel context code.
Returned Fields
HotelsSetupRs (OBJECT)
Represents the response object for hotel setup operations.
Represents the response object for hotel setup operations.
adviseMessages (AdviseMessage)
Collection of advise messages.
Collection of advise messages.
code * (ID)
AM code: The following codes can be returned:
AM code: The following codes can be returned:
description * (String)
Error description
Error description
level * (Enum of AdviseMessageLevel)
Indicates the level of importance of the message.
Possible values: ERROR, WARN, INFO.
Possible values:
WARN
ERROR
INFO
Indicates the level of importance of the message. Possible values: ERROR, WARN, INFO.
Possible values:
WARNERRORINFOexternal (ExternalMessage)
Specify the external message.
Specify the external message.
code (String)
External code.
External code.
message * (String)
External message.
External message.
correlationID * (ID)
Identifier to investigate the cause of the error.
Identifier to investigate the cause of the error.
hotels (InventoryHotelSetup)
Collection of hotel responses.
Collection of hotel responses.
id * (Int)
Unique identifier of the hotel.
Unique identifier of the hotel.
hotelCode (String)
Code associated with the hotel.
Code associated with the hotel.
contextCode (String)
Context code related to the hotel.
Context code related to the hotel.
active * (Boolean)
Indicates whether the hotel is active.
Indicates whether the hotel is active.
sendNotification * (Boolean)
Indicates whether booking notifications should be sent for this hotel.
Indicates whether booking notifications should be sent for this hotel.
emailNotification (String)
Email addresses for booking notifications related to this hotel.
Email addresses for booking notifications related to this hotel.
emailNotificationCc (String)
Email addresses to be copied on booking notifications related to this hotel.
Email addresses to be copied on booking notifications related to this hotel.
emailNotificationSupport (String)
Email addresses or contact information for support that will be displayed in the email notifications.
Email addresses or contact information for support that will be displayed in the email notifications.
success * (Boolean)
Indicates whether the operation was successful based on the absence of advise messages.
Indicates whether the operation was successful based on the absence of advise messages.