Jump to

• Request
• Response

Add Combo Side Groups

post

/config/sim/v1/menuItems/combosidegroups

Add the Combo Meal group object to a specified hierarchy unit of specified organization.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.
• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Root Schema : ComboMealGroupResourceObject

Type: object

Show Source

• alternateGroups(optional): array alternateGroups
  An array of Alternate Groups, if any, for this Combo Meal Group.
• hierUnitId: integer
  Unique hierarchy unit reference

  Example: 2
• hierUnitName(optional): object TranslatedString_HierUnitName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum(optional): integer
  Object number of the hierarchy unit

  Example: 1
• items(optional): array items
  An array of items that are associated with the combo meal group
• name: object TranslatedString_ComboGroupName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the Combo Group in configured languages
• objectNum: integer
  Combo Meal object number

  Example: 1
• options(optional): string
  A string value of 0???s & 1???s representing enabled or disabled options

  Example: 00000000
• optionsExt(optional): object ComboMealGroup_OptionsExt
  An object containing the descriptive options list associated with the Combo Meal Group.

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the hierarchy unit"
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedString_HierUnitName"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Combo Meal object number"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString_ComboGroupName"
        },
        "options":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0???s & 1???s representing enabled or disabled options"
        },
        "optionsExt":{
            "$ref":"#/definitions/ComboMealGroup_OptionsExt"
        },
        "alternateGroups":{
            "type":"array",
            "description":"An array of Alternate Groups, if any, for this Combo Meal Group.",
            "items":{
                "$ref":"#/definitions/ComboMealGroup_AlternateGroup"
            }
        },
        "items":{
            "type":"array",
            "description":"An array of items that are associated with the combo meal group",
            "items":{
                "$ref":"#/definitions/ComboMealGroup_Items"
            }
        }
    }
}

Nested Schema : alternateGroups

Type: array

An array of Alternate Groups, if any, for this Combo Meal Group.

Show Source

• Array of: object ComboMealGroup_AlternateGroup

{
    "type":"array",
    "description":"An array of Alternate Groups, if any, for this Combo Meal Group.",
    "items":{
        "$ref":"#/definitions/ComboMealGroup_AlternateGroup"
    }
}

Nested Schema : TranslatedString_HierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of the hierarchy unit configured languages",
    "example":{
        "en-US":"Enterprise",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Nested Schema : items

Type: array

An array of items that are associated with the combo meal group

Show Source

• Array of: object ComboMealGroup_Items
  Model for Combo Meal Group_Item Object

{
    "type":"array",
    "description":"An array of items that are associated with the combo meal group",
    "items":{
        "$ref":"#/definitions/ComboMealGroup_Items"
    }
}

Nested Schema : TranslatedString_ComboGroupName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of the Combo Group in configured languages",
    "example":{
        "en-US":"Combo Group 1",
        "es-SS":"Combo Grupo 1"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the Combo Group in configured languages

Example:

{
    "en-US":"Combo Group 1",
    "es-SS":"Combo Grupo 1"
}

Nested Schema : ComboMealGroup_OptionsExt

Type: object

An object containing the descriptive options list associated with the Combo Meal Group.

Show Source

• allowDiscounts(optional): boolean
  Flag indicating to apply discounts to items in this group.

  Example: false
• substitutionGroupItemsUseThisSidesPrice(optional): boolean
  When substituting a Combo Meal side with a menu item from another group, Set this attribute to True to set the item's price to the side's combo meal price specified in the sides Combo Group Price.

  Example: false

{
    "type":"object",
    "properties":{
        "allowDiscounts":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating to apply discounts to items in this group."
        },
        "substitutionGroupItemsUseThisSidesPrice":{
            "type":"boolean",
            "example":false,
            "description":"When substituting a Combo Meal side with a menu item from another group, Set this attribute to True to set the item's price to the side's combo meal price specified in the sides Combo Group Price."
        }
    },
    "description":"An object containing the descriptive options list associated with the Combo Meal Group."
}

Nested Schema : ComboMealGroup_AlternateGroup

Type: object

Show Source

• alternateGroupObjNum(optional): integer
  Object number of the alternate combo meal group.

  Example: 2
• sequenceNum(optional): integer
  Sequence number of the alternate combo meal group.

  Example: 1

{
    "type":"object",
    "properties":{
        "sequenceNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the alternate combo meal group."
        },
        "alternateGroupObjNum":{
            "type":"integer",
            "example":2,
            "description":"Object number of the alternate combo meal group."
        }
    }
}

