Get Combo Meal Side Groups
post
/config/sim/v1/menuItems/combomeals/getmealsidegroups
Gets all the Combo Meal sides of a combo meal for the specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : ComboMealSideGetRequestBody
Type:
Show Source
object-
comboMealObjNum(required):
integer
Unique reference of the Combo MealExample:
2 -
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
include:
string
Example:
locations -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits translated strings returned.Example:
en-US, de-DE, es-MX -
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum -
searchCriteria:
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 Sides of the organization
Root Schema : ComboMealSideGetResponse
Type:
Show Source
object-
count(required):
integer
Current response record count.Example:
9 -
hasMore(required):
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items(required):
array items
Array of Combo Meal Side objects of the organization.
-
limit(required):
integer
Server page sizeExample:
10 -
offset(required):
integer
Starting resource record indexExample:
0 -
totalResults(required):
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : ComboMealSideResourceObject
Type:
Show Source
object-
comboGroupName:
object TranslatedString_ComboGroupName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the Combo Group in configured languages
-
comboGrpObjNum(required):
integer
Object number of the Side Item Group that contains the side items for the combo meal.Example:
1 -
comboMealObjNum(required):
integer
Combo Meal object numberExample:
1 -
defaultMenuLevelIndex:
integer
Index of the default menu level for this combo group.Example:
1 -
hierUnitId(required):
integer
Unique hierarchy unit referenceExample:
2 -
hierUnitName:
object TranslatedString_HierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 - menuLevel: string
- menuLevelExt: object ComboMeals_MenuLevelExt
-
sideCount:
integer
Number of Combo Meal Group items required for the combo meal side.Example:
1 -
sideNum(required):
integer
Sequence number of the side.Example:
1
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-MX":"Combo Grupo 1"
}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",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : ComboMeals_MenuLevelExt
Type:
objectAn object containing the descriptive list of menu levels associated with the Combo Meal
Show Source
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
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