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
Header Parameters
-
Simphony-OrgShortName: string
The ShortName of the organization
Request body
Root Schema : AutoMenuLevelGetRequestBody
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 Auto Menu Levels of the organization
Root Schema : AutoMenuLevel
Type:
objectModel for an Auto Menu Level
Show Source
-
end(optional):
string
Indicates the End Time for every Menu Level in 24-hour formatExample:
20:20 -
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
1 -
hierUnitName(optional):
object TranslatedStringHierUnitName
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
-
hierUnitObjNum(optional):
integer
Object number of the hierarchy unitExample:
1 -
index:
integer
Object number of the auto menu levelExample:
1 -
mainLevelIndex(optional):
integer
Select the Main Level, if any, that becomes active at the specified timeExample:
1 -
options(optional):
integer
A string value of 0???s & 1???s representing the enablement or disablement of the options associatedExample:
1 -
optionsExt(optional):
object OptionsExt_AutoMenuLevel
An object containing the descriptive options list associated with the AutoMenu Level
-
start(optional):
string
Indicates the Start Time for every Menu Level in 24-hour formatExample:
10:10 -
subLevelIndex(optional):
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": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
Example:
{
"en-US":"Enterprise",
"de-DE":".....",
"ar-AR":"....."
}Nested Schema : OptionsExt_AutoMenuLevel
Type:
objectAn object containing the descriptive options list associated with the AutoMenu Level
Show Source
-
activeEntry(optional):
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(optional):
boolean
Select to activate the menu level configuration on Fridays.Example:
false -
activeOnMondays(optional):
boolean
Select to activate the menu level configuration on Mondays.Example:
false -
activeOnSaturdays(optional):
boolean
Select to activate the menu level configuration on Saturdays.Example:
false -
activeOnSundays(optional):
boolean
Select to activate the menu level configuration on Sundays.Example:
false -
activeOnThursdays(optional):
boolean
Select to activate the menu level configuration on Thursdays.Example:
false -
activeOnTuesdays(optional):
boolean
Select to activate the menu level configuration on Tuesdays.Example:
false -
activeOnWednesdays(optional):
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(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