Get Serving Periods
post
/config/sim/v2/setup/getServingPeriods
Request
Supported Media Types
- application/json
- multipart/form-data
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
includeAll:
string
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 -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order. Allowed fields are hierUnitId, name and objectNum.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Allowed fields are hierUnitId, name and objectNum.Example:
where equals(hierUnitId, 1792)
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : schema
Type:
Show Source
object-
count:
integer
Number of records returned on this pageExample:
10 -
hasMore:
boolean
Indicates whether there are additional pages of recordsExample:
true -
items:
array items
Serving Period records
-
limit:
integer
The maximum number of records returned on a pageExample:
10 -
offset:
integer
The page number of this data. Starts at 0.Example:
0 -
totalResults:
integer
Total number of records in the data setExample:
100
Nested Schema : items
Type:
arrayServing Period records
Show Source
-
Array of:
object ServingPeriod
Serving Period record
Nested Schema : ServingPeriod
Type:
objectServing Period record
Show Source
-
activeDaysOfWeek:
string
A string of values 0s and 1s of length 7 representing the days of the week when the serving period is active, starting with Sunday.Example:
1111111 -
activeDaysOfWeekExt:
object activeDaysOfWeekExt
An object containing the descriptive active days of week.
-
dataExtensions:
array dataExtensions
An array of data extensions for the serving period
-
defaultMainLevel:
integer
The object number of the Default Main Level to use when the serving period is active. Valid range is [0-8].Example:
1 -
defaultSubLevel:
integer
The object number of the Default Sub Level to use when the serving period is active. Valid range is [0-8].Example:
1 -
endTime:
string
End time of the serving period in 24-hour HH:MM format.Example:
05:00 -
hierUnitId:
integer
Unique reference of the hierarchy unit where the serving period is configured.Example:
3599 -
name:
object name
Serving period name
-
objectNum:
integer
Object number of the serving period.Example:
1 -
startTime:
string
Start time of the serving period in 24-hour HH:MM format.Example:
03:00 -
tableCount:
integer
Determines the number of tables available during the serving period.Example:
12 -
taxesEnabled:
string
A string of values 0s and 1s of length 64 representing the tax rates used when the serving period is active.Example:
1000000000000000000000000000000000000000000000000000000000000001 -
taxesEnabledExt:
object taxesEnabledExt
An object containing the descriptive taxes enabled.
Nested Schema : activeDaysOfWeekExt
Type:
objectAn object containing the descriptive active days of week.
Show Source
-
activeOnFriday:
boolean
A boolean flag representing the 6th option bit in activeDaysOfWeek, indicating serving period as active on Friday.Example:
true -
activeOnMonday:
boolean
A boolean flag representing the 2nd option bit in activeDaysOfWeek, indicating serving period as active on Monday.Example:
true -
activeOnSaturday:
boolean
A boolean flag representing the 7th option bit in activeDaysOfWeek, indicating serving period as active on Saturday.Example:
true -
activeOnSunday:
boolean
A boolean flag representing the 1st option bit in activeDaysOfWeek, indicating serving period as active on Sunday.Example:
true -
activeOnThursday:
boolean
A boolean flag representing the 5th option bit in activeDaysOfWeek, indicating serving period as active on Thursday.Example:
true -
activeOnTuesday:
boolean
A boolean flag representing the 3rd option bit in activeDaysOfWeek, indicating serving period as active on Tuesday.Example:
true -
activeOnWednesday:
boolean
A boolean flag representing the 4th option bit in activeDaysOfWeek, indicating serving period as active on on Wednesday.Example:
true
Nested Schema : dataExtensions
Type:
arrayAn array of data extensions for the serving period
Show Source
Nested Schema : name
Type:
objectServing period name
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : taxesEnabledExt
Type:
objectAn object containing the descriptive taxes enabled.
Show Source
-
taxRate1:
boolean
A boolean flag indicating if the tax rate 1 is enabledExample:
false -
taxRate10:
boolean
A boolean flag indicating if the tax rate 10 is enabledExample:
false -
taxRate11:
boolean
A boolean flag indicating if the tax rate 11 is enabledExample:
false -
taxRate12:
boolean
A boolean flag indicating if the tax rate 12 is enabledExample:
false -
taxRate13:
boolean
A boolean flag indicating if the tax rate 13 is enabledExample:
false -
taxRate14:
boolean
A boolean flag indicating if the tax rate 14 is enabledExample:
false -
taxRate15:
boolean
A boolean flag indicating if the tax rate 15 is enabledExample:
false -
taxRate16:
boolean
A boolean flag indicating if the tax rate 16 is enabledExample:
false -
taxRate17:
boolean
A boolean flag indicating if the tax rate 17 is enabledExample:
false -
taxRate18:
boolean
A boolean flag indicating if the tax rate 18 is enabledExample:
false -
taxRate19:
boolean
A boolean flag indicating if the tax rate 19 is enabledExample:
false -
taxRate2:
boolean
A boolean flag indicating if the tax rate 2 is enabledExample:
false -
taxRate20:
boolean
A boolean flag indicating if the tax rate 20 is enabledExample:
false -
taxRate21:
boolean
A boolean flag indicating if the tax rate 21 is enabledExample:
false -
taxRate22:
boolean
A boolean flag indicating if the tax rate 22 is enabledExample:
false -
taxRate23:
boolean
A boolean flag indicating if the tax rate 23 is enabledExample:
false -
taxRate24:
boolean
A boolean flag indicating if the tax rate 24 is enabledExample:
false -
taxRate25:
boolean
A boolean flag indicating if the tax rate 25 is enabledExample:
false -
taxRate26:
boolean
A boolean flag indicating if the tax rate 26 is enabledExample:
false -
taxRate27:
boolean
A boolean flag indicating if the tax rate 27 is enabledExample:
false -
taxRate28:
boolean
A boolean flag indicating if the tax rate 28 is enabledExample:
false -
taxRate29:
boolean
A boolean flag indicating if the tax rate 29 is enabledExample:
false -
taxRate3:
boolean
A boolean flag indicating if the tax rate 3 is enabledExample:
false -
taxRate30:
boolean
A boolean flag indicating if the tax rate 30 is enabledExample:
false -
taxRate31:
boolean
A boolean flag indicating if the tax rate 31 is enabledExample:
false -
taxRate32:
boolean
A boolean flag indicating if the tax rate 32 is enabledExample:
false -
taxRate33:
boolean
A boolean flag indicating if the tax rate 33 is enabledExample:
false -
taxRate34:
boolean
A boolean flag indicating if the tax rate 34 is enabledExample:
false -
taxRate35:
boolean
A boolean flag indicating if the tax rate 35 is enabledExample:
false -
taxRate36:
boolean
A boolean flag indicating if the tax rate 36 is enabledExample:
false -
taxRate37:
boolean
A boolean flag indicating if the tax rate 37 is enabledExample:
false -
taxRate38:
boolean
A boolean flag indicating if the tax rate 38 is enabledExample:
false -
taxRate39:
boolean
A boolean flag indicating if the tax rate 39 is enabledExample:
false -
taxRate4:
boolean
A boolean flag indicating if the tax rate 4 is enabledExample:
false -
taxRate40:
boolean
A boolean flag indicating if the tax rate 40 is enabledExample:
false -
taxRate41:
boolean
A boolean flag indicating if the tax rate 41 is enabledExample:
false -
taxRate42:
boolean
A boolean flag indicating if the tax rate 42 is enabledExample:
false -
taxRate43:
boolean
A boolean flag indicating if the tax rate 43 is enabledExample:
false -
taxRate44:
boolean
A boolean flag indicating if the tax rate 44 is enabledExample:
false -
taxRate45:
boolean
A boolean flag indicating if the tax rate 45 is enabledExample:
false -
taxRate46:
boolean
A boolean flag indicating if the tax rate 46 is enabledExample:
false -
taxRate47:
boolean
A boolean flag indicating if the tax rate 47 is enabledExample:
false -
taxRate48:
boolean
A boolean flag indicating if the tax rate 48 is enabledExample:
false -
taxRate49:
boolean
A boolean flag indicating if the tax rate 49 is enabledExample:
false -
taxRate5:
boolean
A boolean flag indicating if the tax rate 5 is enabledExample:
false -
taxRate50:
boolean
A boolean flag indicating if the tax rate 50 is enabledExample:
false -
taxRate51:
boolean
A boolean flag indicating if the tax rate 51 is enabledExample:
false -
taxRate52:
boolean
A boolean flag indicating if the tax rate 52 is enabledExample:
false -
taxRate53:
boolean
A boolean flag indicating if the tax rate 53 is enabledExample:
false -
taxRate54:
boolean
A boolean flag indicating if the tax rate 54 is enabledExample:
false -
taxRate55:
boolean
A boolean flag indicating if the tax rate 55 is enabledExample:
false -
taxRate56:
boolean
A boolean flag indicating if the tax rate 56 is enabledExample:
false -
taxRate57:
boolean
A boolean flag indicating if the tax rate 57 is enabledExample:
false -
taxRate58:
boolean
A boolean flag indicating if the tax rate 58 is enabledExample:
false -
taxRate59:
boolean
A boolean flag indicating if the tax rate 59 is enabledExample:
false -
taxRate6:
boolean
A boolean flag indicating if the tax rate 6 is enabledExample:
false -
taxRate60:
boolean
A boolean flag indicating if the tax rate 60 is enabledExample:
false -
taxRate61:
boolean
A boolean flag indicating if the tax rate 61 is enabledExample:
false -
taxRate62:
boolean
A boolean flag indicating if the tax rate 62 is enabledExample:
false -
taxRate63:
boolean
A boolean flag indicating if the tax rate 63 is enabledExample:
false -
taxRate64:
boolean
A boolean flag indicating if the tax rate 64 is enabledExample:
false -
taxRate7:
boolean
A boolean flag indicating if the tax rate 7 is enabledExample:
false -
taxRate8:
boolean
A boolean flag indicating if the tax rate 8 is enabledExample:
false -
taxRate9:
boolean
A boolean flag indicating if the tax rate 9 is enabledExample:
false
Nested Schema : items
Type:
Show Source
object-
columnName:
string
Name of the extention fieldExample:
extension_Column -
value:
string
Value of the extension fieldExample:
value1