Get the collection of unavailable menu items
get
/api/v1/menus/items/unavailable
items/unavailable?orgShortName=tfoinc&locRef= fdmnh144& rvcRef=42
Get a menu item availability status for menu items.Request
Supported Media Types
- application/json
Query Parameters
-
LocRef(required): string
The location identifier. Will be forced to lower-case.
-
OrgShortName(required): string
The organization identifier. Will be forced to lower-case.
-
RvcRef(required): string
The revenue center identifier.
Header Parameters
-
If-None-Match: string
If-None-Match HTTP header
Response
Supported Media Types
- application/json
200 Response
A collection of menu items that are currently unavailable
Headers
-
ETag: string
The current entity-tag for the selected representation. See RFC 7232 Section 2.3
Nested Schema : OrgLocRvcProperties
Type:
object
A collection of properties for orgShortName, locRef and rvcRef
Show Source
-
locRef(required):
string
Location identifierExample:
store66
-
orgShortName(required):
string
Organization identifierExample:
mymeal
-
rvcRef(required):
integer
Revenue Center identifierExample:
2
304 Response
304 Not Modified
Headers
-
ETag: string
The current entity-tag for the selected representation. See RFC 7232 Section 2.3
400 Response
400 Bad Request
Root Schema : ConfigurationApiProblemDetails
Type:
object
Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807).
The content type for this response is `application/problem+json`
Show Source
-
details:
string
A human-readable explanation specific to this occurrence of the problem.Example:
The OrgShortName value is required.
-
instance:
string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.Example:
required_value_missing
-
title:
string
A short, human-readable summary of the problem type.Example:
Required value not specified.
-
type:
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
error:validation
Examples
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"orgShortName": "mymeal",
"locRef": "store66",
"rvcRef": 2,
"items": [
{
"menuItemId": 32,
"definitions": [
{
"definitionSequence": 1
}
]
}
]
}