Configuration and Content API Guide

Delete Menu Item Group Deatils

post

/config/sim/v2/menuItems/menuItemGroups/deleteDetails

Delete Menu Item Group Details

Request

Supported Media Types

application/json
multipart/form-data

Header Parameters

Simphony-AuditTrailRef: string

Detail that identifies, who made the change.

A Request body

Root Schema : MenuItemGroupDetailDeleteRequestBody

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. Value must lie between 1 and 32767.

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. Value must lie between 1 and 32767."
        },
        "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"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A message depicting the number of records deleted

Root Schema : DeleteResponse

Type: object

Show Source

msg(required): string

Example: 1 record deleted

{
    "type":"object",
    "required":[
        "msg"
    ],
    "properties":{
        "msg":{
            "type":"string",
            "example":"1 record deleted"
        }
    }
}

400 Response

400 Bad Request

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