Configuration and Content API Guide

Get Allergen Classes

post

/config/sim/v2/menuItems/getAllergenClasses

Gets all the Allergen Classes

Request

Supported Media Types

application/json
multipart/form-data

Allergen class get request body.

Root Schema : schema

Type: object

Show Source

include: string

If specified, limits the data returned to these fields.

Example: hierUnitId, objectNum, name
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 fields are objectNum, name and allergenCodes.

Example: objectNum:asc
searchCriteria: string

If specified, returns records that match the criteria. Allowed fields are objectNum, name and allergenCodes.

Example: where equals(objectNum, 2)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum, 2)",
            "description":"If specified, returns records that match the criteria. Allowed fields are objectNum, name and allergenCodes."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum, name",
            "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 fields are objectNum, name and allergenCodes.",
            "example":"objectNum:asc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of Allergen Classes.

Root Schema : schema

Type: object

Show Source

count: integer

Number of records returned on this page.

Example: 9
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: true
items: array items

Allergen Class records.
limit: integer

The maximum number of records returned on a page

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of records in the data set

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of records in the data set"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Number of records returned on this page."
        },
        "items":{
            "type":"array",
            "description":"Allergen Class records.",
            "items":{
                "$ref":"#/definitions/AllergenClass"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"The maximum number of records returned on a page"
        }
    }
}

Nested Schema : items

Type: array

Allergen Class records.

Show Source

Array of: object AllergenClass

Allergen Class record

{
    "type":"array",
    "description":"Allergen Class records.",
    "items":{
        "$ref":"#/definitions/AllergenClass"
    }
}

Nested Schema : AllergenClass

Type: object

Allergen Class record

Show Source

allergenCodes: string

Allergen codes listed as comma-separated values for an Allergen Class.

Example: Milk,Eggs,Fish
hierUnitId: integer

Hier Unit Id of the Enterprise.

Example: 7
name: object name

Name of the Allergen Class.
objectNum: integer

Object Number of the Allergen Class.

Example: 1

{
    "description":"Allergen Class record",
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Hier Unit Id of the Enterprise.",
            "type":"integer",
            "example":7
        },
        "objectNum":{
            "description":"Object Number of the Allergen Class.",
            "type":"integer",
            "example":1
        },
        "name":{
            "type":"object",
            "description":"Name of the Allergen Class.",
            "example":{
                "1":"Entp",
                "2":"AllergenClass",
                "3":"Emp"
            }
        },
        "allergenCodes":{
            "type":"string",
            "description":"Allergen codes listed as comma-separated values for an Allergen Class.",
            "example":"Milk,Eggs,Fish"
        }
    }
}

Nested Schema : name

Type: object

Name of the Allergen Class.

Example:

{
    "1":"Entp",
    "2":"AllergenClass",
    "3":"Emp"
}

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