Get Location Parameters
post
/config/sim/v1/hierarchy/getLocationParameters
Gets all the parameters for a location
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : LocationParametersGetRequestBody
Type:
Show Source
object-
hierUnitId(required):
integer
Unique hierarchy unit value.Example:
1 -
include:
string
Example:
locations -
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.Example:
en-US, de-DE, es-MX -
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Location Parameters.
Root Schema : LocationParametersGetResponse
Type:
Show Source
object-
count(required):
integer
Current response recount count.Example:
9 -
hasMore(required):
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items(required):
array items
Array of Location Parameters objects of the organization.
-
limit(required):
integer
Server page sizeExample:
10 -
offset(required):
integer
Starting resource record indexExample:
0 -
totalResults(required):
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Location Parameters objects of the organization.
Show Source
Nested Schema : LocationParameters
Type:
Show Source
object-
calendar(required):
object LocationParams_calendar
An object containing the calendar settings for the location
-
emailConfiguration(required):
object LocationParams_emailConfiguration
An object containing the email configuration for the location
-
hierUnitId(required):
integer
Unique reference of the hierarchy unit of the locationExample:
1 -
hierUnitName(required):
object hierUnitName
A group of string objects representing the name of the location configured languages
-
language(required):
array language
-
ldsNLUGroup(required):
integer
The number of the Menu Item NLU Group to be used by menu items posted by the LDSExample:
0 -
numDaystoSaveCABatchFiles(required):
integer
The number of days to retain Credit Authorization batch files and log files.Example:
0 -
objectNum(required):
integer
Object number of the locationExample:
1 -
options(required):
string
A string value of 0s & 1s of length 8 reprsenting options for location parameters.Example:
00000000 -
optionsExt(required):
object LocationParams_optionsExt
An object containing the descriptive options list associated with the location parameter.
-
postingOptions(required):
string
A string value of 0s & 1s of length 8 reprsenting posting options for location parameters.Example:
00000000 -
postingOptionsExt(required):
object LocationParams_postingOptionsExt
An object containing the descriptive options list associated with the location parameter.
-
reportingLanguage(required):
string
The name of the language to use when posting data to Reporting and Analytics.Example:
English -
reportingLanguageObjNum(required):
integer
The object number of the language to use when posting data to Reporting and Analytics.Example:
1 -
reportingOrgId(required):
integer
the ID of the organization to which this property belongs in the reporting databasesExample:
11866 -
secondaryPrintLanguageName(required):
string
Name of the language to print under the Default Language on a guest check or customer receipt.Example:
English -
secondaryPrintLanguageObjNum(required):
integer
Object number of the language to print under the Default Language on a guest check or customer receiptExample:
0 -
security(required):
object LocationParams_security
An object containing the attributes of the credentials of the system
-
serialNumberInfo(required):
object LocationParams_serialNumberInfo
An object containing the details of the system serial numbers
-
serviceHosts(required):
array serviceHosts
An array of service hosts associated with the location.
-
simphonyEssentials(required):
object LocationParams_simphonyEssentials
Object containing the configuration settings for Simphony Essentials enabled organization
-
taiwanGUIParameters(required):
object LocationParams_taiwanGUIParameters
An object containing the Taiwan tax number prefix and the end of range tax threshold
-
timekeeping(required):
object LocationParams_timekeeping
An object containing the timekeeping configuration for the location
-
wlsStrengthOfflineThreshold(required):
number
The percentage amount to be used to determine if communications should be suspended for wireless workstations, until network signal strength is improved.Example:
0 -
wlsStrengthReconnectThreshold(required):
number
the percentage amount of signal strength to be used to determine at which point the system attempts to reconnect wireless workstations to the network.Example:
0 -
workstationOptions(required):
object LocationParams_workstationOptions
An object containing the workstation options associated with the location
Nested Schema : LocationParams_calendar
Type:
objectAn object containing the calendar settings for the location
Show Source
-
currentBusinessDate:
string
Current business date of the locationExample:
12/20/21 -
manualSODSafetyCatchTime:
string
the time the application automatically increments the business date if manually SOD is not run.Example:
00:00 -
startedAt:
string
Time at which the current business date started at the location.Example:
12/20/21 03:00:00 AM -
startOfDaySettings(required):
array startOfDaySettings
An array of the start of day settings for the business week.
-
startOfPeriodSettings(required):
object LocationParams_startOfPeriodSettings
An object containing the start of period settings for the location
Nested Schema : LocationParams_emailConfiguration
Type:
objectAn object containing the email configuration for the location
Show Source
-
backupSMTPServer:
object LocationParams_backupSMTPServer
An object containing the backup SMTP server details for email configuration of the property.
-
htmlFormatting:
object LocationParams_htmlFormatting
An object containing the text formatting settings of the email configuration of the location.
-
primarySMTPServer:
object LocationParams_primarySMTPServer
An object containing the primary SMTP server settings of the location.
-
sendHTMLEmail:
boolean
A flag indicating if the mail format is in HTML.Example:
false -
textFormatting:
object LocationParams_textFormatting
An object containing the text formatting settings of the email configuration of the location.
Nested Schema : hierUnitName
Type:
objectA group of string objects representing the name of the location configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : language
Type:
Show Source
array-
Array of:
object LocationParams_language
An array of languages that are available at the property.
Nested Schema : LocationParams_optionsExt
Type:
objectAn object containing the descriptive options list associated with the location parameter.
Show Source
-
acceptGenericEmployeeIDCard:
boolean
A flag indicating if the site uses its own employee ID cards.Example:
false -
disableDSTOnKDSDisplayControllers:
boolean
disable Daylight Saving Time on KDS Controllers. Deselect to synchronize Daylight Saving Time settings between the CAL Server and KDS Controllers in the property.Example:
false - disableP2PCheckSharingWhenCAPSUnavailable: boolean
-
doNotShowNegativeTareWeight:
boolean
A remove negative tare weights from the POS client, checks, and receipts.Example:
false -
doNotShowtareWeight:
boolean
prevent tare weight from appearing on the POS client, checks, and receipts.Example:
false -
dontCheckMacroLoopLimit:
boolean
A disable the limit of 20 consecutive macro iterations.Example:
false -
enableClockInRequirementForAuthorization:
boolean
require that employees clock-in to authorize workstation actions.Example:
false -
enableEUROCurrencySystem:
boolean
A make the Euro functionality and all requirements available in the system.Example:
false -
enableEventsReporting:
boolean
A associate transactions with events and to use event reporting.Example:
false -
enableNoDefaultAreaSelectedOption:
boolean
A allow a privileged workstation operator to select No default area selected, rather than a default area.Example:
false -
enableSalesRecordingModule:
boolean
A flag indicating for Quebec sites required to use a Sales Recording Module (SRM) device.Example:
false -
enableSeatNumberInJournal:
boolean
A include the seat number on the journal output.Example:
false -
enableWorkstationAlerting:
boolean
A enable generation of alerts that will be displayed on workstations within the property.Example:
false -
euroCurrencyConversionReportingFeature:
boolean
A print change due on the customer receipt in both the local and Euro currency.Example:
false -
euroIsBaseCurrency:
boolean
make the Euro dollar the base currency for the systemExample:
false -
extendedEventDate:
boolean
send extra summary details to the VSS interface.Example:
false -
eybs:
boolean
A create a separate log to track database changes made for Weights and Measures.Example:
false -
hrgasPMSCompatability:
boolean
A void tenders on a check that have been posted to the PMS when the check is reopened and the first tender is voided.Example:
false -
issueChangeInNationalCurrency:
boolean
issue change in the national currency.Example:
false -
itemDiscountsNetSubTotalDiscountItemizers:
boolean
A post the subtotal discount against the total amount of the itemizer, regardless of item discounts.Example:
false -
postNonTaxableSlaesTotalsNetOfDiscounts:
boolean
A include discounts in calculating the non-taxable sales total that appears on System Tax Reports.Example:
false -
postVoidsToLDS:
boolean
send negative postings to the Oracle suspense file and to the LDSExample:
false -
printAltSummaryTotalsBeforeBase:
boolean
A reverse the print order of the Base and Alternate Summary Totals sections on Euro checks and receipts.Example:
false -
printSimplifiedAltSummaryTotals:
boolean
A reduce the Alternate Summary Totals section to the section header and a single Amount Due/Payment.Example:
false -
printSODValidationChit:
boolean
print a validation chit when the user runs Start of Day from the POS client.Example:
false -
runSODFromOPS:
boolean
allow a user to run Start of Day from the POS clientExample:
false -
sendCashierNumberInsteadOfOperatorNumber:
boolean
A store the cashier number in the Credit Card Batch, rather than the operator number.Example:
false -
showItemWeightInKilos:
boolean
A print and show the weight of weighed menu items in kilograms.Example:
false -
showItemWeightInOunces:
boolean
print and show the weight of weighed menu items in ouncesExample:
false -
use24HourClock:
boolean
A print and show time in 24-hour formatExample:
false -
useDDMMYYYYFormat:
boolean
A print and show dates with the day first.Example:
false
Nested Schema : LocationParams_postingOptionsExt
Type:
objectAn object containing the descriptive options list associated with the location parameter.
Show Source
-
hostFinancialReportFormat:
boolean
A flag indicating for systems installed at Host sitesExample:
false -
isSynchronousConnectionForClockInOutPunch:
boolean
A allow Clock In/ Out to communicate with Labor Management instantly, instead of scheduled requests.Example:
false -
postFoodCostTotalsNetOfItemDiscounts:
boolean
A post food cost totals net of item discounts.Example:
false -
postOfflineTransactionsWithActualTransactionTime:
boolean
A post Offline checks to the database with the actual time stamp of the transaction.Example:
false -
postSalesNetOfVAT:
boolean
A post menu items, discounts, and service charges net of VAT.Example:
false
Nested Schema : LocationParams_security
Type:
objectAn object containing the attributes of the credentials of the system
Show Source
-
adminUser:
string
Admin Username for the property's workstations. Changes take effect when the workstations are restarted.Example:
user -
adminUserPassword:
string
The admin password for the property's workstations. Changes take effect when the workstations are restartedExample:
cfsdf@343% -
adminUserPasswordCompliance:
string
The current Admin User Password compliance status.Example:
Compliance Not Met -
dbUser:
string
The Database Username for the property's workstations.Example:
user -
dbUserPassword:
string
The Database Password for the property's workstations.Example:
cfsdf@343% -
dbUserPasswordCompliance:
string
The current Database User Password compliance status.Example:
Compliance Not Met -
installSecurityUser:
string
Install Security Username for the property's workstations.Example:
user -
installSecurityUserPassword:
string
Install Security password for the property's workstations.Example:
cfsdf@343% -
installSecurityUserPasswordCompliance:
string
the current Install Security Password compliance status.Example:
Compliance Not Met
Nested Schema : LocationParams_serialNumberInfo
Type:
objectAn object containing the details of the system serial numbers
Show Source
-
maxSerialNum1(required):
integer
The maximum value for system serial #1 (2 to 99999).Example:
maxSerialNum1 -
maxSerialNum2(required):
integer
The maximum value for system serial #2 (2 to 99999).Example:
99999 -
minSerialNum1(required):
integer
The minimum value for system serial #1 (1 to 99998).Example:
1 -
minSerialNum2(required):
integer
The minimum value for system serial #2 (1 to 99998).Example:
1
Nested Schema : serviceHosts
Type:
arrayAn array of service hosts associated with the location.
Show Source
Nested Schema : LocationParams_simphonyEssentials
Type:
objectObject containing the configuration settings for Simphony Essentials enabled organization
Show Source
-
fiscalLocationName:
string
Name of the Country associated with the Fiscal location.Example:
Mexico -
fiscalLocationNum:
integer
Select the Fiscal Location for this Property.Example:
1
Nested Schema : LocationParams_taiwanGUIParameters
Type:
objectAn object containing the Taiwan tax number prefix and the end of range tax threshold
Show Source
-
endOfRangeThreshold(required):
string
The end of range tax threshold.Example:
A23 -
taxNumPrefix:
string
The Taiwan tax number prefix. Maximum string length allowed is 2.Example:
TU
Nested Schema : LocationParams_timekeeping
Type:
objectAn object containing the timekeeping configuration for the location
Show Source
-
enableLaborManagement(required):
boolean
A use Labor Management for employee configuration.Example:
false -
printAccumulatedLaborShiftTotalsInClockInOutChits:
boolean
A print a single labor shift total hours worked by employees on clock-in/out chits.Example:
false -
printWTDTotalsInClockInOutChits:
boolean
A print week-to-date total hours worked by employees on clock-in/out chits.Example:
false -
propertyLaborManagementURL:
string
The URL if workstations use an external address when connecting to the Simphony Labor web service.Example:
myLabor.orcle.com
Nested Schema : LocationParams_workstationOptions
Type:
objectAn object containing the workstation options associated with the location
Show Source
-
dbUpdateFrequencyInSecs:
integer
The number of seconds the workstation and KDS Controllers wait to retrieve updates from the database.Example:
1800 -
defaultTransactionHelpScreenName:
object TranslatedStringdefaultTransactionHelpScreenName
A string that contains translations of defaultTransactionHelpScreenName into multiple languages
-
defaultTransactionHelpScreenObjNum:
integer
Object number of the Help Screen to show when the Help key is pressed on workstations.Example:
0 -
linesPerWSReportPage:
integer
The number of lines to print per page on workstation reports.Example:
0 -
onDemandReplayFrequencyCheck:
integer
The number of seconds for workstations to wait before checking for initiation of an on demand replay.Example:
0
Nested Schema : startOfDaySettings
Type:
arrayAn array of the start of day settings for the business week.
Show Source
Nested Schema : LocationParams_startOfPeriodSettings
Type:
objectAn object containing the start of period settings for the location
Show Source
-
otherPeriod1:
array otherPeriod1
An array of dates for the Other Period 1.
-
otherPeriod1PCAutoSeqName:
otherPeriod1PCAutoSeqName
Name of the PC autosequence of the Other Totals period 1.
-
otherPeriod1PCAutoSeqObjNum:
integer
Object number of the PC autosequence of Other Totals period 1.Example:
1 -
otherPeriod2:
array otherPeriod2
An array of dates for the Other Period 2.
-
otherPeriod2PCAutoSeqName:
otherPeriod2PCAutoSeqName
Name of the PC autosequence of the Other Totals period 2.
-
otherPeriod2PCAutoSeqObjNum:
integer
Object number of the PC autosequence of Other Totals period 2.Example:
1 -
otherPeriod3:
array otherPeriod3
An array of dates for the Other Period 3.
-
otherPeriod3PCAutoSeqName:
otherPeriod3PCAutoSeqName
Name of the PC autosequence of the Other Totals period 3.
-
otherPeriod3PCAutoSeqObjNum:
integer
Object number of the PC autosequence of Other Totals period 3.Example:
1 -
sOMAlternateDates:
array sOMAlternateDates
An array of alternate dates for the start of month.
-
sOMPCAutoSeqName:
sOMPCAutoSeqName
Name of the PC autosequence of start of month.
-
sOMPCAutoSeqObjNum:
integer
Object number of the PC autosequence of start of month.Example:
1 -
sOPPCAutoSeqName:
sOPPCAutoSeqName
Name of the PC autosequence of start of period.
-
sOPPCAutoSeqObjNum:
integer
Object number of the PC autosequence of start of period.Example:
1 -
sOQAlternateDates:
array sOQAlternateDates
An array of alternate dates for the start of quarter. Applicable only if useSOQAlternateDates = true
-
sOQPCAutoSeqName:
sOQPCAutoSeqName
Name of the PC autosequence of start of quarter.
-
sOQPCAutoSeqObjNum:
integer
Object number of the PC autosequence of start of quarter.Example:
1 -
sOWPCAutoSeqName:
sOWPCAutoSeqName
Name of the PC autosequence of start of week
-
sOWPCAutoSeqObjNum:
integer
Object number of the PC autosequence of start of week.Example:
1 -
sOYAlternateDates:
array sOYAlternateDates
An array of dates for the start of year
-
sOYPCAutoSeqName:
sOYPCAutoSeqName
Name of the PC autosequence of start of year.
-
sOYPCAutoSeqObjNum:
integer
Object number of the PC autosequence of start of year.Example:
1 -
startOfMonth:
integer
The day of the month that represents the start of the business month.Example:
1 -
startOfPayPeriod:
string
String representing the start of pay periodExample:
BiWeekly -
startOfQuarter:
string
A string representing the start dates for the quarter in MM/DD formatExample:
1/4 , 4/1, 7/1, 10/1 -
startOfWeek:
integer
The day of the week that represents the start of the business week.Example:
1 -
startOfYear:
integer
Month for the start of the yearExample:
1 -
useSOMAlternateDates:
boolean
A use user-defined dates for this period, instead of standard calendar periodsExample:
false -
useSOQAlternateDates:
boolean
A use user-defined dates for this period, instead of standard calendar periods.Example:
false
Nested Schema : LocationParams_startOfDaySettings
Type:
Show Source
object-
dayOfWeek:
integer
A number representing the day of the weekExample:
1 -
pcAutoSequenceName:
pcAutoSequenceName
Name of the PC Autosequence to run immediately after the given business day begins
-
pcAutoSequenceObjNum:
integer
Object number of the PC Autosequence to run immediately after the given business day begins.Example:
0 -
runManually:
boolean
A manually run the start of day for this business date.Example:
false -
time:
string
The start time of the start of day for given day of the week.Example:
03:00
Nested Schema : pcAutoSequenceName
Name of the PC Autosequence to run immediately after the given business day begins
Match All
Show Source
Nested Schema : TranslatedString_SequenceName
Type:
objectExample:
{
"en-US":"Sequence",
"de-DE":"Reihenfolge",
"es-MX":"Secuencia"
}Nested Schema : otherPeriod1PCAutoSeqName
Name of the PC autosequence of the Other Totals period 1.
Match All
Show Source
Nested Schema : otherPeriod2PCAutoSeqName
Name of the PC autosequence of the Other Totals period 2.
Match All
Show Source
Nested Schema : otherPeriod3PCAutoSeqName
Name of the PC autosequence of the Other Totals period 3.
Match All
Show Source
Nested Schema : sOMAlternateDates
Type:
arrayAn array of alternate dates for the start of month.
Show Source
Nested Schema : sOMPCAutoSeqName
Name of the PC autosequence of start of month.
Match All
Show Source
Nested Schema : sOPPCAutoSeqName
Name of the PC autosequence of start of period.
Match All
Show Source
Nested Schema : sOQAlternateDates
Type:
arrayAn array of alternate dates for the start of quarter. Applicable only if useSOQAlternateDates = true
Show Source
Nested Schema : sOQPCAutoSeqName
Name of the PC autosequence of start of quarter.
Match All
Show Source
Nested Schema : sOYPCAutoSeqName
Name of the PC autosequence of start of year.
Match All
Show Source
Nested Schema : LocationParameters_AlternateDates
Type:
Show Source
object-
date:
string
Date of the start of monthExample:
12/01/2021 -
number:
integer
Sequence number of the date of the start of monthExample:
1
Nested Schema : LocationParams_backupSMTPServer
Type:
objectAn object containing the backup SMTP server details for email configuration of the property.
Show Source
-
isSSL:
boolean
A require secure Internet communication.Example:
false -
name:
string
The business name or name to appear along with the email in the sender field.Example:
Admin -
password:
string
The password associated with the email user name.Example:
aaddsfgf@34 -
port:
integer
The port number for the SMTP email server. A default port of 587 works for most SMTP servers.Example:
587 -
server:
string
URL of the email server or service.Example:
smtp.mail.com -
sourceEmail:
string
The full email address to appear as the sender in the emailed receipt.Example:
admin@oracle.com -
username:
string
The user name of the email address that sends receipts.Example:
test
Nested Schema : LocationParams_htmlFormatting
Type:
objectAn object containing the text formatting settings of the email configuration of the location.
Show Source
-
emailBody:
string
Text in rich text format to appear as the body of email receipts.Example:
HTML Email Body -
emailSubject:
string
Text in rich text format to appear as the subject line of email receipts.Example:
Subject
Nested Schema : LocationParams_primarySMTPServer
Type:
objectAn object containing the primary SMTP server settings of the location.
Show Source
-
bccList:
string
The email addresses to receive a blind carbon copy of the email receipt that is sent to the guest.Example:
admin2@oracle.com; admin3@oracle.com -
isSSL:
boolean
A require secure Internet communication.Example:
false -
name:
string
The business name or name to appear along with the email in the sender field.Example:
Admin -
password:
string
The password associated with the email user name.Example:
aaddsfgf@34 -
port:
integer
The port number for the SMTP email server. A default port of 587 works for most SMTP servers.Example:
587 -
server:
string
URL of the email server or service.Example:
smtp.mail.com -
sourceEmail:
string
The full email address to appear as the sender in the emailed receipt.Example:
admin@oracle.com -
username:
string
The user name of the email address that sends receipts.Example:
test
Nested Schema : LocationParams_textFormatting
Type:
objectAn object containing the text formatting settings of the email configuration of the location.
Show Source
-
emailBody:
string
Text in rich text format to appear as the body of email receipts.Example:
Email Body -
emailSubject:
string
Text in rich text format to appear as the subject line of email receipts.Example:
Subject
Nested Schema : LocationParams_language
Type:
objectAn array of languages that are available at the property.
Show Source
-
languageName:
string
The name of the language.Example:
English -
languageNum:
integer
The index of the language configured.Example:
1 -
languageObjNum:
integer
Object number of the language.Example:
1
Nested Schema : LocationParams_serviceHosts
Type:
Show Source
object-
port:
integer
Port of the service host associated with the location.Example:
8080 -
serviceHostName:
object TranslatedString_serviceHostName
A string that contains translations of serviceHostName into multiple languages
-
serviceHostObjNum:
integer
Object number of the service host associated with the locationExample:
4715 -
serviceID:
integer
Unique ID of the service host.Example:
4715 -
type:
string
Type of the service hostExample:
Check and Posting -
url:
string
URL of the service host associated with the locationExample:
egateway/egateway.asmx
Nested Schema : TranslatedString_serviceHostName
Type:
objectA string that contains translations of serviceHostName into multiple languages
Example:
{
"en-US":"Service Host",
"de-DE":"Service-Host",
"es-MX":"Anfitri??n del servicio"
}Nested Schema : TranslatedStringdefaultTransactionHelpScreenName
Type:
objectA string that contains translations of defaultTransactionHelpScreenName into multiple languages
Example:
{
"en-US":"Help Screen",
"de-DE":"Hilfebildschirm",
"es-MX":"Pantalla de ayuda"
}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