Jump to

• Request
• Response

Update Menu Item Group Details

post

/config/sim/v1/menuItems/MenuItemGroups/updateDetails

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

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

Body ()

A Request body for Menu Item Group

Root Schema : MenuItemGroupDetailCURequestBody

Type: object

Show Source

• endObjNum: integer
  Ending object number for the selected type

  Example: 100
• exclude(required): boolean
  Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active

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

  Example: 2
• menuItemGroupObjNum(required): integer
  Menu item group object number

  Example: 1
• overridePricePercent: number
  Indicates the amount off, percent off, or amount substitution based on the discount configuration. This is only active for Group Type 1- Discount when exclude is set to false.

  Example: 10.5
• seq(required): integer
  Sequence number of the Menu Item Group Detail entry

  Example: 1
• startObjNum: integer
  Starting object number for the selected type

  Example: 1
• type: integer
  Group type to include or exclude for the Menu Item Group Detail entry **Below is a list of accetable values for this field** | # | Type Description| |---------------|-----------------| | 0 | None | | 1 | All | | 2 | By Major Group | | 3 | By Family Group | | 4 | By Menu Item |

  Example: 1

{
    "type":"object",
    "required":[
        "menuItemGroupObjNum",
        "hierUnitId",
        "seq",
        "exclude"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "menuItemGroupObjNum":{
            "type":"integer",
            "example":1,
            "description":"Menu item group object number"
        },
        "seq":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the Menu Item Group Detail entry"
        },
        "type":{
            "type":"integer",
            "example":1,
            "description":"Group type to include or exclude for the Menu Item Group Detail entry\n\n**Below is a list of accetable values for this field**\n|   #           | Type Description|\n|---------------|-----------------|\n|   0           | None            |\n|   1           | All             |\n|   2           | By Major Group  |\n|   3           | By Family Group |\n|   4           | By Menu Item    |\n"
        },
        "exclude":{
            "type":"boolean",
            "example":false,
            "description":"Identifies which  menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active"
        },
        "startObjNum":{
            "type":"integer",
            "example":1,
            "description":"Starting object number for the selected type"
        },
        "endObjNum":{
            "type":"integer",
            "example":100,
            "description":"Ending object number for the selected type"
        },
        "overridePricePercent":{
            "type":"number",
            "example":10.5,
            "description":"Indicates the amount off, percent off, or amount substitution based on the discount configuration. This is only active for Group Type 1- Discount when exclude is set to false."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A response body for the updated Menu Item Group

Body ()

Root Schema : MenuItemGroupDetailUpdateResponse

Type: object

Show Source

• exclude(required): boolean
  Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active

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

  Example: 2
• menuItemGroupObjNum(required): integer
  Menu item group object number

  Example: 1
• seq(required): integer
  Sequence number of the Menu Item Group Detail entry

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "menuItemGroupObjNum",
        "seq",
        "exclude"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "menuItemGroupObjNum":{
            "type":"integer",
            "example":1,
            "description":"Menu item group object number"
        },
        "seq":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the Menu Item Group Detail entry"
        },
        "exclude":{
            "type":"boolean",
            "example":false,
            "description":"Identifies which  menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active"
        }
    }
}

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