Configuration and Content API Guide

Get Combo Meal Side Groups

post

/config/sim/v2/menuItems/comboMeals/getMealSideGroups

Gets all the Combo Meal sides of a combo meal for the specified organization

Request

Supported Media Types

application/json
multipart/form-data

request body for Combo Meals

Root Schema : schema

Type: object

Show Source

comboMealObjNum(required): integer

Unique reference of the Combo Meal

Example: 2
hierUnitId(required): integer

Unique hierarchy unit value

Example: 1
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",
    "required":[
        "hierUnitId",
        "comboMealObjNum"
    ],
    "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"
        },
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "comboMealObjNum":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the Combo Meal"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Combo Meal Side Groups.

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 Meal Side objects of the organization.
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 Meal Side objects of the organization.",
            "items":{
                "$ref":"#/definitions/ComboMealSideResourceObjectv2"
            }
        },
        "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 Meal Side objects of the organization.

Show Source

Array of: object ComboMealSideResourceObjectv2

{
    "type":"array",
    "description":"Array of Combo Meal Side objects of the organization.",
    "items":{
        "$ref":"#/definitions/ComboMealSideResourceObjectv2"
    }
}

Nested Schema : ComboMealSideResourceObjectv2

Type: object

Show Source

comboGrpObjNum: integer

Object number of the Side Item Group that contains the side items for the combo meal.

Example: 1
comboMealObjNum: integer

Combo Meal object number

Example: 1
defaultMenuLevelIndex: integer

Index of the default menu level for this combo group.

Example: 1
hierUnitId: integer

Unique hierarchy unit reference

Example: 2
hierUnitObjNum: integer

Object number of the hierarchy unit

Example: 1
menuLevel: string

A string value of 0s & 1s of length 8 representing the configured menu levels that are available for ordering with this combo group

Example: 11001111
menuLevelExt: object ComboMeals_MenuLevelExt

An object containing the descriptive list of menu levels associated with the Combo Meal
sideCount: integer

Number of Combo Meal Group items required for the combo meal side.

Example: 1
sideNum: integer

Sequence number of the side.

Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the hierarchy unit"
        },
        "comboMealObjNum":{
            "type":"integer",
            "example":1,
            "description":"Combo Meal object number"
        },
        "sideNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the side."
        },
        "comboGrpObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the Side Item Group that contains the side items for the combo meal."
        },
        "sideCount":{
            "type":"integer",
            "example":1,
            "description":"Number of Combo Meal Group items required for the combo meal side."
        },
        "defaultMenuLevelIndex":{
            "type":"integer",
            "example":1,
            "description":"Index of the default menu level for this combo group."
        },
        "menuLevel":{
            "type":"string",
            "example":"11001111",
            "description":"A string value of 0s & 1s of length 8 representing the configured menu levels that are available for ordering with this combo group"
        },
        "menuLevelExt":{
            "$ref":"#/definitions/ComboMeals_MenuLevelExt"
        }
    }
}

Nested Schema : ComboMeals_MenuLevelExt

Type: object

An object containing the descriptive list of menu levels associated with the Combo Meal

Show Source

menuLevel1: boolean

A flag indicating if the combo meal is associated with Menu Level 1

Example: true
menuLevel2: boolean

A flag indicating if the combo meal is associated with Menu Level 2

Example: false
menuLevel3: boolean

A flag indicating if the combo meal is associated with Menu Level 3

Example: true
menuLevel4: boolean

A flag indicating if the combo meal is associated with Menu Level 4

Example: false
menuLevel5: boolean

A flag indicating if the combo meal is associated with Menu Level 5

Example: true
menuLevel6: boolean

A flag indicating if the combo meal is associated with Menu Level 6

Example: false
menuLevel7: boolean

A flag indicating if the combo meal is associated with Menu Level 7

Example: true
menuLevel8: boolean

A flag indicating if the combo meal is associated with Menu Level 8

Example: true

{
    "type":"object",
    "description":"An object containing the descriptive list of menu levels associated with the Combo Meal",
    "properties":{
        "menuLevel1":{
            "type":"boolean",
            "example":true,
            "description":"A flag indicating if the combo meal is associated with Menu Level 1"
        },
        "menuLevel2":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating if the combo meal is associated with Menu Level 2"
        },
        "menuLevel3":{
            "type":"boolean",
            "example":true,
            "description":"A flag indicating if the combo meal is associated with Menu Level 3"
        },
        "menuLevel4":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating if the combo meal is associated with Menu Level 4"
        },
        "menuLevel5":{
            "type":"boolean",
            "example":true,
            "description":"A flag indicating if the combo meal is associated with Menu Level 5"
        },
        "menuLevel6":{
            "type":"boolean",
            "example":false,
            "description":"A flag indicating if the combo meal is associated with Menu Level 6"
        },
        "menuLevel7":{
            "type":"boolean",
            "example":true,
            "description":"A flag indicating if the combo meal is associated with Menu Level 7"
        },
        "menuLevel8":{
            "type":"boolean",
            "example":true,
            "description":"A flag indicating if the combo meal is associated with Menu Level 8"
        }
    }
}

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