Jump to

• Request
• Response

Get a list of Zones

post

/config/sim/v1/hierarchy/getZones

Gets a list of Zones

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

A request body

Root Schema : ZoneGetRequestBody

Type: object

The input Body model that needs to be given.

Show Source

• include(optional): string
  Objects included in response
• languages(optional): string
  If specified, limits translated strings returned
• limit(optional): integer
  If using paging, number of results returned in this page.
• offset(optional): integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy(optional): integer
  Sorts the response by the specified field name and sort order.
• searchCriteria(optional): string
  Search criteria to filter results based on field value

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "description":"Objects included in response"
        },
        "languages":{
            "type":"string",
            "description":"If specified, limits translated strings returned"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"integer",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Zones

Body ()

Root Schema : Zone

Type: object

Model for a Zone

Show Source

• emcOptionsExt(optional): object EMCOptions
  Details of Selected EMC Modules
• hierUnitId(optional): integer
  Hierarchy Unit Id of the Zone

  Example: 1
• options(optional): string
  String representing the status of Options

  Example: 1010101010
• parentHierUnitId(optional): integer
  Hierarchy Unit Id of the Parent

  Example: 1
• zoneOptionsExt(optional): object ZoneOptions
  Details of Options
• zoneType(optional): integer
  Type of Zone

  Example: 1

{
    "description":"Model for a Zone",
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Hierarchy Unit Id of the Zone",
            "type":"integer",
            "example":1
        },
        "parentHierUnitId":{
            "description":"Hierarchy Unit Id of the Parent",
            "type":"integer",
            "example":1
        },
        "zoneType":{
            "description":"Type of Zone",
            "type":"integer",
            "example":1
        },
        "options":{
            "description":"String representing the status of Options",
            "type":"string",
            "example":"1010101010"
        },
        "zoneOptionsExt":{
            "$ref":"#/definitions/ZoneOptions"
        },
        "emcOptionsExt":{
            "$ref":"#/definitions/EMCOptions"
        }
    }
}

Nested Schema : EMCOptions

Type: object

Details of Selected EMC Modules

Show Source

• enableAllModules(optional): boolean
  Example: true
• enableAlphanumericKeyboard(optional): boolean
  Example: true
• enableApplicationText(optional): boolean
  Example: true
• enableAutofireCheckOfflineHeader(optional): boolean
  Example: true
• enableAutoMenuLevels(optional): boolean
  Example: true
• enableBarcodeFormatStatus(optional): boolean
  Example: true
• enableBarcodes(optional): boolean
  Example: true
• enableCanadianGST(optional): boolean
  Example: true
• enableCanadianPST(optional): boolean
  Example: true
• enableCanadianTaxTrailers(optional): boolean
  Example: true
• enableCheckAlert(optional): boolean
  Example: true
• enableCheckSummaryDescriptors(optional): boolean
  Example: true
• enableCMAccount(optional): boolean
  Example: true
• enableCMCashCountThreshold(optional): boolean
  Example: true
• enableCMCashPullThreashold(optional): boolean
  Example: true
• enableCMClass(optional): boolean
  Example: true
• enableCMClassBehavior(optional): boolean
  Example: true
• enableCMCountSheet(optional): boolean
  Example: true
• enableCMParameters(optional): boolean
  Example: true
• enableCMPARLevel(optional): boolean
  Example: true
• enableCMReason(optional): boolean
  Example: true
• enableCMReceptacle(optional): boolean
  Example: true
• enableCMTemplate(optional): boolean
  Example: true
• enableCMVendor(optional): boolean
  Example: true
• enableComboMealGroups(optional): boolean
  Example: true
• enableComboMeals(optional): boolean
  Example: true
• enableComponents(optional): boolean
  Example: true
• enableCondimentGroupNames(optional): boolean
  Example: true
• enableCondimentSets(optional): boolean
  Example: true
• enableContent(optional): boolean
  Example: true
• enableControlParameters(optional): boolean
  Example: true
• enableCreditCardHeader(optional): boolean
  Example: true
• enableCreditCardTrailers(optional): boolean
  Example: true
• enableCurrency(optional): boolean
  Example: true
• enableCurrencyAvailability(optional): boolean
  Example: true
• enableCurrencyConversion(optional): boolean
  Example: true
• enableCurrencyParameters(optional): boolean
  Example: true