Nested Schema : ComboMealGroup_Items

Type: object

Model for Combo Meal Group_Item Object

Show Source

• menuItemMasterObjNum(optional): integer
  Object number of the Menu Item Master that contains the side items for the combo meal

  Example: 1
• options(optional): string
  A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup Item

  Example: 0000000000000000
• optionsExt(optional): object OptionsExt_ComboGroupItem
  An object containing the descriptive options list associated with the Combo Meal Group Item
• prices(optional): object Price_ComboGroupItem
  Model for Combo Group Item Price Object
• quantity(optional): integer
  Number of Combo Meal Group items required for the combo meal side

  Example: 1
• size1ComboGroupObjNum(optional): integer
  Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663).

  Example: 0
• size1MenuLevelIndex(optional): integer
  Menu Level index for using the Combo Size 1.

  Example: 0
• size2ComboGroupObjNum(optional): integer
  Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664).

  Example: 0
• size2MenuLevelIndex(optional): integer
  Menu Level index for using the Combo Size 2.

  Example: 0
• size3ComboGroupObjNum(optional): integer
  Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665).

  Example: 0
• size3MenuLevelIndex(optional): integer
  Menu Level index for using the Combo Size 3.

  Example: 0
• size4ComboGroupObjNum(optional): integer
  Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666).

  Example: 0
• size4MenuLevelIndex(optional): integer
  Menu Level index for using the Combo Size 4.

  Example: 0

{
    "type":"object",
    "properties":{
        "menuItemMasterObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the Menu Item Master that contains the side items for the combo meal"
        },
        "quantity":{
            "type":"integer",
            "example":1,
            "description":"Number of Combo Meal Group items required for the combo meal side"
        },
        "options":{
            "type":"string",
            "example":"0000000000000000",
            "description":"A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup Item"
        },
        "optionsExt":{
            "description":"An object containing the descriptive options list associated with the Combo Meal Group Item",
            "$ref":"#/definitions/OptionsExt_ComboGroupItem"
        },
        "size1ComboGroupObjNum":{
            "type":"integer",
            "example":0,
            "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663)."
        },
        "size2ComboGroupObjNum":{
            "type":"integer",
            "example":0,
            "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664)."
        },
        "size3ComboGroupObjNum":{
            "type":"integer",
            "example":0,
            "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665)."
        },
        "size4ComboGroupObjNum":{
            "type":"integer",
            "example":0,
            "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666)."
        },
        "size1MenuLevelIndex":{
            "type":"integer",
            "example":0,
            "description":"Menu Level index for using the Combo Size 1."
        },
        "size2MenuLevelIndex":{
            "type":"integer",
            "example":0,
            "description":"Menu Level index for using the Combo Size 2."
        },
        "size3MenuLevelIndex":{
            "type":"integer",
            "example":0,
            "description":"Menu Level index for using the Combo Size 3."
        },
        "size4MenuLevelIndex":{
            "type":"integer",
            "example":0,
            "description":"Menu Level index for using the Combo Size 4."
        },
        "prices":{
            "description":"An array of prices associated with the combo meal group items.",
            "$ref":"#/definitions/Price_ComboGroupItem"
        }
    },
    "description":"Model for Combo Meal Group_Item Object"
}

Nested Schema : OptionsExt_ComboGroupItem

Type: object

An object containing the descriptive options list associated with the Combo Meal Group Item

Show Source

• autofill(optional): boolean
  A flag indicating to change the side item quantity to the number of remaining items needed to complete the side requirements when ordering one of the combo meals where more than one remaining item is required.

  Example: false
• defaultForOrderType1(optional): boolean
  A flag indicating to make this item the default when Order Type 1 is active.

  Example: false
