Smart Menu Editor - JSON Definition
- Geoffry Fang
Introduction
In this document, we will take a look at the Kuusoft Smart Menu Editor data integration JSON schematic.
Data Structure Overview
JSON Definition Example
{
"SecurityToken": "OnePass user account API security token",
"MenuBoardID": "Menu board unique ID",
"DefinitionVersion": 1,
"Categories": [
{
"ThemeStyleID": "Category theme style unique ID",
"Name": "Category name",
"DF1": "Value for Dynamic Field 1",
"DF2": "Value for Dynamic Field 2",
"DF3": "Value for Dynamic Field 3",
"DF4": "Value for Dynamic Field 4",
"DF5": "Value for Dynamic Field 5",
"DF6": "Value for Dynamic Field 6",
"DF7": "Value for Dynamic Field 7",
"DF8": "Value for Dynamic Field 8",
"DF9": "Value for Dynamic Field 9",
"DF10": "Value for Dynamic Field 10",
"Items": [
{
"Name": "Item name",
"Description": "Item description",
"DF1": "Value for Dynamic Field 1",
"DF2": "Value for Dynamic Field 2",
"DF3": "Value for Dynamic Field 3",
"DF4": "Value for Dynamic Field 4",
"DF5": "Value for Dynamic Field 5",
"DF6": "Value for Dynamic Field 6",
"DF7": "Value for Dynamic Field 7",
"DF8": "Value for Dynamic Field 8",
"DF9": "Value for Dynamic Field 9",
"DF10": "Value for Dynamic Field 10"
}
]
}
]
}JSON Example
{
"SecurityToken": "6ce0d7d5-82f6-4f5b-ac11-572b4fc4d703",
"MenuBoardID": "cc8b705f-aac5-4be1-83bc-bb7220fbe178",
"DefinitionVersion": 1,
"Categories": [
{
"ThemeStyleID": "2323c939-b254-4f32-b926-3cbce42fe7f3",
"Name": "Burgers",
"DF1": "All burgers are made daily in the store.",
"Items": [
{
"Name": "Cheeseburger BLT",
"Description": "Classic cheeseburger with bacon, lettuce and tomato",
"DF1": "$4.50",
"DF2": "575cal"
},
{
"Name": "Chicken Burger BLT",
"Description": "Made with free range chicken with bacon, lettuce and tomato",
"DF1": "$7.25",
"DF2": "480cal"
}
]
},
{
"ThemeStyleID": "81a2a1ce-ea27-4b73-9abc-c32cd811d658",
"Name": "Drinks",
"Items": [
{
"Name": "Coke",
"DF1": "$1.50",
"DF2": "$2.25",
"DF3": "$2.50",
"DF4": "180cal",
"DF5": "220cal",
"DF6": "288cal"
},
{
"Name": "Orange Juice",
"DF1": "$3.50",
"DF2": "$4.25",
"DF4": "275cal",
"DF5": "320cal"
}
]
}
]
}JSON Attribute Details
SecurityToken
Attribute Requirement
Required
Description
This is a security token based on the OnePass user account that has access to the targeted menu board.
MenuBoardID
Attribute Requirement
Required
Description
This is the unique ID of the targeted menu board.
DefinitionVersion
Attribute Requirement
Required
Description
The JSON schematic version. The latest version is 1.
Categories.ThemeStyleID
Attribute Requirement
Required
Description
Category and item unique style ID. Depending on the design, you may have at least 1 style and up to an unlimited number of style.
The ThemeStyleID here is the design style for formatting the category and the items within the category. This is not the overall menu board design theme style.
Categories.Name
Attribute Requirement
Required
Description
The name of the category.
Categories.DF1 … Categories.DF10
Attribute Requirement
Optional
Description
This is used as Dynamic Field (DF). There is a total of 10 dynamic fields. Depending on the design, each field will be used differently. Please consult the design dynamic field mapping documentation for each design.
Categories.Items.Name
Attribute Requirement
Required
Description
The name of an item in the category.
Categories.Items.Description
Attribute Requirement
Optional
Description
The item description of the item in the category.
Categories.Items.DF1 … Categories.Items.DF10
Attribute Requirement
Optional
Description
This is used as Dynamic Field (DF). There is a total of 10 dynamic fields. Depending on the design, each field will be used differently. Please consult the design dynamic field mapping documentation for each design.