January 24th 2023, Release Notes: RME | Menu Cycles: API, New Requests: GET/BuffetMenuCycleItems, GET/MenuCycles and GET/MenuCycleItems

Summary

Select the release feature from the table below to be taken directly to that section of the release note.

Release date for all features: January 24th 2023

New Request to Fetch Buffet Menu Recipes 

• Enabled by Default? - Yes
• Set up by customer Admin? - No
• Enable via Support ticket? - No
• Affects configuration or data? - Yes
• Roles Affected: 

What's Changing?

A new request is available for fetching Buffet Menu Recipes.

Reason for the Change

Increase data available via APIs to support customer Business Intelligence tools and third-party POS providers.

Customers Affected

Optional. Available to all customers using Menu Cycle APIs.

Release Note Info/Steps

GET <baseURL>/Locations/{locationId}/BuffetMenuCycleItems

Sample partial payload

{
  " value": [
      {
         "menuName": "Easter and Mother's Day Buffet Menu",
         "itemMenuDescription": "",
         "categories": [
            {
               "categoryGUID": "ad63e043-43f1-4de9-93f3-166fae41b306",
               "categoryName": "Food - Recipes"
      },
    ],
    "plu": "",
    "itemId": "aa843264-19f6-4aab-a457-531a6882e474",
    "itemName": "Warm Tomato Tart With Rocket And Parmesan",
    "itemType": "RECIPE",
    "prices": [],
    "schedules": [
       {
          "mealPeriodName": "Dinner ",
          "dateTo": "2023-01-10",
          "status": "AVAILABLE",
          "dateFrom": "2023-01-10"
       }
    ]
},

Additional Resources

Menu Cycles API | Fourth

New Requests for 'Not Yet Published' Menu Cycles

• Enabled by Default? - Yes
• Set up by customer Admin? - No
• Enable via Support ticket? - No
• Affects configuration or data? - No
• Roles Affected: 

What's Changing?

Two new requests have been created to fetch a list of all active 'new' (not yet published) menu cycles and their menu cycle items.

Reason for the Change

Increase data available via APIs to support customer Business Intelligence tools.

Customers Affected

Optional. Available to all customers using Menu Cycle APIs.

Release Note Info/Steps

1.  To fetch a list of all active 'new' menu cycles:  GET <base URL>/MenuCycles

Sample partial payload

{
        "id": 10125,
        "name": "Healthy Heart Menu",
        "description": "Low sodium, high protein meals for home workers"
      },
{
        "id": 10130,
        "name": "Breakfast Club for Kids",
        "description": "Menus for before the school day begins"
      },

2.  To fetch a list of all unique menu cycle items within a central 'new' menu cycle:

GET <base URL>/MenuCycles/{menuCycleId}/MenuCycleItems

Response returns the following properties 

"continuationToken": "string",
"value": [
   {
      "itemId": "00000000-0000-0000-0000-000000000000",
      "itemPlu": "string",
      "itemName": "string",
      "itemType": "string"
    }
  ]
}

Response details

Each item within the menu cycle will be contained in the result only once.
The menuCycleId parameter in the request should be a Central 'not yet published', not deleted menu cycle. Otherwise, Http404 with a message is returned.
No items are excluded from the result (buffet recipes are not filtered out).
Items are paginated with a pageSize = 5000.
Basic pagination is implemented using the continuationToken, which represents the item with the max externalId on the page.
If continuationToken is returned in the result this means that the next page should be fetched with ?continuationToken=<the continuation token returned in the prev page call>
If continuationToken in the result is null, then the last page has been reached.

Additional Resources

Menu Cycles API | Fourth