Get Zones2
post
/config/sim/v2/hierarchy/getZones2
Gets a list of Zones2
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
hierUnitId:
integer
Integer to filter results based on hierUnitId.Example:
12 -
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, hierStrucId, parentHierUnitId, parentHierStrucId.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Allowed fields are hierUnitId, name, hierStrucId, parentHierUnitId, parentHierStrucId.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A Collection of Zones
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Zone2 objects.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Zone2 objects.
Show Source
-
Array of:
object Zone2
Model for a Zone
Nested Schema : Zone2
Type:
objectModel for a Zone
Show Source
-
EMCModules:
array EMCModules
List of enabled EMC modules at the zone
Module Name Value AllModules 1 AlphanumericKeyboard 2143 ApplicationText 2138 AutoMenuLevels 1150 AutofireCheckOfflineHeader 2646 BarcodeFormatStatus 1131 Barcodes 2104 Browser 2657 CanadianGST 1146 CanadianPST 1147 CanadianTaxTrailers 2618 CMAccount 6005 CMCashCountThreshold 6011 CMCashPullThreashold 6007 CMClass 6003 CMClassBehavior 6012 CMCountSheet 6002 CMPARLevel 6008 CMParameters 6010 CMReason 6009 CMReceptacle 6004 CMTemplate 6001 CMVendor 6006 CheckAlert 2643 CheckSummaryDescriptors 2602 ComboMealGroups 2123 ComboMeals 2122 Components 2158 CondimentGroupNames 2627 CondimentSets 2128 Content 2126 ControlParameters 1148 CheckHeaderOrderTypeChannel 7110 CheckTrailerOrderTypeChannel 7111 CreditCardHeader 2616 CreditCardTrailers 2617 Currency 1113 CurrencyAvailability 1144 CurrencyConversion 1142 CurrencyParameters 1145 CustomReport 2137 CustomerReceiptHeaders 2614 DataExtensions 2129 DiningTableClass 2140 DiningTableStatusDefSet 2141 DiscountGroups 2609 DiscountItemizers 2624 DiscountSLUNames 2629 Discounts 1120 EffectivityGroups 131 ExtentionApplication 2139 FormatParamters 1143 GiftCardProvider 1175 GuestCheckHeaders 2612 GuestCheckTrailers 2613 GuestInformationPrompts 2603 KDSBumpBars 1129 KDSHighlightSchemes 1137 KDSToolBars 1130 KDSDiningCourse 2641 LoanReasons 2606 LoyaltyConfig 1157 LoyaltyCardProvider 1176 LoyaltyDriver 1160 LoyaltyModule 1159 MenuItemClasses 2101 MenuItemDefinitions 2102 MenuItemGroups 1133 MenuItemMasterGroupSLUNames 2652 MenuItemMasterGroups 1138 MenuItemMasters 1123 MenuItemPrices 2103 MenuItemSLUNames 2631 MenuLevelSets 2127 NLUNames 2623 Operators 2100 OrderChannelParameters 7107 OrderTypeParameters 1141 OrderTypes 2622 Pages 2124 PageAssignment 2135 PageTemplate 2125 PaymentDevice 1164 PaymentDriver 1161 PaymentReasons 2605 Payments 1155 PickupReasons 2607 POSKeyboard 2655 PriceGroups 124 PrintClasses 2146 ProductionItem 2150 PropertyEmployeeRecords 1101 ReceiptHeaderOrderTypeChannel 7113 ReportGroups 120 ReportHeaders 7103 ReportTrailers 7104 ReportParameters 1149 RoutingGroups 2639 RVCTypeNames 2610 SalesItemizers 2625 SeatingSectionTemplate 2147 Section 2148 ServiceAlert 2642 ServiceChargeGroup 7002 ServiceChargeItemizers 2626 ServiceChargeSLUNames 2633 ServiceCharges 1121 ServiceTotalReasons 2608 StoredValueConfiguration 1158 StoredValueDriver 1163 StoredValueModule 1162 SystemTemplate 2136 TaskSchedules 133 TaxClasses 1118 TaxParameters 1139 TaxRates 1117 TenderMedia 1119 TenderParameters 1140 TenderMediaSLUNames 2635 ThemeAssignment 2156 TimeClockReasons 2621 TMSParameters 2149 TMSreaons 2644 TMSTableAttributes 2155 TrainingHeaders 2615 VoidReturnWasteReaon 2649 WaitQuoteConfiguration 2645 WasteReceiptHeaders 2647 WasteReceiptTrailers 2648 -
hierStrucId:
integer
Hierarchy Structuture Id of the Zone. Excluded by default.Example:
1 -
hierUnitId:
integer
Hierarchy Unit Id of the ZoneExample:
1 -
name:
object name
Zone Name
-
options:
string
A string value of 0s & 1s of length 16 representing the status of OptionsExample:
0001000000000000 -
optionsExt:
object ZoneOptions
Details of Options
-
parentHierStrucId:
integer
Hierarchy Structuture Id of the Parent. Excluded by default.Example:
1 -
parentHierUnitId:
integer
Hierarchy Unit Id of the ParentExample:
1 -
zoneType:
integer
Type of ZoneExample:
1
Nested Schema : EMCModules
Type:
arrayList of enabled EMC modules at the zone
| Module Name | Value |
|---|---|
| AllModules | 1 |
| AlphanumericKeyboard | 2143 |
| ApplicationText | 2138 |
| AutoMenuLevels | 1150 |
| AutofireCheckOfflineHeader | 2646 |
| BarcodeFormatStatus | 1131 |
| Barcodes | 2104 |
| Browser | 2657 |
| CanadianGST | 1146 |
| CanadianPST | 1147 |
| CanadianTaxTrailers | 2618 |
| CMAccount | 6005 |
| CMCashCountThreshold | 6011 |
| CMCashPullThreashold | 6007 |
| CMClass | 6003 |
| CMClassBehavior | 6012 |
| CMCountSheet | 6002 |
| CMPARLevel | 6008 |
| CMParameters | 6010 |
| CMReason | 6009 |
| CMReceptacle | 6004 |
| CMTemplate | 6001 |
| CMVendor | 6006 |
| CheckAlert | 2643 |
| CheckSummaryDescriptors | 2602 |
| ComboMealGroups | 2123 |
| ComboMeals | 2122 |
| Components | 2158 |
| CondimentGroupNames | 2627 |
| CondimentSets | 2128 |
| Content | 2126 |
| ControlParameters | 1148 |
| CheckHeaderOrderTypeChannel | 7110 |
| CheckTrailerOrderTypeChannel | 7111 |
| CreditCardHeader | 2616 |
| CreditCardTrailers | 2617 |
| Currency | 1113 |
| CurrencyAvailability | 1144 |
| CurrencyConversion | 1142 |
| CurrencyParameters | 1145 |
| CustomReport | 2137 |
| CustomerReceiptHeaders | 2614 |
| DataExtensions | 2129 |
| DiningTableClass | 2140 |
| DiningTableStatusDefSet | 2141 |
| DiscountGroups | 2609 |
| DiscountItemizers | 2624 |
| DiscountSLUNames | 2629 |
| Discounts | 1120 |
| EffectivityGroups | 131 |
| ExtentionApplication | 2139 |
| FormatParamters | 1143 |
| GiftCardProvider | 1175 |
| GuestCheckHeaders | 2612 |
| GuestCheckTrailers | 2613 |
| GuestInformationPrompts | 2603 |
| KDSBumpBars | 1129 |
| KDSHighlightSchemes | 1137 |
| KDSToolBars | 1130 |
| KDSDiningCourse | 2641 |
| LoanReasons | 2606 |
| LoyaltyConfig | 1157 |
| LoyaltyCardProvider | 1176 |
| LoyaltyDriver | 1160 |
| LoyaltyModule | 1159 |
| MenuItemClasses | 2101 |
| MenuItemDefinitions | 2102 |
| MenuItemGroups | 1133 |
| MenuItemMasterGroupSLUNames | 2652 |
| MenuItemMasterGroups | 1138 |
| MenuItemMasters | 1123 |
| MenuItemPrices | 2103 |
| MenuItemSLUNames | 2631 |
| MenuLevelSets | 2127 |
| NLUNames | 2623 |
| Operators | 2100 |
| OrderChannelParameters | 7107 |
| OrderTypeParameters | 1141 |
| OrderTypes | 2622 |
| Pages | 2124 |
| PageAssignment | 2135 |
| PageTemplate | 2125 |
| PaymentDevice | 1164 |
| PaymentDriver | 1161 |
| PaymentReasons | 2605 |
| Payments | 1155 |
| PickupReasons | 2607 |
| POSKeyboard | 2655 |
| PriceGroups | 124 |
| PrintClasses | 2146 |
| ProductionItem | 2150 |
| PropertyEmployeeRecords | 1101 |
| ReceiptHeaderOrderTypeChannel | 7113 |
| ReportGroups | 120 |
| ReportHeaders | 7103 |
| ReportTrailers | 7104 |
| ReportParameters | 1149 |
| RoutingGroups | 2639 |
| RVCTypeNames | 2610 |
| SalesItemizers | 2625 |
| SeatingSectionTemplate | 2147 |
| Section | 2148 |
| ServiceAlert | 2642 |
| ServiceChargeGroup | 7002 |
| ServiceChargeItemizers | 2626 |
| ServiceChargeSLUNames | 2633 |
| ServiceCharges | 1121 |
| ServiceTotalReasons | 2608 |
| StoredValueConfiguration | 1158 |
| StoredValueDriver | 1163 |
| StoredValueModule | 1162 |
| SystemTemplate | 2136 |
| TaskSchedules | 133 |
| TaxClasses | 1118 |
| TaxParameters | 1139 |
| TaxRates | 1117 |
| TenderMedia | 1119 |
| TenderParameters | 1140 |
| TenderMediaSLUNames | 2635 |
| ThemeAssignment | 2156 |
| TimeClockReasons | 2621 |
| TMSParameters | 2149 |
| TMSreaons | 2644 |
| TMSTableAttributes | 2155 |
| TrainingHeaders | 2615 |
| VoidReturnWasteReaon | 2649 |
| WaitQuoteConfiguration | 2645 |
| WasteReceiptHeaders | 2647 |
| WasteReceiptTrailers | 2648 |
Example:
[
1124,
1159
]Nested Schema : name
Type:
objectZone Name
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : ZoneOptions
Type:
objectDetails of Options
Show Source
-
allRVCsfromSameLocation:
boolean
Example:
true -
EnforceUniquePropertiesWithinZone:
boolean
Example:
true -
EnforceUniqueRVCsWithinZone:
boolean
Example:
true -
restrictModulesInChildZones:
boolean
Example:
true -
sortAlphabetically:
boolean
Example:
true