Rooms Master
Query Overview
The roomsMaster
query returns a list of all the hotel room masters created in Inventory. The returned fields include:
id
code
name
1. Criteria
This query offers versatility, with an optional field codes
that can be filled with the Room masters' codes to retrieve. This allows for a tailored query, ensuring that only relevant data is retrieved.
Mandatory Input
clientCode
Optional Input
codes
Your ClientCode
can be retrieved from any TravelgateX access with a Channel Manager.
See My Connections and click "Get form data" in the selected access. The code in Password
is equivalent to the ClientCode
.
2. Settings
To retrieve room masters, provide the clientCode
and, optionally, specify codes
to filter by specific room types.
Response Considerations
The query returns a collection of room masters along with a success status and possible advise messages.
RoomsRs
(OBJECT)
rooms
(InventoryRoom) - A collection of retrieved rooms.id
(Int) - Unique identifier.code
(String) - Room code.name
(String) - Room name.
success
(Boolean) - Indicates if the operation was successful.adviseMessages
(AdviseMessage) - Messages related to the operation.
Query Inputs
InventoryRoomsMasterFilterInput (INPUT_OBJECT)
Rooms master filter input.
Rooms master filter input.
codes (String)
Room codes of the rooms to retrieve.
Room codes of the rooms to retrieve.
clientCode * (String)
Client code.
Client code.
Returned Fields
RoomsRs (OBJECT)
Represents the response data for retrieving rooms.
Represents the response data for retrieving rooms.
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:
WARN
ERROR
INFO
external (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.
rooms (InventoryRoom)
Collection of rooms.
Collection of rooms.
id * (Int)
Unique identifier for the room.
Unique identifier for the room.
code (String)
Code of the room.
Code of the room.
name (String)
Name of the room.
Name of the room.
success * (Boolean)
Indicates whether the response was successful based on the absence of advise messages.
Indicates whether the response was successful based on the absence of advise messages.
Examples
Retrieve full list of Room masters
Retrieve a specific list of Room master
For more personalized results, filter specific Room masters based on your interests.