• defaultForOrderType2(optional): boolean
  A flag indicating to make this item the default when Order Type 2 is active.

  Example: false
• defaultForOrderType3(optional): boolean
  A flag indicating to make this item the default when Order Type 3 is active.

  Example: false
• defaultForOrderType4(optional): boolean
  A flag indicating to make this item the default when Order Type 4 is active.

  Example: false
• defaultForOrderType5(optional): boolean
  A flag indicating to make this item the default when Order Type 5 is active.

  Example: false
• defaultForOrderType6(optional): boolean
  A flag indicating to make this item the default when Order Type 6 is active.

  Example: false
• defaultForOrderType7(optional): boolean
  A flag indicating to make this item the default when Order Type 7 is active.

  Example: false
• defaultForOrderType8(optional): boolean
  A flag indicating to make this item the default when Order Type 8 is active.

  Example: false
• defaultWhenNoOrderTypeIsSelected(optional): boolean
  Flag indicating to make this item the default for the Combo Group without a declared Order Type.

  Example: false
• sendToComboParentsOrderDevices(optional): boolean
  A flag indicating to also send the combo side menu item to the combo meal parent menu item's Order Devices

  Example: false

{
    "type":"object",
    "properties":{
        "defaultWhenNoOrderTypeIsSelected":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating to make this item the default for the Combo Group without a declared Order Type."
        },
        "defaultForOrderType1":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating to make this item the default when Order Type 1 is active."
        },
        "defaultForOrderType2":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating to make this item the default when Order Type 2 is active."
        },
        "defaultForOrderType3":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating to make this item the default when Order Type 3 is active."
        },
        "defaultForOrderType4":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating to make this item the default when Order Type 4 is active."
        },
        "defaultForOrderType5":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating to make this item the default when Order Type 5 is active."
        },
        "defaultForOrderType6":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating to make this item the default when Order Type 6 is active."
        },
        "defaultForOrderType7":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating to make this item the default when Order Type 7 is active."
        },
        "defaultForOrderType8":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating to make this item the default when Order Type 8 is active."
        },
        "autofill":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating to change the side item quantity to the number of remaining items needed to complete the side requirements when ordering one of the combo meals where more than one remaining item is required."
        },
        "sendToComboParentsOrderDevices":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating to also send the combo side menu item to the combo meal parent menu item's Order Devices"
        }
    },
    "description":"An object containing the descriptive options list associated with the Combo Meal Group Item"
}

Nested Schema : Price_ComboGroupItem

Type: object

Model for Combo Group Item Price Object

Show Source

• activeOnLevel(optional): integer
  The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels

  Example: 0
• effectivityGroupObjNum(optional): integer
  Object number of the effectivity group associated with the price

  Example: 1
• prepcost(optional): number
  The ?? la carte price of the combo group side items. You can override the ?? la carte price for individual combo group items by setting an ?? la carte price for those items.

  Example: 0.89
• price(optional): number
  The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items

  Example: 1.23
• sequenceNum(optional): integer
  The sequence number of the price

  Example: 1

{
    "type":"object",
    "properties":{
        "sequenceNum":{
            "type":"integer",
            "example":1,
            "description":"The sequence number of the price"
        },
        "price":{
            "type":"number",
            "example":1.23,
            "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items"
        },
        "prepcost":{
            "type":"number",
            "example":0.89,
            "description":"The ?? la carte price of the combo group side items. You can override the ?? la carte price for individual combo group items by setting an ?? la carte price for those items."
        },
        "activeOnLevel":{
            "type":"integer",
            "example":0,
            "description":"The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels"
        },
        "effectivityGroupObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the effectivity group associated with the price"
        }
    },
    "description":"Model for Combo Group Item Price Object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A response body for Combo Meal Group

Body ()

Root Schema : ComboMealsGroupResponse

Type: object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• objectNum: integer
  Unique reference of the Combo Meal

  Example: 2

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "objectNum":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the Combo Meal"
        }
    }
}

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"
        }
    }
}

Back to Top