Skip to main content

Rooms

Query Overview​

The roomsSetUp query returns the rooms added to a hotel rate in Inventory. The returned fields include:

  • code
  • master
    • id
    • code
    • name
  • active
  • externalCode
  • standard
  • uses
    • numberOfGuests
    • minAge
    • maxAge
    • paxType

1. Criteria​

When building your query, you need to provide the following input fields:

Mandatory Input​

  • clientCode
  • supplierCode
  • hotelCode
  • rateCode

Optional Input​

  • contextCode
  • roomCodes

2. Settings​

To retrieve room details, ensure that all mandatory fields are properly provided, and associate the query with the correct hotel and rate.

Response Considerations​

The query returns the room setup details along with success status and possible advise messages.

RoomsSetUpRs (OBJECT)​

  • rooms (InventoryRoomSetUp) - A collection of retrieved rooms.
    • code (String) - The room code.
    • master (InventoryMasterRoom) - The master room details.
      • id (Int) - The master room ID.
      • code (String) - The master room code.
      • name (String) - The master room name.
    • active (Boolean) - Indicates if the room is active.
    • externalCode (String) - The external code associated with the room.
    • standard (Int) - The standard occupancy of the room.
    • uses (InventoryRoomUse) - The list of guest types allowed in the room.
      • numberOfGuests (Int) - The number of guests allowed.
      • minAge (Int) - The minimum age allowed for guests.
      • maxAge (Int) - The maximum age allowed for guests.
      • paxType (Enum of InventoryPaxType) - The type of guests allowed.
        • Possible values: INFANT, CHILD, ADULT
  • success (Boolean) - Indicates if the operation was successful.
  • adviseMessages (AdviseMessage) - Messages related to the operation.

Query Inputs​

InventoryRoomsSetupFilterInput (INPUT_OBJECT)
Rooms setup filter input.

hotelCode  *  (String)
Hotel code of the rooms to retrieve.

clientCode  *  (String)
Client code.

supplierCode  *  (String)
Travelgate Supplier/Channel code.

contextCode (String)
Travelgate Supplier/Channel context code.

roomCodes (String)
Room codes.

rateCode  *  (String)
Room codes.

Returned Fields​

RoomsSetUpRs (OBJECT)
Represents the response object for room setup operations.

adviseMessages (AdviseMessage)
Collection of advise messages.

code  *  (ID)
AM code: The following codes can be returned:

description  *  (String)
Error description

level  *  (Enum of AdviseMessageLevel)
Indicates the level of importance of the message. Possible values: ERROR, WARN, INFO.
Possible values:
WARN
ERROR
INFO

external (ExternalMessage)
Specify the external message.

code (String)
External code.

message  *  (String)
External message.

correlationID  *  (ID)
Identifier to investigate the cause of the error.

rateCode (String)
Rate code associated with the rooms.

rooms (InventoryRoomSetUp)
Collection of room setup responses.

code (String)
Code associated with the room.

master (InventoryMasterRoom)
Master of the room.

id  *  (Int)
Id associated with the room master.

code (String)
Code associated with the room.

name (String)
Name associated with the room.

active  *  (Boolean)
Indicates whether the room is active.

externalCode (String)
External code associated with the room.

standard  *  (Int)
Standard of the room. Typically the number of guests.

uses  *  (InventoryRoomUse)
List of uses associated with the room.

numberOfGuests  *  (Int)
Gets or sets the number of guests allowed in the room.

minAge  *  (Int)
Gets or sets the minimum age allowed for guests in the room.

maxAge  *  (Int)
Gets or sets the maximum age allowed for guests in the room.

paxType  *  (Enum of InventoryPaxType)
Gets or sets the type of guests allowed in the room. PaxType
Possible values:
INFANT
CHILD
ADULT

success  *  (Boolean)
Indicates whether the operation was successful based on the absence of advise messages.

Examples​

Retrieve all rooms from a rate​

    Retrieve specific rooms from a rate​