Configuration and Content API Guide

Get Allergen Names

post

/config/sim/v2/menuItems/getAllergenNames

Gets Allergen Names

Request

Supported Media Types

application/json
multipart/form-data

Root Schema : schema

Type: object

Show Source

include: string

If specified, limits the data returned to these fields.

Example: hierUnitId, allergenCode
includeAll: string

If this value is specified, the include parameter is ignored.

Value Description

basic Forces the response to include all fields except option string details

detailed Forces the response to include all fields including option string details

Example: detailed
langIds: string

If specified, limits translated strings returned

Example: 1,2,3
limit: integer

If using paging, number of results returned in this page.

Example: 100
offset: integer

Starting resource record index. Not required if paging parameters are not supported

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order. Allowed field is allergenCode.

Example: allergenCode:asc
searchCriteria: string

If specified, returns records that match the criteria. Allowed field is allergenCode.

Example: where equals(allergenCode, 'Beef')

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(allergenCode, 'Beef')",
            "description":"If specified, returns records that match the criteria. Allowed field is allergenCode."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, allergenCode",
            "description":"If specified, limits the data returned to these fields."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "langIds":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"1,2,3"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order. Allowed field is allergenCode.",
            "example":"allergenCode:asc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: object

Show Source

count: integer

Number of records returned on this page

Example: 10
hasMore: boolean

Indicates whether there are additional pages of records

Example: true
items: array items

Allergen Name records
limit: integer

The maximum number of records returned on a page

Example: 10
offset: integer

The page number of this data. Starts at 0.

Example: 0
totalResults: integer

Total number of records in the data set

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"Total number of records in the data set",
            "type":"integer",
            "example":100
        },
        "hasMore":{
            "description":"Indicates whether there are additional pages of records",
            "type":"boolean",
            "example":true
        },
        "count":{
            "description":"Number of records returned on this page",
            "type":"integer",
            "example":10
        },
        "offset":{
            "description":"The page number of this data. Starts at 0.",
            "type":"integer",
            "example":0
        },
        "limit":{
            "description":"The maximum number of records returned on a page",
            "type":"integer",
            "example":10
        },
        "items":{
            "description":"Allergen Name records",
            "type":"array",
            "items":{
                "$ref":"#/definitions/AllergenName"
            }
        }
    }
}

Nested Schema : items

Type: array

Allergen Name records

Show Source

Array of: object AllergenName

Allergen Name record

{
    "description":"Allergen Name records",
    "type":"array",
    "items":{
        "$ref":"#/definitions/AllergenName"
    }
}

Nested Schema : AllergenName

Type: object

Allergen Name record

Show Source

allergenCode: string

Allergen Code. It should be unique for any allergen.

Example: Apple
allergenId: integer

Allergen Id

Example: 364
hierUnitId: integer

Unique reference of the hierarchy unit where the allergen is configured.

Example: 3599
name: object name

Allergen Name

{
    "description":"Allergen Name record",
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the allergen is configured.",
            "type":"integer",
            "example":3599
        },
        "allergenId":{
            "description":"Allergen Id",
            "type":"integer",
            "example":364
        },
        "name":{
            "description":"Allergen Name",
            "type":"object",
            "example":{
                "1":"Apple",
                "2":"Pomme",
                "3":"Manzana"
            }
        },
        "allergenCode":{
            "description":"Allergen Code. It should be unique for any allergen.",
            "type":"string",
            "example":"Apple"
        }
    }
}

Nested Schema : name

Type: object

Allergen Name

Example:

{
    "1":"Apple",
    "2":"Pomme",
    "3":"Manzana"
}

Value	Description
basic	Forces the response to include all fields except option string details
detailed	Forces the response to include all fields including option string details