Boards

The Boards Query allows you to retrieve board information in two ways:

• The FastX Board List, which returns the complete list of standardized meal plans (boards) used in Travelgate throughout the booking flow.
• The Supplier Board List, which provides the native board information for each connected supplier.

The returned fields include:

• boardCode
• text
• language

Query Overview

When creating your boards query, you have 1 input to fill based on your specific needs:

1. Criteria

1. Criteria

This query offers versatility, with certain fields marked as mandatory (access) and others as optional (boardCodes). This flexibility empowers you to create a personalized Boards Query, tailoring the requested fields to your specific needs. Consequently, the response will only include information that is highly relevant to you, streamlining the retrieval process and ensuring the data you receive meets your exact requirements.

Mandatory criteria

• access

Optional criteria

• boardCodes (Search a specific board type)

Query Inputs

HotelXBoardQueryInput (INPUT_OBJECT)

boardCodes(String)

Indicates the board codes that you want filter.

access  *  (ID)

Indicates the access that you want use.

Returned Fields

BoardConnection (OBJECT)
BoardList definition

edges(BoardEdge)

node(Board)

code  *  (ID)

Board ID

boardData(BoardData)

Board data

code  *  (ID)

Internal code for checking availability

boardCode  *  (String)

Code of the hotel in the Supplier selected

texts(Text)

Label

text  *  (String)

language  *  (Language)

adviseMessage(AdviseMessage)

List of messages

code  *  (ID)

AM code: The following codes can be returned:

description  *  (String)

Error description

level  *  (AdviseMessageLevel)

Indicates the level of importance of the message. Possible values: ERROR, WARN, INFO. Possible values:

• WARN: Warning message.
• ERROR: Error message.
• INFO: Info message.

external(ExternalMessage)

Specify the external message.

code(String)

External code.

message  *  (String)

External message.

correlationID  *  (ID)

Identifier to investigate the cause of the error.

createdAt  *  (DateTime)

Date created

updatedAt  *  (DateTime)

Date updated

cursor  *  (String)

pageInfo  *  (PageInfo)

Indicates info about page

hasNextPage  *  (Boolean)

hasPreviousPage  *  (Boolean)

startCursor(String)

endCursor(String)

Use Cases

FastX master board list

To retrieve the FastX Board Master, make a board list call using your FastX access, which you can find in the MyConnections section under the Seller "Travelgate". This returns the complete list of unique boards from the Travelgate ecosystem.

Supplier board list

To retrieve only one Supplier's native board list, include that Supplier's access in the query (for example, access 2 for the Travelgate Test supplier).

Board list for specific board code

Use the Boards List Query to filter specific board types. For example, if you only want half board options, include boardCodes such as "2" and "256" in your criteria (these are supplier-native codes for half board in this example). This helps you retrieve more targeted and relevant results.

note

The amount of information and content returned might vary between Sellers.

HotelX supports all languages, but receiving board descriptions in one or another depends entirely on the languages supported by the Seller.