Jump to

• Request
• Response

Get Combo Meal Side Groups

post

/config/sim/v1/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

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

A request body

Root Schema : ComboMealSideGetRequestBody

Type: object

Show Source

• comboMealObjNum: integer
  Unique reference of the Combo Meal

  Example: 2
• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• 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: comboMealSides.objectNum
• searchCriteria(optional): string
  Search criteria to filter results based on field value

  Example: where equals(active,1)

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

Body ()

Root Schema : ComboMealSideGetResponse

Type: object

Show Source

• count(optional): integer
  Current response recount count.

  Example: 9
• hasMore(optional): boolean
  Flag indicating if there are more objects to fetch.

  Example: true
• items(optional): array items
  Array of Combo Meal Side objects of the organization.
• limit(optional): integer
  Server page size

  Example: 10
• offset(optional): integer
  Starting resource record index

  Example: 0
• totalResults(optional): 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 recount count."
        },
        "items":{
            "type":"array",
            "description":"Array of Combo Meal Side objects of the organization.",
            "items":{
                "$ref":"#/definitions/ComboMealSideResourceObject"
            }
        },
        "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 ComboMealSideResourceObject

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

Nested Schema : ComboMealSideResourceObject

Type: object

Show Source

• comboGroupName(optional): object TranslatedString_ComboGroupName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the Combo Group in configured languages
• 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(optional): integer
  Index of the default menu level for this combo group.

  Example: 1
• 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
• menuLevel(optional): string
  A string value of 0???s & 1???s representing the configured menu levels that are available for ordering with this combo group

  Example: 11001111
• menuLevelExt(optional): object ComboMeals_MenuLevelExt
  An object containing the descriptive list of menu levels associated with the Combo Meal
• sideCount(optional): 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",
    "required":[
        "hierUnitId",
        "comboMealObjNum",
        "sideNum",
        "comboGrpObjNum"
    ],
    "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"
        },
        "comboMealObjNum":{
            "type":"integer",
            "example":1,
            "description":"Combo Meal object number"
        },
        "comboGroupName":{
            "$ref":"#/definitions/TranslatedString_ComboGroupName"
        },
        "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 0???s & 1???s representing the configured menu levels that are available for ordering with this combo group"
        },
        "menuLevelExt":{
            "$ref":"#/definitions/ComboMeals_MenuLevelExt"
        }
    }
}

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

Type: object

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

Show Source

• menuLevel1(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 1

  Example: true
• menuLevel2(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 2

  Example: false
• menuLevel3(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 3

  Example: true
• menuLevel4(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 4

  Example: false
• menuLevel5(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 5

  Example: true
• menuLevel6(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 6

  Example: false
• menuLevel7(optional): boolean
  A flag indicating if the combo meal is associated with Menu Level 7

  Example: true
• menuLevel8(optional): 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"
        }
    }
}

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