Jump to

• Request
• Response
• Examples

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.
• orgShortName(required): string
  The organization identifier.
• rvcRef(required): integer
  The revenue center identifier.

Header Parameters

• If-None-Match: string
  Standard http caching header (http caching link).

Back to Top

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

Body ()

Root Schema : MenuItemsUnavailable

Type: object

A collection of unavailable menu items.

Show Source

• items: array items
  Array of items.
• OrgLocRvcProperties: object OrgLocRvcProperties
  A collection of properties for orgShortName, locRef and rvcRef

{
    "description":"A collection of unavailable menu items.\n",
    "type":"object",
    "properties":{
        "OrgLocRvcProperties":{
            "$ref":"#/definitions/OrgLocRvcProperties"
        },
        "items":{
            "description":"Array of items.\n",
            "type":"array",
            "items":{
                "properties":{
                    "menuItemId":{
                        "description":"Menu Item Identifier",
                        "type":"integer",
                        "example":"32"
                    },
                    "definitions":{
                        "description":"Array of definitions.\n",
                        "type":"array",
                        "items":{
                            "properties":{
                                "definitionSequence":{
                                    "description":"The number of the definition.\n",
                                    "type":"integer",
                                    "example":"1"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Array of items.

Show Source

• Array of: object items

{
    "description":"Array of items.\n",
    "type":"array",
    "items":{
        "properties":{
            "menuItemId":{
                "description":"Menu Item Identifier",
                "type":"integer",
                "example":"32"
            },
            "definitions":{
                "description":"Array of definitions.\n",
                "type":"array",
                "items":{
                    "properties":{
                        "definitionSequence":{
                            "description":"The number of the definition.\n",
                            "type":"integer",
                            "example":"1"
                        }
                    }
                }
            }
        }
    }
}

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"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• definitions: array definitions
  Array of definitions.
• menuItemId: integer
  Menu Item Identifier

  Example: 32

{
    "properties":{
        "menuItemId":{
            "description":"Menu Item Identifier",
            "type":"integer",
            "example":"32"
        },
        "definitions":{
            "description":"Array of definitions.\n",
            "type":"array",
            "items":{
                "properties":{
                    "definitionSequence":{
                        "description":"The number of the definition.\n",
                        "type":"integer",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : definitions

Type: array

Array of definitions.

Show Source

• Array of: object items

{
    "description":"Array of definitions.\n",
    "type":"array",
    "items":{
        "properties":{
            "definitionSequence":{
                "description":"The number of the definition.\n",
                "type":"integer",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• definitionSequence: integer
  The number of the definition.

  Example: 1

{
    "properties":{
        "definitionSequence":{
            "description":"The number of the definition.\n",
            "type":"integer",
            "example":"1"
        }
    }
}

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

Body ()

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

{
    "description":"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).\n\nThe content type for this response is `application/problem+json`\n",
    "type":"object",
    "example":{
        "type":"error:validation",
        "title":"Required value not specified.",
        "details":"The OrgShortName value is required.",
        "instance":"required_value_missing"
    },
    "properties":{
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".\n",
            "type":"string",
            "example":"error:validation"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.\n",
            "type":"string",
            "example":"Required value not specified.\n"
        },
        "details":{
            "description":"A human-readable explanation specific to this occurrence of the problem.\n",
            "type":"string",
            "example":"The OrgShortName value is required.\n"
        },
        "instance":{
            "description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n",
            "type":"string",
            "example":"required_value_missing"
        }
    }
}

Example:

{
    "type":"error:validation",
    "title":"Required value not specified.",
    "details":"The OrgShortName value is required.",
    "instance":"required_value_missing"
}

Back to Top

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
        }
      ]
    }
  ]
}

Back to Top