Configuration and Content API Guide

Get Combo Side Groups Lite

post

/config/sim/v2/menuItems/getComboSideGroupsLite

Gets all the Combo Side Groups

Request

Supported Media Types

application/json
multipart/form-data

Get Request body

Root Schema : schema

Type: object

Show Source

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 returned

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

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

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(hierUnitId, 7)",
            "description":"If specified, returns records that match the criteria."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum, name",
            "description":"If specified, limits the data returned to these fields."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "langIds":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"1,2,3"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"hierUnitId:asc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: object

Show Source

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 Combo Side Groups
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Combo Side Groups",
            "items":{
                "$ref":"#/definitions/ComboSideGroupsLite"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Combo Side Groups

Show Source

Array of: object ComboSideGroupsLite

{
    "type":"array",
    "description":"Array of Combo Side Groups",
    "items":{
        "$ref":"#/definitions/ComboSideGroupsLite"
    }
}

Nested Schema : ComboSideGroupsLite

Type: object

Show Source

alternateGroups: array alternateGroups

An array of alternate groups associated with combo side group.
comboMealGroupId: integer

Unique ID of combo side group.

Example: 2
hierUnitId: integer

Unique hierarchy unit value.

Example: 2
name: object name

Name of the combo side group.
objectNum: integer

Object number of the combo side group.

Example: 1
options: string

A string value of 0s & 1s of length 8 representing enabled or disabled options

Example: 00000000
optionsExt: object optionsExt

An object containing the descriptive options list associated with the combo side group.

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit value."
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the combo side group."
        },
        "comboMealGroupId":{
            "type":"integer",
            "example":2,
            "description":"Unique ID of combo side group."
        },
        "name":{
            "type":"object",
            "description":"Name of the combo side group.",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "options":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options"
        },
        "optionsExt":{
            "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 side group."
        },
        "alternateGroups":{
            "type":"array",
            "description":"An array of alternate groups associated with combo side group.",
            "items":{
                "type":"object",
                "properties":{
                    "sequenceNum":{
                        "type":"integer",
                        "example":1,
                        "description":"Sequence number of the alternate combo side group."
                    },
                    "alternateGroupObjNum":{
                        "type":"integer",
                        "example":2,
                        "description":"Object number of the alternate combo side group."
                    }
                }
            }
        }
    }
}

Nested Schema : alternateGroups

Type: array

An array of alternate groups associated with combo side group.

Show Source

Array of: object items

{
    "type":"array",
    "description":"An array of alternate groups associated with combo side group.",
    "items":{
        "type":"object",
        "properties":{
            "sequenceNum":{
                "type":"integer",
                "example":1,
                "description":"Sequence number of the alternate combo side group."
            },
            "alternateGroupObjNum":{
                "type":"integer",
                "example":2,
                "description":"Object number of the alternate combo side group."
            }
        }
    }
}

Nested Schema : name

Type: object

Name of the combo side group.

Example:

{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}

Nested Schema : optionsExt

Type: object

An object containing the descriptive options list associated with the combo side group.

Show Source

allowDiscounts: boolean

Flag indicating to apply discounts to items in this group.

Example: false
substitutionGroupItemsUseThisSidesPrice: 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 side group."
}

Nested Schema : items

Type: object

Show Source

alternateGroupObjNum: integer

Object number of the alternate combo side group.

Example: 2
sequenceNum: integer

Sequence number of the alternate combo side group.

Example: 1

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

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