Get Auto Menu Levels
post
/config/sim/v2/setup/getAutoMenuLevels
Gets a list of all the auto menu levels
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A collection of Auto Menu Levels.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Auto Menu Level objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Auto Menu Level objects of the organization.
Show Source
-
Array of:
object AutoMenuLevelv2
Model for an Auto Menu Level
Nested Schema : AutoMenuLevelv2
Type:
objectModel for an Auto Menu Level
Show Source
-
end:
string
Indicates the End Time for every Menu Level in 24-hour formatExample:
20:20 -
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
1 -
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
index:
integer
Object number of the auto menu levelExample:
1 -
mainLevelIndex:
integer
Select the Main Level, if any, that becomes active at the specified timeExample:
1 -
options:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associatedExample:
00000000 -
optionsExt:
object OptionsExt_AutoMenuLevel
An object containing the descriptive options list associated with the AutoMenu Level
-
start:
string
Indicates the Start Time for every Menu Level in 24-hour formatExample:
10:10 -
subLevelIndex:
integer
Select the Sub Level, if any, that becomes active at the specified time
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