• enableCustomerReceiptHeaders(optional): boolean
  Example: true
• enableCustomReport(optional): boolean
  Example: true
• enableDataExtensions(optional): boolean
  Example: true
• enableDiningTableClass(optional): boolean
  Example: true
• enableDiningTableStatusDefSet(optional): boolean
  Example: true
• enableDiscountGroups(optional): boolean
  Example: true
• enableDiscountItemizers(optional): boolean
  Example: true
• enableDiscounts(optional): boolean
  Example: true
• enableDiscountSLUNames(optional): boolean
  Example: true
• enableEffectivityGroups(optional): boolean
  Example: true
• enableExtentionApplication(optional): boolean
  Example: true
• enableFamilyGroups(optional): boolean
  Example: true
• enableFormatParamters(optional): boolean
  Example: true
• enableGiftCardProvider(optional): boolean
  Example: true
• enableGuestCheckHeaders(optional): boolean
  Example: true
• enableGuestCheckTrailers(optional): boolean
  Example: true
• enableGuestInformationPrompts(optional): boolean
  Example: true
• enableKDSBumpBars(optional): boolean
  Example: true
• enableKDSDiningCourse(optional): boolean
  Example: true
• enableKDSHighlightSchemes(optional): boolean
  Example: true
• enableKDSToolBars(optional): boolean
  Example: true
• enableLoanReasons(optional): boolean
  Example: true
• enableLoyaltyCardProvider(optional): boolean
  Example: true
• enableLoyaltyConfig(optional): boolean
  Example: true
• enableLoyaltyDriver(optional): boolean
  Example: true
• enableLoyaltyModule(optional): boolean
  Example: true
• enableMajorGroups(optional): boolean
  Example: true
• enableMenuItemClasses(optional): boolean
  Example: true
• enableMenuItemDefinitions(optional): boolean
  Example: true
• enableMenuItemGroups(optional): boolean
  Example: true
• enableMenuItemMasterGroups(optional): boolean
  Example: true
• enableMenuItemMasterGroupSLUNames(optional): boolean
  Example: true
• enableMenuItemMasters(optional): boolean
  Example: true
• enableMenuItemPrices(optional): boolean
  Example: true
• enableMenuItemSLUNames(optional): boolean
  Example: true
• enableMenuLevelSets(optional): boolean
  Example: true
• enableNLUNames(optional): boolean
  Example: true
• enableOperators(optional): boolean
  Example: true
• enableOrderTypeParameters(optional): boolean
  Example: true
• enableOrderTypes(optional): boolean
  Example: true
• enablePageAssignment(optional): boolean
  Example: true
• enablePages(optional): boolean
  Example: true
• enablePageTemplate(optional): boolean
  Example: true
• enablePaymentDevice(optional): boolean
  Example: true
• enablePaymentDriver(optional): boolean
  Example: true
• enablePaymentReasons(optional): boolean
  Example: true
• enablePayments(optional): boolean
  Example: true
• enablePickupReasons(optional): boolean
  Example: true
• enablePOSKeyboard(optional): boolean
  Example: true
• enablePriceGroups(optional): boolean
  Example: true
• enablePrintClasses(optional): boolean
  Example: true
• enableProductionItem(optional): boolean
  Example: true
• enablePropertyEmployeeRecords(optional): boolean
  Example: true
• enableReportGroups(optional): boolean
  Example: true
• enableReportHeaders(optional): boolean
  Example: true
• enableReportParameters(optional): boolean
  Example: true
• enableReportTrailers(optional): boolean
  Example: true
• enableRoutingGroups(optional): boolean
  Example: true
• enableRVCTypeNames(optional): boolean
  Example: true
• enableSalesItemizers(optional): boolean
  Example: true
• enableSeatingSectionTemplate(optional): boolean
  Example: true
• enableSection(optional): boolean
  Example: true
• enableServiceAlert(optional): boolean
  Example: true
• enableServiceChargeGroup(optional): boolean
  Example: true
• enableServiceChargeItemizers(optional): boolean
  Example: true
• enableServiceCharges(optional): boolean
  Example: true
• enableServiceChargeSLUNames(optional): boolean
  Example: true
• enableServiceTotalReasons(optional): boolean
  Example: true
• enableStoredValueConfiguration(optional): boolean
  Example: true
• enableStoredValueDriver(optional): boolean
  Example: true
