Get Kitchen Theme Periods

post

/config/sim/v2/setup/getKitchenThemePeriods

Gets Kitchen Theme Periods.

Request

Supported Media Types
Body ()
The input body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • If specified, limits the data returned to these fields.
    Example: hierUnitId, objectNum, name, kitchenThemeObjNum, effectivity
  • 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
  • If specified, limits translated strings returned.
    Example: 263,302
  • If using paging, number of results returned in this page.
    Example: 100
  • Starting resource record index.
    Example: 0
  • Sorts the response by the specified field name and sort order. Allowed fields are hierUnitId, objectNum, name, and kitchenThemeObjNum.
    Example: objectNum:asc
  • If specified, returns records that match the criteria. Search criteria is supported for hierUnitId, objectNum, name, and kitchenThemeObjNum.
    Example: where equals(objectNum, 1)
Back to Top

Response

Supported Media Types

200 Response

A collection of Kitchen Theme Periods.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of Kitchen Theme Period objects.
Show Source
Nested Schema : items
Type: object
Kitchen Theme Period record.
Show Source
Nested Schema : effectivity
Type: object
Effectivity schedule for the Kitchen Theme Period.
Show Source
Nested Schema : name
Type: object
A group of string objects representing the name of the Kitchen Theme Period in configured languages.
Example:
{
    "263":"Lunch Theme Period",
    "302":"Periode theme dejeuner"
}
Nested Schema : recurrenceDayOfWeekExt
Type: object
An object containing the descriptive recurrence days of week.
Show Source
  • A boolean flag representing the 6th option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Friday.
    Example: true
  • A boolean flag representing the 2nd option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Monday.
    Example: true
  • A boolean flag representing the 7th option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Saturday.
    Example: true
  • A boolean flag representing the 1st option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Sunday.
    Example: true
  • A boolean flag representing the 5th option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Thursday.
    Example: true
  • A boolean flag representing the 3rd option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Tuesday.
    Example: true
  • A boolean flag representing the 4th option bit in recurrenceDayOfWeek, indicating the Kitchen Theme Period is active on Wednesday.
    Example: true
Back to Top