Configuration and Content API Guide

Get EMC Modules

post

/config/sim/v2/hierarchy/zones/getEMCModules

Get the EMC Modules assigned to zones

Request

Supported Media Types

application/json
multipart/form-data

Root Schema : schema

Type: object

Show Source

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 supported

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order. Allowed field is hierStrucId.

Example: hierStrucId:asc
searchCriteria: string

If specified, returns records that match the criteria. Allowed field is hierStrucId

Example: where equals(hierStrucId, 1792)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(hierStrucId, 1792)",
            "description":"If specified, returns records that match the criteria. Allowed field is hierStrucId"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order. Allowed field is hierStrucId.",
            "example":"hierStrucId:asc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: object

Show Source

count: integer

Number of records returned on this page

Example: 10
hasMore: boolean

Indicates whether there are additional pages of records

Example: true
items: array items

EMCModule records
limit: integer

The maximum number of records returned on a page

Example: 10
offset: integer

The page number of this data. Starts at 0.

Example: 0
totalResults: integer

Total number of records in the data set

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"Total number of records in the data set",
            "type":"integer",
            "example":100
        },
        "hasMore":{
            "description":"Indicates whether there are additional pages of records",
            "type":"boolean",
            "example":true
        },
        "count":{
            "description":"Number of records returned on this page",
            "type":"integer",
            "example":10
        },
        "items":{
            "description":"EMCModule records",
            "type":"array",
            "items":{
                "$ref":"#/definitions/EMCModule"
            }
        },
        "offset":{
            "description":"The page number of this data.  Starts at 0.",
            "type":"integer",
            "example":0
        },
        "limit":{
            "description":"The maximum number of records returned on a page",
            "type":"integer",
            "example":10
        }
    }
}

Nested Schema : items

Type: array

EMCModule records

Show Source

Array of: object EMCModule

EMC Module record

{
    "description":"EMCModule records",
    "type":"array",
    "items":{
        "$ref":"#/definitions/EMCModule"
    }
}

Nested Schema : EMCModule

Type: object

EMC Module record

Show Source

EMCModule: integer

Enabled EMC module at the corresponding hierarchy

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

hierStrucId: integer

Unique reference of the hierarchy structure where the EMC Module is enabled.

Example: 3599

