Jump to

• Request
• Response

Get Condiment Groups

post

/config/sim/v1/menuItems/getcondimentgroups

Gets a list of all the prices of a Condiment Groups for the specified organization

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

Request body

Root Schema : CondimentGroupGetRequestBody

Type: object

Show Source

• include: string
  Example: locations
• includeAll: string
  This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

  Example: detailed
• languages: string
  If specified, limits translated strings returned.

  Example: en-US, de-DE, es-MX
• limit: integer
  Number of results returned in this page. Not required if paging parameters are not supported.

  Example: 10
• offset: integer
  Starting resource record index. Not required if paging parameters are not supported

  Example: 2
• orderBy: string
  Sorts the response by the specified field name and sort order.

  Example: objectNum
• searchCriteria: string
  Search criteria to filter results based on field value

  Example: where equals(active,1)

{
    "type":"object",
    "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":"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"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, de-DE, es-MX",
            "description":"If specified, limits translated strings returned."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Condiment Group objects of the organization

Body ()

Root Schema : CondimentGroupGetResponse

Type: object

Model for Condiment Group Object

Show Source

• consumerDescription(required): object TranslatedString_Name
  Additional Properties Allowed: additionalProperties

  A group of translated names
• hierUnitId(required): integer
  Unique reference of the hierarchy unit

  Example: 1
• hierUnitName(required): object TranslatedString_HierUnitName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum(required): integer
  Object number of the hierarchy unit

  Example: 1
• name(required): object TranslatedString_Name
  Additional Properties Allowed: additionalProperties

  A group of translated names
• objectNum(required): integer
  Object number of the condiment Group

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "hierUnitObjNum",
        "hierUnitName",
        "objectNum",
        "name",
        "consumerDescription"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the hierarchy unit"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the hierarchy unit"
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedString_HierUnitName"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the condiment Group"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString_Name"
        },
        "consumerDescription":{
            "$ref":"#/definitions/TranslatedString_Name"
        }
    },
    "description":"Model for Condiment Group Object"
}

Nested Schema : TranslatedString_Name

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of translated names",
    "example":{
        "en-US":"Family Group 1",
        "de-DE":"Familiengruppe 1",
        "es-MX":"Grupo Familiar 1"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of translated names

Example:

{
    "en-US":"Family Group 1",
    "de-DE":"Familiengruppe 1",
    "es-MX":"Grupo Familiar 1"
}

Nested Schema : TranslatedString_HierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the name of the hierarchy unit configured languages",
    "type":"object",
    "example":{
        "en-US":"Enterprise",
        "de-DE":"Unternehmen",
        "es-MX":"Empresa"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

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

404 Response

404 Requested resource not found

Back to Top