Skip to main content

Boards Catalog

The boards endpoint provides access to meal plan (board) catalog data.

Endpoint​

POST /content/hotels/v1/boards

Board Types​

The endpoint returns the boards a given connection publishes, not a fixed list: each response depends on the supplier behind that connection. Every code comes back with the boardCode it normalizes to, which is what availability returns.

For the normalized vocabulary and what each code means, see Board Codes.

Use Cases​

Get All Boards​

{
  "query": {}
}

Filter by Connection​

{
  "query": {
    "connectionCode": "CONN_1"
  }
}

Response Structure​

{
  "boards": {
    "boards": [
      {
        "code": "BB",
        "boardData": {
          "code": "BB",
          "boardCode": "AD"
        }
      }
    ],
    "count": 1,
    "token": null
  }
}

code is what the connection publishes; boardData.boardCode is the normalized value availability returns as boardCode. When they differ, filter search on the normalized one.

Board codes filter availability through criteria.resultFilters.boardCodes:

{
  "criteria": {
    "resultFilters": {
      "boardCodes": ["AD", "MP"]
    }
  }
}

Next Steps​