{
    "description":"EMC Module record",
    "type":"object",
    "properties":{
        "hierStrucId":{
            "description":"Unique reference of the hierarchy structure where the EMC Module is enabled.",
            "type":"integer",
            "example":3599
        },
        "EMCModule":{
            "description":"<p>Enabled EMC module at the corresponding hierarchy</p>\n\n<table>\n  <tr><th>Module Name</th><th>Value</th></tr>\n  <tr><td> AllModules </td><td> 1 </td></tr>\n  <tr><td> AlphanumericKeyboard </td><td> 2143 </td></tr>\n  <tr><td> ApplicationText </td><td> 2138 </td></tr>\n  <tr><td> AutoMenuLevels </td><td> 1150 </td></tr>\n  <tr><td> AutofireCheckOfflineHeader </td><td> 2646 </td></tr>\n  <tr><td> BarcodeFormatStatus </td><td> 1131 </td></tr>\n  <tr><td> Barcodes </td><td> 2104 </td></tr>\n  <tr><td> Browser </td><td> 2657 </td></tr>\n  <tr><td> CanadianGST </td><td> 1146 </td></tr>\n  <tr><td> CanadianPST </td><td> 1147 </td></tr>\n  <tr><td> CanadianTaxTrailers </td><td> 2618 </td></tr>\n  <tr><td> CMAccount </td><td> 6005 </td></tr>\n  <tr><td> CMCashCountThreshold </td><td> 6011 </td></tr>\n  <tr><td> CMCashPullThreashold </td><td> 6007 </td></tr>\n  <tr><td> CMClass </td><td> 6003 </td></tr>\n  <tr><td> CMClassBehavior </td><td> 6012 </td></tr>\n  <tr><td> CMCountSheet </td><td> 6002 </td></tr>\n  <tr><td> CMPARLevel </td><td> 6008 </td></tr>\n  <tr><td> CMParameters </td><td> 6010 </td></tr>\n  <tr><td> CMReason </td><td> 6009 </td></tr>\n  <tr><td> CMReceptacle </td><td> 6004 </td></tr>\n  <tr><td> CMTemplate </td><td> 6001 </td></tr>\n  <tr><td> CMVendor </td><td> 6006 </td></tr>\n  <tr><td> CheckAlert </td><td> 2643 </td></tr>\n  <tr><td> CheckSummaryDescriptors </td><td> 2602 </td></tr>\n  <tr><td> ComboMealGroups </td><td> 2123 </td></tr>\n  <tr><td> ComboMeals </td><td> 2122 </td></tr>\n  <tr><td> Components </td><td> 2158 </td></tr>\n  <tr><td> CondimentGroupNames </td><td> 2627 </td></tr>\n  <tr><td> CondimentSets </td><td> 2128 </td></tr>\n  <tr><td> Content </td><td> 2126 </td></tr>\n  <tr><td> ControlParameters </td><td> 1148 </td></tr>\n  <tr><td> CheckHeaderOrderTypeChannel </td><td> 7110 </td></tr>\n  <tr><td> CheckTrailerOrderTypeChannel </td><td> 7111 </td></tr>\n  <tr><td> CreditCardHeader </td><td> 2616 </td></tr>\n  <tr><td> CreditCardTrailers </td><td> 2617 </td></tr>\n  <tr><td> Currency </td><td> 1113 </td></tr>\n  <tr><td> CurrencyAvailability </td><td> 1144 </td></tr>\n  <tr><td> CurrencyConversion </td><td> 1142 </td></tr>\n  <tr><td> CurrencyParameters </td><td> 1145 </td></tr>\n  <tr><td> CustomReport </td><td> 2137 </td></tr>\n  <tr><td> CustomerReceiptHeaders </td><td> 2614 </td></tr>\n  <tr><td> DataExtensions </td><td> 2129 </td></tr>\n  <tr><td> DiningTableClass </td><td> 2140 </td></tr>\n  <tr><td> DiningTableStatusDefSet </td><td> 2141 </td></tr>\n  <tr><td> DiscountGroups </td><td> 2609 </td></tr>\n  <tr><td> DiscountItemizers </td><td> 2624 </td></tr>\n  <tr><td> DiscountSLUNames </td><td> 2629 </td></tr>\n  <tr><td> Discounts </td><td> 1120 </td></tr>\n  <tr><td> EffectivityGroups </td><td> 131 </td></tr>\n  <tr><td> ExtentionApplication </td><td> 2139 </td></tr>\n  <tr><td> FormatParamters </td><td> 1143 </td></tr>\n  <tr><td> GiftCardProvider </td><td> 1175 </td></tr>\n  <tr><td> GuestCheckHeaders </td><td> 2612 </td></tr>\n  <tr><td> GuestCheckTrailers </td><td> 2613 </td></tr>\n  <tr><td> GuestInformationPrompts </td><td> 2603 </td></tr>\n  <tr><td> KDSBumpBars </td><td> 1129 </td></tr>\n  <tr><td> KDSHighlightSchemes </td><td> 1137 </td></tr>\n  <tr><td> KDSToolBars </td><td> 1130 </td></tr>\n  <tr><td> KDSDiningCourse </td><td> 2641 </td></tr>\n  <tr><td> LoanReasons </td><td> 2606 </td></tr>\n  <tr><td> LoyaltyConfig </td><td> 1157 </td></tr>\n  <tr><td> LoyaltyCardProvider </td><td> 1176 </td></tr>\n  <tr><td> LoyaltyDriver </td><td> 1160 </td></tr>\n  <tr><td> LoyaltyModule </td><td> 1159 </td></tr>\n  <tr><td> MenuItemClasses </td><td> 2101 </td></tr>\n  <tr><td> MenuItemDefinitions </td><td> 2102 </td></tr>\n  <tr><td> MenuItemGroups </td><td> 1133 </td></tr>\n  <tr><td> MenuItemMasterGroupSLUNames </td><td> 2652 </td></tr>\n  <tr><td> MenuItemMasterGroups </td><td> 1138 </td></tr>\n  <tr><td> MenuItemMasters </td><td> 1123 </td></tr>\n  <tr><td> MenuItemPrices </td><td> 2103 </td></tr>\n  <tr><td> MenuItemSLUNames </td><td> 2631 </td></tr>\n  <tr><td> MenuLevelSets </td><td> 2127 </td></tr>\n  <tr><td> NLUNames </td><td> 2623 </td></tr>\n  <tr><td> Operators </td><td> 2100 </td></tr>\n  <tr><td> OrderChannelParameters </td><td> 7107 </td></tr>\n  <tr><td> OrderTypeParameters </td><td> 1141 </td></tr>\n  <tr><td> OrderTypes </td><td> 2622 </td></tr>\n  <tr><td> Pages </td><td> 2124 </td></tr>\n  <tr><td> PageAssignment </td><td> 2135 </td></tr>\n  <tr><td> PageTemplate </td><td> 2125 </td></tr>\n  <tr><td> PaymentDevice </td><td> 1164 </td></tr>\n  <tr><td> PaymentDriver </td><td> 1161 </td></tr>\n  <tr><td> PaymentReasons </td><td> 2605 </td></tr>\n  <tr><td> Payments </td><td> 1155 </td></tr>\n  <tr><td> PickupReasons </td><td> 2607 </td></tr>\n  <tr><td> POSKeyboard </td><td> 2655 </td></tr>\n  <tr><td> PriceGroups </td><td> 124 </td></tr>\n  <tr><td> PrintClasses </td><td> 2146 </td></tr>\n  <tr><td> ProductionItem </td><td> 2150 </td></tr>\n  <tr><td> PropertyEmployeeRecords </td><td> 1101 </td></tr>\n  <tr><td> ReceiptHeaderOrderTypeChannel </td><td> 7113 </td></tr>\n  <tr><td> ReportGroups </td><td> 120 </td></tr>\n  <tr><td> ReportHeaders </td><td> 7103 </td></tr>\n  <tr><td> ReportTrailers </td><td> 7104 </td></tr>\n  <tr><td> ReportParameters </td><td> 1149 </td></tr>\n  <tr><td> RoutingGroups </td><td> 2639 </td></tr>\n  <tr><td> RVCTypeNames </td><td> 2610 </td></tr>\n  <tr><td> SalesItemizers </td><td> 2625 </td></tr>\n  <tr><td> SeatingSectionTemplate </td><td> 2147 </td></tr>\n  <tr><td> Section </td><td> 2148 </td></tr>\n  <tr><td> ServiceAlert </td><td> 2642 </td></tr>\n  <tr><td> ServiceChargeGroup </td><td> 7002 </td></tr>\n  <tr><td> ServiceChargeItemizers </td><td> 2626 </td></tr>\n  <tr><td> ServiceChargeSLUNames </td><td> 2633 </td></tr>\n  <tr><td> ServiceCharges </td><td> 1121 </td></tr>\n  <tr><td> ServiceTotalReasons </td><td> 2608 </td></tr>\n  <tr><td> StoredValueConfiguration </td><td> 1158 </td></tr>\n  <tr><td> StoredValueDriver </td><td> 1163 </td></tr>\n  <tr><td> StoredValueModule </td><td> 1162 </td></tr>\n  <tr><td> SystemTemplate </td><td> 2136 </td></tr>\n  <tr><td> TaskSchedules </td><td> 133 </td></tr>\n  <tr><td> TaxClasses </td><td> 1118 </td></tr>\n  <tr><td> TaxParameters </td><td> 1139 </td></tr>\n  <tr><td> TaxRates </td><td> 1117 </td></tr>\n  <tr><td> TenderMedia </td><td> 1119 </td></tr>\n  <tr><td> TenderParameters </td><td> 1140 </td></tr>\n  <tr><td> TenderMediaSLUNames </td><td> 2635 </td></tr>\n  <tr><td> ThemeAssignment </td><td> 2156 </td></tr>\n  <tr><td> TimeClockReasons </td><td> 2621 </td></tr>\n  <tr><td> TMSParameters </td><td> 2149 </td></tr>\n  <tr><td> TMSreaons </td><td> 2644 </td></tr>\n  <tr><td> TMSTableAttributes </td><td> 2155 </td></tr>\n  <tr><td> TrainingHeaders </td><td> 2615 </td></tr>\n  <tr><td> VoidReturnWasteReaon </td><td> 2649 </td></tr>\n  <tr><td> WaitQuoteConfiguration </td><td> 2645 </td></tr>\n  <tr><td> WasteReceiptHeaders </td><td> 2647 </td></tr>\n  <tr><td> WasteReceiptTrailers </td><td> 2648 </td></tr>\n  </table>\n",
            "type":"integer",
            "example":1124
        }
    }
}