Jump to

• Request
• Response

Get Menu Levels

post

/config/sim/v1/setup/getmenulevels

Gets all the Menu Levels configured

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : MenuLevelGetRequestBody

Type: object

Show Source

• 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 supported

  Example: 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 value

  Example: where equals(active,1)

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "example":2,
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Number of results returned in this page. Not required if paging parameters are not supported."
        },
        "orderBy":{
            "type":"string",
            "example":"comboMealGroups.objectNum",
            "description":"Sorts the response by the specified field name and sort order."
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(active,1)",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "example":"locations"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-SS,lt-LT",
            "description":"If specified, limits translated strings returned."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Menu Levels in organization.

Body ()

Root Schema : MenuLevel

Type: object

Model for Menu Level for an organization

Show Source

• defaultMIMstrGrpName(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• defaultMIMstrGrpObjNum(optional): integer
  Object number of default menu item master group associated with the Menu Level.

  Example: 1
• hierUnitId: integer
  Unique reference of the hierarchy unit

  Example: 1
• hierUnitName(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• hierUnitObjNum(optional): integer
  Object number of the hierarchy unit

  Example: 1
• menuLevelEntries(optional): array menuLevelEntries
• menuLevelType(optional): string
  Specifies whether the Menu Level Set refers to the Main Levels, Sub Levels, or to the levels defined within the record. Following values are supported Main, Sub and Custom

  Example: Main
• name: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• objectNum: integer
  Object number the menu level

  Example: 1
• options(optional): string
  A string value of 0s and 1s representing the enablement or disablement of the options associated.

  Example: 10000000
• optionsExt(optional): object MenuLevel_optionsExt
  An object containing the descriptive options list associated with the Menu Level

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the hierarchy unit"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the hierarchy unit"
        },
        "hierUnitName":{
            "description":"A group of string objects representing the name of the hierarchy unit configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number the menu level"
        },
        "name":{
            "description":"A group of string objects representing the name of Menu Level in configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "menuLevelType":{
            "type":"string",
            "example":"Main",
            "description":"Specifies  whether the Menu Level Set refers to the Main Levels, Sub Levels, or to the levels  defined  within the record. Following values are supported Main, Sub and Custom"
        },
        "defaultMIMstrGrpObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of default menu item master group associated  with the Menu Level."
        },
        "defaultMIMstrGrpName":{
            "description":"A group of string objects representing the name of the default menu item master group associated with the Menu Level  in configured languages.",
            "$ref":"#/definitions/TranslatedString"
        },
        "options":{
            "type":"string",
            "example":"10000000",
            "description":"A string value of 0s and 1s representing the enablement or disablement of the options associated."
        },
        "optionsExt":{
            "$ref":"#/definitions/MenuLevel_optionsExt"
        },
        "menuLevelEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MenuLevel_menuLevelEntries"
            }
        }
    },
    "description":"Model for Menu Level for an organization"
}

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A string that contains translations into multiple languages\n\n**Example**\n`{ \"en-US\": \"coffee\", \"de-DE\": \"kaffee\", \"ar-AR\": \"????????\" }`\n",
    "type":"object",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee",
        "ar-AR":"????????"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "ar-AR":"????????"
}

Nested Schema : menuLevelEntries

Type: array

Show Source

• Array of: object MenuLevel_menuLevelEntries
  An array of the entries associated with the menu level

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MenuLevel_menuLevelEntries"
    }
}

Nested Schema : MenuLevel_optionsExt

Type: object

An object containing the descriptive options list associated with the Menu Level

Show Source

• enableBoundToParent(optional): boolean
  Select to change to default menu level when a workstation operator presses a touchscreen button corresponding to any menu level in this Menu Level Set again to turn off the level.

  Example: false
• enableRevertToDefaultLevelOnKeyPress(optional): boolean
  Select to switch the active parent menu item when the active menu level changes.

  Example: false

{
    "type":"object",
    "properties":{
        "enableBoundToParent":{
            "type":"boolean",
            "example":false,
            "description":"Select to change to default  menu level  when a workstation operator presses  a touchscreen button corresponding to any menu level  in this Menu Level  Set again to turn off the level."
        },
        "enableRevertToDefaultLevelOnKeyPress":{
            "type":"boolean",
            "example":false,
            "description":"Select to switch the active parent menu item when the active menu level changes."
        }
    },
    "description":"An object containing  the descriptive options list associated  with the Menu Level"
}

Nested Schema : MenuLevel_menuLevelEntries

Type: object

An array of the entries associated with the menu level

Show Source

• index(optional): integer
  Index of the menu level entry

  Example: 1
• name(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• options(optional): string
  A string value of 0s and 1s representing the enablement and disablement of options associated.

  Example: 00000000
• optionsExt(optional): object MenuLevel_menuLevelEntries_optionsExt
  An object containing the descriptive options list associated with the Menu level.
• prefix(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• suffix(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`

{
    "type":"object",
    "properties":{
        "index":{
            "type":"integer",
            "example":1,
            "description":"Index of the menu level entry"
        },
        "name":{
            "description":"A group of string objects representing the name of the Menu Level entry in configured languages.",
            "$ref":"#/definitions/TranslatedString"
        },
        "prefix":{
            "description":"Prefix of the menu level to show on the check detail area,  print on guest checks and customer receipts.",
            "$ref":"#/definitions/TranslatedString"
        },
        "suffix":{
            "description":"Suffix of the menu level to show on the check detail area, print on guest checks and customer receipts.",
            "$ref":"#/definitions/TranslatedString"
        },
        "options":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0s and 1s representing the enablement and disablement of options associated."
        },
        "optionsExt":{
            "$ref":"#/definitions/MenuLevel_menuLevelEntries_optionsExt"
        }
    },
    "description":"An array of the entries associated with the menu level"
}

Nested Schema : MenuLevel_menuLevelEntries_optionsExt

Type: object

An object containing the descriptive options list associated with the Menu level.

Show Source

• anonymous(optional): boolean
  Select to mark this menu level as the anonymous level for the Menu Level Set.

  Example: false
• defaults(optional): boolean
  Select to mark this menu level as the default level for the Menu Level Set.

  Example: false

{
    "type":"object",
    "properties":{
        "defaults":{
            "type":"boolean",
            "example":false,
            "description":"Select to mark this menu level as the default level for the Menu Level Set."
        },
        "anonymous":{
            "type":"boolean",
            "example":false,
            "description":"Select to mark this menu level as the anonymous level for the Menu Level Set."
        }
    },
    "description":"An object containing  the descriptive options list associated with the Menu level."
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response 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 problem

  Example: 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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top