Get Combo Side Groups
post
/config/sim/v1/menuItems/getcombosidegroups
Gets all the Combo Meals Groups configured for the specified organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-OrgShortName: string
The ShortName of the organization
A request body
Root Schema : ComboMealsGroupsGetRequestBody
Type:
Show Source
object-
include(optional):
string
Example:
locations -
languages(optional):
string
If specified, limits translated strings returned.Example:
en-US, es-SS,lt-LT -
limit(optional):
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset(optional):
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy(optional):
string
Sorts the response by the specified field name and sort order.Example:
comboMealGroups.objectNum -
searchCriteria(optional):
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Combo Meal Groups of the organization
Root Schema : ComboMealGroupGetResponse
Type:
Show Source
object-
count(optional):
integer
Current response recount count.Example:
9 -
hasMore(optional):
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items(optional):
array items
Array of Combo Meal Group objects of the organization.
-
limit(optional):
integer
Server page sizeExample:
10 -
offset(optional):
integer
Starting resource record indexExample:
0 -
totalResults(optional):
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Combo Meal Group objects of the organization.
Show Source
Nested Schema : ComboMealGroupResourceObject
Type:
Show Source
object-
alternateGroups(optional):
array alternateGroups
An array of Alternate Groups, if any, for this Combo Meal Group.
-
hierUnitId:
integer
Unique hierarchy unit referenceExample:
2 -
hierUnitName(optional):
object TranslatedString_HierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum(optional):
integer
Object number of the hierarchy unitExample:
1 -
items(optional):
array items
An array of items that are associated with the combo meal group
-
name:
object TranslatedString_ComboGroupName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the Combo Group in configured languages
-
objectNum:
integer
Combo Meal object numberExample:
1 -
options(optional):
string
A string value of 0???s & 1???s representing enabled or disabled optionsExample:
00000000 -
optionsExt(optional):
object ComboMealGroup_OptionsExt
An object containing the descriptive options list associated with the Combo Meal Group.
Nested Schema : alternateGroups
Type:
arrayAn array of Alternate Groups, if any, for this Combo Meal Group.
Show Source
Nested Schema : TranslatedString_HierUnitName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"en-US":"Enterprise",
"es-SS":"Empresa",
"lt=LT":"??mon??"
}Nested Schema : items
Type:
arrayAn array of items that are associated with the combo meal group
Show Source
-
Array of:
object ComboMealGroup_Items
Model for Combo Meal Group_Item Object
Nested Schema : TranslatedString_ComboGroupName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the Combo Group in configured languages
Example:
{
"en-US":"Combo Group 1",
"es-SS":"Combo Grupo 1"
}Nested Schema : ComboMealGroup_OptionsExt
Type:
objectAn object containing the descriptive options list associated with the Combo Meal Group.
Show Source
-
allowDiscounts(optional):
boolean
Flag indicating to apply discounts to items in this group.Example:
false -
substitutionGroupItemsUseThisSidesPrice(optional):
boolean
When substituting a Combo Meal side with a menu item from another group, Set this attribute to True to set the item's price to the side's combo meal price specified in the sides Combo Group Price.Example:
false
Nested Schema : ComboMealGroup_AlternateGroup
Type:
Show Source
object-
alternateGroupObjNum(optional):
integer
Object number of the alternate combo meal group.Example:
2 -
sequenceNum(optional):
integer
Sequence number of the alternate combo meal group.Example:
1
Nested Schema : ComboMealGroup_Items
Type:
objectModel for Combo Meal Group_Item Object
Show Source
- menuItemMasterObjNum(optional): integer
-
options(optional):
string
A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup ItemExample:
0000000000000000 -
optionsExt(optional):
object OptionsExt_ComboGroupItem
An object containing the descriptive options list associated with the Combo Meal Group Item
-
prices(optional):
object Price_ComboGroupItem
Model for Combo Group Item Price Object
-
quantity(optional):
integer
Number of Combo Meal Group items required for the combo meal sideExample:
1 -
size1ComboGroupObjNum(optional):
integer
Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663).Example:
0 -
size1MenuLevelIndex(optional):
integer
Menu Level index for using the Combo Size 1.Example:
0 -
size2ComboGroupObjNum(optional):
integer
Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664).Example:
0 -
size2MenuLevelIndex(optional):
integer
Menu Level index for using the Combo Size 2.Example:
0 -
size3ComboGroupObjNum(optional):
integer
Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665).Example:
0 -
size3MenuLevelIndex(optional):
integer
Menu Level index for using the Combo Size 3.Example:
0 -
size4ComboGroupObjNum(optional):
integer
Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666).Example:
0 -
size4MenuLevelIndex(optional):
integer
Menu Level index for using the Combo Size 4.Example:
0
Nested Schema : OptionsExt_ComboGroupItem
Type:
objectAn object containing the descriptive options list associated with the Combo Meal Group Item
Show Source
-
autofill(optional):
boolean
A flag indicating to change the side item quantity to the number of remaining items needed to complete the side requirements when ordering one of the combo meals where more than one remaining item is required.Example:
false -
defaultForOrderType1(optional):
boolean
A flag indicating to make this item the default when Order Type 1 is active.Example:
false -
defaultForOrderType2(optional):
boolean
A flag indicating to make this item the default when Order Type 2 is active.Example:
false -
defaultForOrderType3(optional):
boolean
A flag indicating to make this item the default when Order Type 3 is active.Example:
false -
defaultForOrderType4(optional):
boolean
A flag indicating to make this item the default when Order Type 4 is active.Example:
false -
defaultForOrderType5(optional):
boolean
A flag indicating to make this item the default when Order Type 5 is active.Example:
false -
defaultForOrderType6(optional):
boolean
A flag indicating to make this item the default when Order Type 6 is active.Example:
false -
defaultForOrderType7(optional):
boolean
A flag indicating to make this item the default when Order Type 7 is active.Example:
false -
defaultForOrderType8(optional):
boolean
A flag indicating to make this item the default when Order Type 8 is active.Example:
false -
defaultWhenNoOrderTypeIsSelected(optional):
boolean
Flag indicating to make this item the default for the Combo Group without a declared Order Type.Example:
false -
sendToComboParentsOrderDevices(optional):
boolean
A flag indicating to also send the combo side menu item to the combo meal parent menu item's Order DevicesExample:
false
Nested Schema : Price_ComboGroupItem
Type:
objectModel for Combo Group Item Price Object
Show Source
-
activeOnLevel(optional):
integer
The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levelsExample:
0 -
effectivityGroupObjNum(optional):
integer
Object number of the effectivity group associated with the priceExample:
1 -
prepcost(optional):
number
The ?? la carte price of the combo group side items. You can override the ?? la carte price for individual combo group items by setting an ?? la carte price for those items.Example:
0.89 -
price(optional):
number
The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those itemsExample:
1.23 -
sequenceNum(optional):
integer
The sequence number of the priceExample:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(optional):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(optional):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(optional):
integer
Error code of the problemExample:
55223 -
status(optional):
integer
HTTP status code.Example:
400 -
title(optional):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(optional):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found