Jump to

• Request
• Response

Add Condiment Groups

post

/config/sim/v1/menuItems/condimentgroups

Adds a Condiment Group

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

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

Body ()

CUD Request Body for Condiment Group object of the organization

Root Schema : CondimentGroupCUDRequestBody

Type: object

CUD Request Body for Condiment Group Object

Show Source

• consumerDescription: object consumerDescription
  Consumer Description
• hierUnitId(required): integer
  Unique reference of the hierarchy unit

  Example: 1
• name(required): object name
  Name
• objectNum(required): integer
  Object number of the condiment Group

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the hierarchy unit"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the condiment Group"
        },
        "name":{
            "type":"object",
            "description":"Name",
            "example":{
                "1":"Family Group 1",
                "2":"Familiengruppe 1",
                "3":"Grupo familiar 1"
            }
        },
        "consumerDescription":{
            "type":"object",
            "description":"Consumer Description",
            "example":{
                "1":"Family Group 1",
                "2":"Familiengruppe 1",
                "3":"Grupo familiar 1"
            }
        }
    },
    "description":"CUD Request Body for Condiment Group Object"
}

Nested Schema : consumerDescription

Type: object

Consumer Description

Example:

{
    "1":"Family Group 1",
    "2":"Familiengruppe 1",
    "3":"Grupo familiar 1"
}

Nested Schema : name

Type: object

Name

Example:

{
    "1":"Family Group 1",
    "2":"Familiengruppe 1",
    "3":"Grupo familiar 1"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Condiment Group Added

Body ()

Root Schema : CondimentGroupResponse

Type: object

Show Source

• hierUnitId: integer
  Unique reference of the hierarchy unit

  Example: 2
• objectNum: integer
  Object Number of the condiment group

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the hierarchy unit"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the condiment group"
        }
    }
}

Back to Top