Get Auto Menu Levels
post
/config/sim/v1/setup/getAutoMenuLevels
Gets a list of all the auto menu levels
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : AutoMenuLevelGetRequestBody
Type:
Show Source
object-
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:
comboMealGroups.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 Auto Menu Levels of the organization
Root Schema : AutoMenuLevelGetResponse
Type:
objectModel for an Auto Menu Level
Show Source
-
end(required):
string
Indicates the End Time for every Menu Level in 24-hour formatExample:
20:20 -
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 -
index(required):
integer
Object number of the auto menu levelExample:
1 -
mainLevelIndex(required):
integer
Select the Main Level, if any, that becomes active at the specified timeExample:
1 -
options(required):
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associatedExample:
00000000 -
optionsExt(required):
object OptionsExt_AutoMenuLevel
An object containing the descriptive options list associated with the AutoMenu Level
-
start(required):
string
Indicates the Start Time for every Menu Level in 24-hour formatExample:
10:10 -
subLevelIndex(required):
integer
Select the Sub Level, if any, that becomes active at the specified time
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 : OptionsExt_AutoMenuLevel
Type:
objectAn object containing the descriptive options list associated with the AutoMenu Level
Show Source
-
activeEntry:
boolean
Select to make the selected menu level configuration (1-8) active in the revenue center. Serving Periods, if configured with active levels, override this table.Example:
false -
activeOnFridays:
boolean
Select to activate the menu level configuration on Fridays.Example:
false -
activeOnMondays:
boolean
Select to activate the menu level configuration on Mondays.Example:
false -
activeOnSaturdays:
boolean
Select to activate the menu level configuration on Saturdays.Example:
false -
activeOnSundays:
boolean
Select to activate the menu level configuration on Sundays.Example:
false -
activeOnThursdays:
boolean
Select to activate the menu level configuration on Thursdays.Example:
false -
activeOnTuesdays:
boolean
Select to activate the menu level configuration on Tuesdays.Example:
false -
activeOnWednesdays:
boolean
Select to activate the menu level configuration on Wednesdays.Example:
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