Get Menu Item Definition Default Condiments
post
/config/sim/v1/menuItems/menuitemdefinition/getdefaultcondiments
Get all the default condiments for the menu item definition of a hierarchy unit of the specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : DefaultCondimentGetRequestBody
Type:
Show Source
object-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
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 -
miDefSequence(required):
integer
Sequence number of the menu item definition to which the condiments are associatedExample:
1 -
miMstrObjNum(required):
integer
Object Number of the menu item master for which the condiments are associated.Example:
1 -
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 default condiments in organization.
Root Schema : defaultcondimentGetResponse
Type:
objectModel for a Default Condiment Object
Show Source
-
condimentSetName(required):
object TranslatedString_MenuItemMasterName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the menu item master assigned to the condiment item in configured languages
-
condimentSetObjNum(required):
integer
Object number of the Condiment Set items that are to be assigned as the default condiments when the associated Menu Item is ordered.Example:
1 -
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
1 -
hierUnitName(required):
object TranslatedStringHierUnitName
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 - menuItemDefaultCondimentId(required): integer
-
miDefSequence(required):
integer
Sequence number of the menu item definition to which the condiments are associatedExample:
1 -
miMstrObjNum(required):
integer
Object Number of the menu item master for which the condiments are associated.Example:
1 -
options(required):
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment set associated with the menu itemExample:
00000000 -
optionsExt(required):
object defaultcondiment_optionsExt
An object containing the descriptive options list associated with the default condiments of the menu item definition. This value is excluded by default in GET response.
-
sortGroup(required):
integer
Sort Group number for the Condiment Set.Example:
1
Nested Schema : TranslatedString_MenuItemMasterName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the menu item master assigned to the condiment item in configured languages
Example:
{
"en-US":"Condiment Set Items",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : TranslatedStringHierUnitName
Type:
objectAdditional Properties Allowed
Show Source
A string that contains translations into multiple languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : defaultcondiment_optionsExt
Type:
objectAn object containing the descriptive options list associated with the default condiments of the menu item definition. This value is excluded by default in GET response.
Show Source
-
chargeForEntireSalesCount:
boolean
A Boolean flag indicating to charge for the guests for entire condiment countExample:
false -
displayWhenInDefaultState:
boolean
A Boolean flag indicating to display the condiments in default stateExample:
false
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