Data Dictionary

This is a reference to help you interpret the data contained in the results returned from your api requests.

Menus

• Endpoint: ==https://results-api.hgem.com/menus

  • Response data:

    Field Name	Data type	Nullable	Definition
    id	Integer	-	HGEM's unique identifier for the menu
    menuName	String	-	The name of the menu
    menuCode	String	-	The code of the menu
    startDate	ISO date/time	-	The start date of the menu
    endDate	ISO date/time	Y	The end date of the menu
    hasNextPage	Boolean	-	Identifies if there is more data available in subsequent pages
    endCursor	String	-	Token to use in the after parameter in the request to get the next page

Menu Dishes

• Endpoint: ==https://results-api.hgem.com/menus/dishes

  • Response data:

    Field Name	Data type	Nullable	Definition
    menuId	Integer	-	HGEM's unique identifier for the menu
    dishCode	String	-	The code of the dish
    dishDescription	String	-	The description of the dish
    dishType	String	-	The type of the dish
    dishOrder	Integer	-	The display order of the dish
    dishExpiryDate	ISO date/time	Y	The expiry date of the dish page
    updatedDishImage	Boolean	-	Whether the dish image has been updated in the request