Simphony Transaction Services Gen2 API Guide

Get a summary of all available menus

get

/api/v1/menus/summary

{basePath}/menus/summary?orgShortName=tfoinc&locRef= fdmnh144& rvcRef=42

API returns a list of menu summaries for a location or revenue center in an organization.

Request

Supported Media Types

application/json

Query Parameters

LocRef: string

The location identifier.
OrgShortName(required): string

The organization identifier. Will be forced to lower-case.
RvcRef: string

The revenue center identifier.

Response

Supported Media Types

application/json

200 Response

A collection of menu summary items.

Root Schema : schema

Type: object

Show Source

items: array items

Array of Menu Summary objects. If there are no menus configured that meet the query parameters, this array will be empty.

{
    "type":"object",
    "properties":{
        "items":{
            "description":"Array of Menu Summary objects. If there are no menus configured that meet the query parameters, this array will be empty.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/MenuSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Array of Menu Summary objects. If there are no menus configured that meet the query parameters, this array will be empty.

Show Source

Array of: object MenuSummary

Summary details of a menu without its related items.

{
    "description":"Array of Menu Summary objects. If there are no menus configured that meet the query parameters, this array will be empty.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/MenuSummary"
    }
}

Nested Schema : MenuSummary

Type: object

Summary details of a menu without its related items.

Show Source

MenuSummaryProperties: object MenuSummaryProperties

{
    "description":"Summary details of a menu without its related items.\n",
    "type":"object",
    "properties":{
        "MenuSummaryProperties":{
            "$ref":"#/definitions/MenuSummaryProperties"
        }
    }
}

Nested Schema : MenuSummaryProperties

Type: object

Show Source

description: string

A description of the menu
menuId(required): string

Menu Identifier

Example: myb:store2:dining
name(required): string

Menu name

Example: 1
OrgLocRvcProperties: object OrgLocRvcProperties

A collection of properties for orgShortName, locRef and rvcRef

{
    "type":"object",
    "required":[
        "menuId",
        "name"
    ],
    "properties":{
        "OrgLocRvcProperties":{
            "$ref":"#/definitions/OrgLocRvcProperties"
        },
        "menuId":{
            "description":"Menu Identifier",
            "type":"string",
            "example":"myb:store2:dining"
        },
        "name":{
            "description":"Menu name",
            "type":"string",
            "example":"1"
        },
        "description":{
            "description":"A description of the menu",
            "type":"string"
        }
    }
}

Nested Schema : OrgLocRvcProperties

Type: object

A collection of properties for orgShortName, locRef and rvcRef

Show Source

locRef(required): string

Location identifier

Example: store66
orgShortName(required): string

Organization identifier

Example: mymeal
rvcRef(required): integer

Revenue Center identifier

Example: 2

{
    "description":"A collection of properties for orgShortName, locRef and rvcRef\n",
    "type":"object",
    "required":[
        "orgShortName",
        "locRef",
        "rvcRef"
    ],
    "properties":{
        "orgShortName":{
            "description":"Organization identifier",
            "type":"string",
            "example":"mymeal"
        },
        "locRef":{
            "description":"Location identifier",
            "type":"string",
            "example":"store66"
        },
        "rvcRef":{
            "description":"Revenue Center identifier",
            "type":"integer",
            "example":2
        }
    }
}

Examples

Example Request Body

Not applicable for this endpoint.

Example Response Body

The following example shows the contents of the response body in JSON format:


{
  "items": [
    {
      "orgShortName": "mymeal",
      "locRef": "store66",
      "rvcRef": 2,
      "menuId": "myb:store2:dining",
      "name": "1"
    }
  ]
}