Get Zones
post
/config/sim/v1/hierarchy/getZones
Gets a list of Zones
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : ZoneGetRequestBody
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
Objects included in response
-
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits translated strings returned
-
limit:
integer
If using paging, number of results returned in this page.
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported
-
orderBy:
string
Sorts the response by the specified field name and sort order.
-
searchCriteria:
string
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
A collection of Zones
Root Schema : Zone
Type:
objectModel for a Zone
Show Source
-
emcOptionsExt(required):
object EMCOptions
Details of Selected EMC Modules
-
hierStrucId(required):
integer
Hierarchy Structuture Id of the Zone. Excluded by default.Example:
1 -
hierUnitId(required):
integer
Hierarchy Unit Id of the ZoneExample:
1 -
options(required):
string
A string value of 0s & 1s of length 10 representing the status of OptionsExample:
1010101010 -
parentHierStrucId(required):
integer
Hierarchy Structuture Id of the Parent. Excluded by default.Example:
1 -
parentHierUnitId(required):
integer
Hierarchy Unit Id of the ParentExample:
1 -
zoneOptionsExt(required):
object ZoneOptions
Details of Options
-
zoneType(required):
integer
Type of ZoneExample:
1
Nested Schema : EMCOptions
Type:
objectDetails of Selected EMC Modules
Show Source
-
enableAllModules:
boolean
Example:
true -
enableAlphanumericKeyboard:
boolean
Example:
true -
enableApplicationText:
boolean
Example:
true -
enableAutofireCheckOfflineHeader:
boolean
Example:
true -
enableAutoMenuLevels:
boolean
Example:
true -
enableBarcodeFormatStatus:
boolean
Example:
true -
enableBarcodes:
boolean
Example:
true -
enableCanadianGST:
boolean
Example:
true -
enableCanadianPST:
boolean
Example:
true -
enableCanadianTaxTrailers:
boolean
Example:
true -
enableCheckAlert:
boolean
Example:
true -
enableCheckSummaryDescriptors:
boolean
Example:
true -
enableCMAccount:
boolean
Example:
true -
enableCMCashCountThreshold:
boolean
Example:
true -
enableCMCashPullThreashold:
boolean
Example:
true -
enableCMClass:
boolean
Example:
true -
enableCMClassBehavior:
boolean
Example:
true -
enableCMCountSheet:
boolean
Example:
true -
enableCMParameters:
boolean
Example:
true -
enableCMPARLevel:
boolean
Example:
true -
enableCMReason:
boolean
Example:
true -
enableCMReceptacle:
boolean
Example:
true -
enableCMTemplate:
boolean
Example:
true -
enableCMVendor:
boolean
Example:
true -
enableComboMealGroups:
boolean
Example:
true -
enableComboMeals:
boolean
Example:
true -
enableComponents:
boolean
Example:
true -
enableCondimentGroupNames:
boolean
Example:
true -
enableCondimentSets:
boolean
Example:
true -
enableContent:
boolean
Example:
true -
enableControlParameters:
boolean
Example:
true -
enableCreditCardHeader:
boolean
Example:
true -
enableCreditCardTrailers:
boolean
Example:
true -
enableCurrency:
boolean
Example:
true -
enableCurrencyAvailability:
boolean
Example:
true -
enableCurrencyConversion:
boolean
Example:
true -
enableCurrencyParameters:
boolean
Example:
true -
enableCustomerReceiptHeaders:
boolean
Example:
true -
enableCustomReport:
boolean
Example:
true -
enableDataExtensions:
boolean
Example:
true -
enableDiningTableClass:
boolean
Example:
true -
enableDiningTableStatusDefSet:
boolean
Example:
true -
enableDiscountGroups:
boolean
Example:
true -
enableDiscountItemizers:
boolean
Example:
true -
enableDiscounts:
boolean
Example:
true -
enableDiscountSLUNames:
boolean
Example:
true -
enableEffectivityGroups:
boolean
Example:
true -
enableExtentionApplication:
boolean
Example:
true -
enableFamilyGroups:
boolean
Example:
true -
enableFormatParamters:
boolean
Example:
true -
enableGiftCardProvider:
boolean
Example:
true -
enableGuestCheckHeaders:
boolean
Example:
true -
enableGuestCheckTrailers:
boolean
Example:
true -
enableGuestInformationPrompts:
boolean
Example:
true -
enableKDSBumpBars:
boolean
Example:
true -
enableKDSDiningCourse:
boolean
Example:
true -
enableKDSHighlightSchemes:
boolean
Example:
true -
enableKDSToolBars:
boolean
Example:
true -
enableLoanReasons:
boolean
Example:
true -
enableLoyaltyCardProvider:
boolean
Example:
true -
enableLoyaltyConfig:
boolean
Example:
true -
enableLoyaltyDriver:
boolean
Example:
true -
enableLoyaltyModule:
boolean
Example:
true -
enableMajorGroups:
boolean
Example:
true -
enableMenuItemClasses:
boolean
Example:
true -
enableMenuItemDefinitions:
boolean
Example:
true -
enableMenuItemGroups:
boolean
Example:
true -
enableMenuItemMasterGroups:
boolean
Example:
true -
enableMenuItemMasterGroupSLUNames:
boolean
Example:
true -
enableMenuItemMasters:
boolean
Example:
true -
enableMenuItemPrices:
boolean
Example:
true -
enableMenuItemSLUNames:
boolean
Example:
true -
enableMenuLevelSets:
boolean
Example:
true -
enableNLUNames:
boolean
Example:
true -
enableOperators:
boolean
Example:
true -
enableOrderTypeParameters:
boolean
Example:
true -
enableOrderTypes:
boolean
Example:
true -
enablePageAssignment:
boolean
Example:
true -
enablePages:
boolean
Example:
true -
enablePageTemplate:
boolean
Example:
true -
enablePaymentDevice:
boolean
Example:
true -
enablePaymentDriver:
boolean
Example:
true -
enablePaymentReasons:
boolean
Example:
true -
enablePayments:
boolean
Example:
true -
enablePickupReasons:
boolean
Example:
true -
enablePOSKeyboard:
boolean
Example:
true -
enablePriceGroups:
boolean
Example:
true -
enablePrintClasses:
boolean
Example:
true -
enableProductionItem:
boolean
Example:
true -
enablePropertyEmployeeRecords:
boolean
Example:
true -
enableReportGroups:
boolean
Example:
true -
enableReportHeaders:
boolean
Example:
true -
enableReportParameters:
boolean
Example:
true -
enableReportTrailers:
boolean
Example:
true -
enableRoutingGroups:
boolean
Example:
true -
enableRVCTypeNames:
boolean
Example:
true -
enableSalesItemizers:
boolean
Example:
true -
enableSeatingSectionTemplate:
boolean
Example:
true -
enableSection:
boolean
Example:
true -
enableServiceAlert:
boolean
Example:
true -
enableServiceChargeGroup:
boolean
Example:
true -
enableServiceChargeItemizers:
boolean
Example:
true -
enableServiceCharges:
boolean
Example:
true -
enableServiceChargeSLUNames:
boolean
Example:
true -
enableServiceTotalReasons:
boolean
Example:
true -
enableStoredValueConfiguration:
boolean
Example:
true -
enableStoredValueDriver:
boolean
Example:
true -
enableStoredValueModule:
boolean
Example:
true -
enableSystemTemplate:
boolean
Example:
true -
enableTaskSchedules:
boolean
Example:
true -
enableTaxClasses:
boolean
Example:
true -
enableTaxParameters:
boolean
Example:
true -
enableTaxRates:
boolean
Example:
true -
enableTenderMedia:
boolean
Example:
true -
enableTenderMediaSLUNames:
boolean
Example:
true -
enableTenderParameters:
boolean
Example:
true -
enableThemeAssignment:
boolean
Example:
true -
enableTimeClockReasons:
boolean
Example:
true -
enableTMSParameters:
boolean
Example:
true -
enableTMSreaons:
boolean
Example:
true -
enableTMSTableAttributes:
boolean
Example:
true -
enableTrainingHeaders:
boolean
Example:
true -
enableVoidReturnWasteReaon:
boolean
Example:
true -
enableWaitQuoteConfiguration:
boolean
Example:
true -
enableWasteReceiptHeaders:
boolean
Example:
true -
enableWasteReceiptTrailers:
boolean
Example:
true -
enableWorkstationClass:
boolean
Example:
true
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
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found