Jump to

• Request
• Response

Get Menu Item Masters

post

/config/sim/v1/menuItems/getMenuItemMasters

Gets all the Menu Item Masters configured and hierarchy unit

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : MenuItemMastersGetRequestBody

Type: object

Show Source

• hierUnitId: integer
  Hierarchy unit unique reference

  Example: 1012
• include(optional): string
  Example: locations
• languages(optional): string
  If specified, limits translated strings returned.

  Example: en-US, es-SS,lt-LT
• limit(optional): integer
  Number of results returned in this page. Not required if paging parameters are not supported.

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

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

  Example: comboMealGroups.objectNum
• searchCriteria(optional): string
  Search criteria to filter results based on field value

  Example: where equals(active,1)

{
    "type":"object",
    "required":[
        "hierUnitId"
    ],
    "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":"comboMealGroups.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"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-SS,lt-LT",
            "description":"If specified, limits translated strings returned."
        },
        "hierUnitId":{
            "type":"integer",
            "example":1012,
            "description":"Hierarchy unit unique reference"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of menuItemMaster for the Hierarchy

Body ()

Root Schema : menuItemMaster

Type: object

Show Source

• dataExtensions(optional): array dataExtensions
  An array of data extensions for the menu item
• dietaryLabels(optional): array dietaryLabels
  An array of dietary labels for menu item
• familyGroupObjectNum(optional): integer
  Family group object number

  Example: 1
• hierUnitId: integer
  Unique hierarchy unit reference

  Example: 2
• majorGroupObjectNum(optional): integer
  Major group object number

  Example: 2
• masterGroupObjectNum(optional): integer
  Master group object number

  Example: 2
• menuItemMasterId: integer
  Unique menu item master reference

  Example: 1
• miMasterOptions(optional): string
  A string value of 0???s & 1???s representing the enabled or disabled options, default 000000.

  Example: 000000
• name(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• objectNum: integer
  Menu item master object number

  Example: 1
• reportGroupObjectNum(optional): integer
  Report group object number

  Example: 2

{
    "type":"object",
    "required":[
        "objectNum",
        "hierUnitId",
        "menuItemMasterId"
    ],
    "properties":{
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Menu item master object number"
        },
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "menuItemMasterId":{
            "type":"integer",
            "example":1,
            "description":"Unique menu item master reference"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString"
        },
        "familyGroupObjectNum":{
            "type":"integer",
            "example":1,
            "description":"Family group object number"
        },
        "majorGroupObjectNum":{
            "type":"integer",
            "example":2,
            "description":"Major group object number"
        },
        "masterGroupObjectNum":{
            "type":"integer",
            "example":2,
            "description":"Master group object number"
        },
        "reportGroupObjectNum":{
            "type":"integer",
            "example":2,
            "description":"Report group object number"
        },
        "miMasterOptions":{
            "type":"string",
            "example":"000000",
            "description":"A string value of 0???s & 1???s representing the enabled or disabled options, default 000000."
        },
        "dietaryLabels":{
            "type":"array",
            "description":"An array of dietary labels for menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_dietaryLabels"
            }
        },
        "dataExtensions":{
            "type":"array",
            "description":"An array of data extensions for the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_dataExtensions"
            }
        }
    }
}

Nested Schema : dataExtensions

Type: array

An array of data extensions for the menu item

Show Source

• Array of: object MenuItem_dataExtensions

{
    "type":"array",
    "description":"An array of data extensions for the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_dataExtensions"
    }
}

Nested Schema : dietaryLabels

Type: array

An array of dietary labels for menu item

Show Source

• Array of: object MenuItem_dietaryLabels

{
    "type":"array",
    "description":"An array of dietary labels for menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_dietaryLabels"
    }
}

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A string that contains translations into multiple languages\n\n**Example**\n`{ \"en-US\": \"coffee\", \"de-DE\": \"kaffee\", \"ar-AR\": \"????????\" }`\n",
    "type":"object",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee",
        "ar-AR":"????????"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "ar-AR":"????????"
}

Nested Schema : MenuItem_dataExtensions

Type: object

Show Source

• columnName(optional): string
  Name of the extention field

  Example: extension column 1
• value(optional): string
  Value of the extention field

  Example: value 1

{
    "type":"object",
    "properties":{
        "columnName":{
            "type":"string",
            "example":"extension column 1",
            "description":"Name of the extention field"
        },
        "value":{
            "type":"string",
            "example":"value 1",
            "description":"Value of the extention field"
        }
    }
}

Nested Schema : MenuItem_dietaryLabels

Type: object

Show Source

• dietaryLabelName(optional): string
  Name of the dietary label

  Example: Dietary Label 1
• dietaryLabelsObjNum(optional): integer
  Object number of the dietary label

  Example: 1

{
    "type":"object",
    "properties":{
        "dietaryLabelsObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the dietary label"
        },
        "dietaryLabelName":{
            "type":"string",
            "example":"Dietary Label 1",
            "description":"Name of the dietary label"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): 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",
    "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