• enableStoredValueModule(optional): boolean
  Example: true
• enableSystemTemplate(optional): boolean
  Example: true
• enableTaskSchedules(optional): boolean
  Example: true
• enableTaxClasses(optional): boolean
  Example: true
• enableTaxParameters(optional): boolean
  Example: true
• enableTaxRates(optional): boolean
  Example: true
• enableTenderMedia(optional): boolean
  Example: true
• enableTenderMediaSLUNames(optional): boolean
  Example: true
• enableTenderParameters(optional): boolean
  Example: true
• enableThemeAssignment(optional): boolean
  Example: true
• enableTimeClockReasons(optional): boolean
  Example: true
• enableTMSParameters(optional): boolean
  Example: true
• enableTMSreaons(optional): boolean
  Example: true
• enableTMSTableAttributes(optional): boolean
  Example: true
• enableTrainingHeaders(optional): boolean
  Example: true
• enableVoidReturnWasteReaon(optional): boolean
  Example: true
• enableWaitQuoteConfiguration(optional): boolean
  Example: true
• enableWasteReceiptHeaders(optional): boolean
  Example: true
• enableWasteReceiptTrailers(optional): boolean
  Example: true
• enableWorkstationClass(optional): boolean
  Example: true

{
    "description":"Details of Selected EMC Modules",
    "type":"object",
    "properties":{
        "enableAllModules":{
            "type":"boolean",
            "example":true
        },
        "enableAlphanumericKeyboard":{
            "type":"boolean",
            "example":true
        },
        "enableApplicationText":{
            "type":"boolean",
            "example":true
        },
        "enableAutoMenuLevels":{
            "type":"boolean",
            "example":true
        },
        "enableAutofireCheckOfflineHeader":{
            "type":"boolean",
            "example":true
        },
        "enableBarcodeFormatStatus":{
            "type":"boolean",
            "example":true
        },
        "enableBarcodes":{
            "type":"boolean",
            "example":true
        },
        "enableCanadianGST":{
            "type":"boolean",
            "example":true
        },
        "enableCanadianPST":{
            "type":"boolean",
            "example":true
        },
        "enableCanadianTaxTrailers":{
            "type":"boolean",
            "example":true
        },
        "enableCMAccount":{
            "type":"boolean",
            "example":true
        },
        "enableCMCashCountThreshold":{
            "type":"boolean",
            "example":true
        },
        "enableCMCashPullThreashold":{
            "type":"boolean",
            "example":true
        },
        "enableCMClass":{
            "type":"boolean",
            "example":true
        },
        "enableCMClassBehavior":{
            "type":"boolean",
            "example":true
        },
        "enableCMCountSheet":{
            "type":"boolean",
            "example":true
        },
        "enableCMPARLevel":{
            "type":"boolean",
            "example":true
        },
        "enableCMParameters":{
            "type":"boolean",
            "example":true
        },
        "enableCMReason":{
            "type":"boolean",
            "example":true
        },
        "enableCMReceptacle":{
            "type":"boolean",
            "example":true
        },
        "enableCMTemplate":{
            "type":"boolean",
            "example":true
        },
        "enableCMVendor":{
            "type":"boolean",
            "example":true
        },
        "enableCheckAlert":{
            "type":"boolean",
            "example":true
        },
        "enableCheckSummaryDescriptors":{
            "type":"boolean",
            "example":true
        },
        "enableComboMealGroups":{
            "type":"boolean",
            "example":true
        },
        "enableComboMeals":{
            "type":"boolean",
            "example":true
        },
        "enableComponents":{
            "type":"boolean",
            "example":true
        },
        "enableCondimentGroupNames":{
            "type":"boolean",
            "example":true
        },
        "enableCondimentSets":{
            "type":"boolean",
            "example":true
        },
        "enableContent":{
            "type":"boolean",
            "example":true
        },
        "enableControlParameters":{
            "type":"boolean",
            "example":true
        },
        "enableCreditCardHeader":{
            "type":"boolean",
            "example":true
        },
        "enableCreditCardTrailers":{
            "type":"boolean",
            "example":true
        },
        "enableCurrency":{
            "type":"boolean",
            "example":true
        },
        "enableCurrencyAvailability":{
            "type":"boolean",
            "example":true
        },
        "enableCurrencyConversion":{
            "type":"boolean",
            "example":true
        },
        "enableCurrencyParameters":{
            "type":"boolean",
            "example":true
        },
        "enableCustomReport":{
            "type":"boolean",
            "example":true
        },
        "enableCustomerReceiptHeaders":{
            "type":"boolean",
            "example":true
        },
        "enableDataExtensions":{
            "type":"boolean",
            "example":true
        },
        "enableDiningTableClass":{
            "type":"boolean",
            "example":true
        },
        "enableDiningTableStatusDefSet":{
            "type":"boolean",
            "example":true
        },
        "enableDiscountGroups":{
            "type":"boolean",
            "example":true
        },
        "enableDiscountItemizers":{
            "type":"boolean",
            "example":true
        },
        "enableDiscountSLUNames":{
            "type":"boolean",
            "example":true
        },
        "enableDiscounts":{
            "type":"boolean",
            "example":true
        },
        "enableEffectivityGroups":{
            "type":"boolean",
            "example":true
        },
        "enableExtentionApplication":{
            "type":"boolean",
            "example":true
        },
        "enableFamilyGroups":{
            "type":"boolean",
            "example":true
        },
        "enableFormatParamters":{
            "type":"boolean",
            "example":true
        },
        "enableGiftCardProvider":{
            "type":"boolean",
            "example":true
        },
        "enableGuestCheckHeaders":{
            "type":"boolean",
            "example":true
        },
        "enableGuestCheckTrailers":{
            "type":"boolean",
            "example":true
        },
        "enableGuestInformationPrompts":{
            "type":"boolean",
            "example":true
        },
        "enableKDSBumpBars":{
            "type":"boolean",
            "example":true
        },
        "enableKDSHighlightSchemes":{
            "type":"boolean",
            "example":true
        },
        "enableKDSToolBars":{
            "type":"boolean",
            "example":true
        },
        "enableKDSDiningCourse":{
            "type":"boolean",
            "example":true
        },
        "enableLoanReasons":{
            "type":"boolean",
            "example":true
        },
        "enableLoyaltyConfig":{
            "type":"boolean",
            "example":true
        },
        "enableLoyaltyCardProvider":{
            "type":"boolean",
            "example":true
        },
        "enableLoyaltyDriver":{
            "type":"boolean",
            "example":true
        },
        "enableLoyaltyModule":{
            "type":"boolean",
            "example":true
        },
        "enableMajorGroups":{
            "type":"boolean",
            "example":true
        },
        "enableMenuItemClasses":{
            "type":"boolean",
            "example":true
        },
        "enableMenuItemDefinitions":{
            "type":"boolean",
            "example":true
        },
        "enableMenuItemGroups":{
            "type":"boolean",
            "example":true
        },
        "enableMenuItemMasterGroupSLUNames":{
            "type":"boolean",
            "example":true
        },
        "enableMenuItemMasterGroups":{
            "type":"boolean",
            "example":true
        },
        "enableMenuItemMasters":{
            "type":"boolean",
            "example":true
        },
        "enableMenuItemPrices":{
            "type":"boolean",
            "example":true
        },
        "enableMenuItemSLUNames":{
            "type":"boolean",
            "example":true
        },
        "enableMenuLevelSets":{
            "type":"boolean",
            "example":true
        },
        "enableNLUNames":{
            "type":"boolean",
            "example":true
        },
        "enableOperators":{
            "type":"boolean",
            "example":true
        },
        "enableOrderTypeParameters":{
            "type":"boolean",
            "example":true
        },
        "enableOrderTypes":{
            "type":"boolean",
            "example":true
        },
        "enablePages":{
            "type":"boolean",
            "example":true
        },
        "enablePageAssignment":{
            "type":"boolean",
            "example":true
        },
        "enablePageTemplate":{
            "type":"boolean",
            "example":true
        },
        "enablePaymentDevice":{
            "type":"boolean",
            "example":true
        },
        "enablePaymentDriver":{
            "type":"boolean",
            "example":true
        },
        "enablePaymentReasons":{
            "type":"boolean",
            "example":true
        },
        "enablePayments":{
            "type":"boolean",
            "example":true
        },
        "enablePickupReasons":{
            "type":"boolean",
            "example":true
        },
        "enablePOSKeyboard":{
            "type":"boolean",
            "example":true
        },
        "enablePriceGroups":{
            "type":"boolean",
            "example":true
        },
        "enablePrintClasses":{
            "type":"boolean",
            "example":true
        },
        "enableProductionItem":{
            "type":"boolean",
            "example":true
        },
        "enablePropertyEmployeeRecords":{
            "type":"boolean",
            "example":true
        },
        "enableReportGroups":{
            "type":"boolean",
            "example":true
        },
        "enableReportHeaders":{
            "type":"boolean",
            "example":true
        },
        "enableReportTrailers":{
            "type":"boolean",
            "example":true
        },
        "enableReportParameters":{
            "type":"boolean",
            "example":true
        },
        "enableRoutingGroups":{
            "type":"boolean",
            "example":true
        },
        "enableRVCTypeNames":{
            "type":"boolean",
            "example":true
        },
        "enableSalesItemizers":{
            "type":"boolean",
            "example":true
        },
        "enableSeatingSectionTemplate":{
            "type":"boolean",
            "example":true
        },
        "enableSection":{
            "type":"boolean",
            "example":true
        },
        "enableServiceAlert":{
            "type":"boolean",
            "example":true
        },
        "enableServiceChargeGroup":{
            "type":"boolean",
            "example":true
        },
        "enableServiceChargeItemizers":{
            "type":"boolean",
            "example":true
        },
        "enableServiceChargeSLUNames":{
            "type":"boolean",
            "example":true
        },
        "enableServiceCharges":{
            "type":"boolean",
            "example":true
        },
        "enableServiceTotalReasons":{
            "type":"boolean",
            "example":true
        },
        "enableStoredValueConfiguration":{
            "type":"boolean",
            "example":true
        },
        "enableStoredValueDriver":{
            "type":"boolean",
            "example":true
        },
        "enableStoredValueModule":{
            "type":"boolean",
            "example":true
        },
        "enableSystemTemplate":{
            "type":"boolean",
            "example":true
        },
        "enableTaskSchedules":{
            "type":"boolean",
            "example":true
        },
        "enableTaxClasses":{
            "type":"boolean",
            "example":true
        },
        "enableTaxParameters":{
            "type":"boolean",
            "example":true
        },
        "enableTaxRates":{
            "type":"boolean",
            "example":true
        },
        "enableTenderMedia":{
            "type":"boolean",
            "example":true
        },
        "enableTenderParameters":{
            "type":"boolean",
            "example":true
        },
        "enableTenderMediaSLUNames":{
            "type":"boolean",
            "example":true
        },
        "enableThemeAssignment":{
            "type":"boolean",
            "example":true
        },
        "enableTimeClockReasons":{
            "type":"boolean",
            "example":true
        },
        "enableTMSParameters":{
            "type":"boolean",
            "example":true
        },
        "enableTMSreaons":{
            "type":"boolean",
            "example":true
        },
        "enableTMSTableAttributes":{
            "type":"boolean",
            "example":true
        },
        "enableTrainingHeaders":{
            "type":"boolean",
            "example":true
        },
        "enableVoidReturnWasteReaon":{
            "type":"boolean",
            "example":true
        },
        "enableWaitQuoteConfiguration":{
            "type":"boolean",
            "example":true
        },
        "enableWasteReceiptHeaders":{
            "type":"boolean",
            "example":true
        },
        "enableWasteReceiptTrailers":{
            "type":"boolean",
            "example":true
        },
        "enableWorkstationClass":{
            "type":"boolean",
            "example":true
        }
    }
}

Nested Schema : ZoneOptions

Type: object

Details of Options

Show Source

• allRVCsfromSameLocation(optional): boolean
  Example: true
• EnforceUniquePropertiesWithinZone(optional): boolean
  Example: true
• EnforceUniqueRVCsWithinZone(optional): boolean
  Example: true
• restrictModulesInChildZones(optional): boolean
  Example: true
• sortAlphabetically(optional): boolean
  Example: true

{
    "description":"Details of Options",
    "type":"object",
    "properties":{
        "EnforceUniquePropertiesWithinZone":{
            "type":"boolean",
            "example":true
        },
        "EnforceUniqueRVCsWithinZone":{
            "type":"boolean",
            "example":true
        },
        "restrictModulesInChildZones":{
            "type":"boolean",
            "example":true
        },
        "allRVCsfromSameLocation":{
            "type":"boolean",
            "example":true
        },
        "sortAlphabetically":{
            "type":"boolean",
            "example":true
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): 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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top