Jump to

• Request
• Response

Add Menu Item Masters

post

/config/sim/v1/menuItems/menuItemMasters

Add the Menu Item Master object to a specified hierarchy unit .

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.

Body ()

Request body

Root Schema : menuItemMasterInsertRequestBody

Type: object

Show Source

• dataExtensions: array dataExtensions
  An array of data extensions for the menu item
• dietaryLabels: array dietaryLabels
  An array of dietary labels for menu item
• familyGroupObjectNum: integer
  Family group object number

  Example: 1
• hierUnitId(required): integer
  Unique hierarchy unit reference

  Example: 2
• majorGroupObjectNum: integer
  Major group object number

  Example: 2
• masterGroupObjectNum: integer
  Master group object number

  Example: 2
• miMasterOptions: string
  A string value of 0s & 1s of length 8 representing the enabled or disabled options, default 00000000.

  Example: 00000000
• miMasterOptionsExt: object MenuItem_miMasterOptionsExt
• name: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages
• objectNum(required): integer
  Menu item master object number

  Example: 1
• reportGroupObjectNum: integer
  Report group object number

  Example: 2

{
    "type":"object",
    "required":[
        "objectNum",
        "hierUnitId"
    ],
    "properties":{
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Menu item master object number"
        },
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString"
        },
        "familyGroupObjectNum":{
            "type":"integer",
            "example":1,
            "description":"Family group object number"
        },
        "majorGroupObjectNum":{
            "type":"integer",
            "example":2,
            "description":"Major group object number"
        },
        "masterGroupObjectNum":{
            "type":"integer",
            "example":2,
            "description":"Master group object number"
        },
        "reportGroupObjectNum":{
            "type":"integer",
            "example":2,
            "description":"Report group object number"
        },
        "miMasterOptions":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0s & 1s of length 8 representing the enabled or disabled options, default 00000000."
        },
        "miMasterOptionsExt":{
            "$ref":"#/definitions/MenuItem_miMasterOptionsExt"
        },
        "dietaryLabels":{
            "type":"array",
            "description":"An array of dietary labels for menu item",
            "items":{
                "$ref":"#/definitions/MenuItemMaster_dietaryLabels"
            }
        },
        "dataExtensions":{
            "type":"array",
            "description":"An array of data extensions for the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_dataExtensions"
            }
        }
    }
}

Nested Schema : dataExtensions

Type: array

An array of data extensions for the menu item

Show Source

• Array of: object MenuItem_dataExtensions

{
    "type":"array",
    "description":"An array of data extensions for the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_dataExtensions"
    }
}

Nested Schema : dietaryLabels

Type: array

An array of dietary labels for menu item

Show Source

• Array of: object MenuItemMaster_dietaryLabels

{
    "type":"array",
    "description":"An array of dietary labels for menu item",
    "items":{
        "$ref":"#/definitions/MenuItemMaster_dietaryLabels"
    }
}

Nested Schema : MenuItem_miMasterOptionsExt

Type: object

Show Source

• core: boolean
  Selecting the core option designates the menu item as a core item, ensuring it is always available for sale and cannot be disabled using effectivity groups. When this option is chosen, the effectivity group selection grid is disabled, and any previously selected effectivity groups are disregarded during the sales process. miMasterOptions Option Bit = 4

  Example: false
• disabled: boolean
  Selecting the 'disabled' option deactivates the menu item for transactions and renders it unavailable for sale. Choosing this option takes precedence over other selections, such as the core menu item option and effectivity groups assigned to the master. miMasterOptions Option Bit = 5

  Example: false
• disableEditByWSEditMenuItem: boolean
  A flag indicating to prevent the menu item from appearing or being edited by OPS Function, Edit Menu Item. This prevents configuration changes to all definitions of the item. This option does not affect configuration of Menu Item Availability. miMasterOptions Option Bit = 2

  Example: false
• nonRevenue: boolean
  Select to enforce non-revenue menu items. Non-revenue menu items do not add value to the sales reports, but add value to the guest check. miMasterOptions Option Bit = 3

  Example: false

{
    "type":"object",
    "properties":{
        "disableEditByWSEditMenuItem":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating to prevent the menu item from appearing or being edited by OPS Function, Edit Menu Item. This prevents configuration changes to all definitions of the item.  This option does not affect configuration of Menu Item Availability. miMasterOptions Option Bit = 2"
        },
        "nonRevenue":{
            "type":"boolean",
            "example":false,
            "description":"Select to enforce non-revenue menu items. Non-revenue menu items do not add value to the sales reports, but add value to the guest check. miMasterOptions Option Bit = 3"
        },
        "core":{
            "type":"boolean",
            "example":false,
            "description":"Selecting the core option designates the menu item as a core item, ensuring it is always available for sale and cannot be disabled using effectivity groups. When this option is chosen, the effectivity group selection grid is disabled, and any previously selected effectivity groups are disregarded during the sales process. miMasterOptions Option Bit = 4"
        },
        "disabled":{
            "type":"boolean",
            "example":false,
            "description":"Selecting the 'disabled' option deactivates the menu item for transactions and renders it unavailable for sale. Choosing this option takes precedence over other selections, such as the core menu item option and effectivity groups assigned to the master. miMasterOptions Option Bit = 5"
        }
    }
}

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A string that contains translations into multiple languages",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee",
        "es-MX":"Cafe"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "es-MX":"Cafe"
}

Nested Schema : MenuItem_dataExtensions

Type: object

Show Source

• columnName: string
  Name of the extention field

  Example: extension column 1
• value: string
  Value of the extention field

  Example: value 1

{
    "type":"object",
    "properties":{
        "columnName":{
            "type":"string",
            "example":"extension column 1",
            "description":"Name of the extention field"
        },
        "value":{
            "type":"string",
            "example":"value 1",
            "description":"Value of the extention field"
        }
    }
}

Nested Schema : MenuItemMaster_dietaryLabels

Type: object

Show Source

• dietaryLabelName: string
  Name of the dietary label

  Example: Dietary Label 1

{
    "type":"object",
    "properties":{
        "dietaryLabelName":{
            "type":"string",
            "example":"Dietary Label 1",
            "description":"Name of the dietary label"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A response body for MenuItemMaster added

Body ()

Root Schema : menuItemMasterResponse

Type: object

Show Source

• hierUnitId(required): integer
  Unique hierarchy unit reference

  Example: 2
• menuItemMasterId(required): integer
  Unique menu item master reference

  Example: 1
• objectNum(required): integer
  Menu item master object number

  Example: 1

{
    "type":"object",
    "required":[
        "objectNum",
        "hierUnitId",
        "menuItemMasterId"
    ],
    "properties":{
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Menu item master object number"
        },
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "menuItemMasterId":{
            "type":"integer",
            "example":1,
            "description":"Unique menu item master reference"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

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

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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "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"
        }
    }
}

Back to Top