1. Configuration and Content API Guide
  2. Tasks
  3. Hierarchy
  4. Location Parameters

Add Location Parameters

post

/config/sim/v1/hierarchy/locationParameters

Add the Location to the specified organization.

Request

Supported Media Types
Header Parameters
Body ()
Request body
Root Schema : LocationParameters
Type: object
Show Source
Nested Schema : LocationParams_calendar
Type: object
An object containing the calendar settings for the location
Show Source
Nested Schema : LocationParams_emailConfiguration
Type: object
An object containing the email configuration for the location
Show Source
Nested Schema : LocationParams_language
Type: object
An array of languages that are available at the property.
Show Source
Nested Schema : locName
Type: object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the location configured languages
Example:
{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"?mon?"
}
Nested Schema : LocationParams_optionsExt
Type: object
An object containing the descriptive options list associated with the location parameter.
Show Source
Nested Schema : LocationParams_postingOptionsExt
Type: object
An object containing the descriptive options list associated with the location parameter.
Show Source
Nested Schema : LocationParams_security
Type: object
An object containing the attributes of the credentials of the system
Show Source
Nested Schema : LocationParams_serialNumberInfo
Type: object
An object containing the details of the system serial numbers
Show Source
Nested Schema : serviceHosts
Type: array
An array of service hosts associated with the location.
Show Source
Nested Schema : LocationParams_simphonyEssentials
Type: object
Object containing the configuration settings for Simphony Essentials enabled organization
Show Source
Nested Schema : LocationParams_taiwanGUIParameters
Type: object
Show Source
Nested Schema : LocationParams_timekeeping
Type: object
An object containing the timekeeping configuration for the location
Show Source
Nested Schema : LocationParams_workstationOptions
Type: object
An object containing the workstation options associated with the location
Show Source
Nested Schema : startOfDaySettings
Type: array
An array of the start of day settings for the business week.
Show Source
Nested Schema : LocationParams_startOfPeriodSettings
Type: object
An object containing the start of period settings for the location
Show Source
Nested Schema : LocationParams_startOfDaySettings
Type: object
Show Source
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: object
Example:
{
    "en-US":"Sequence",
    "de-DE":"Reihenfolge",
    "ar-AR":"??????????????????"
}
Nested Schema : otherPeriod1
Type: array
An array of dates for the Other Period 1.
Show Source
Nested Schema : otherPeriod1PCAutoSeqName
Name of the PC autosequence of the Other Totals period 1.
Match All
Show Source
Nested Schema : otherPeriod2
Type: array
An array of dates for the Other Period 2.
Show Source
Nested Schema : otherPeriod2PCAutoSeqName
Name of the PC autosequence of the Other Totals period 2.
Match All
Show Source
Nested Schema : otherPeriod3
Type: array
An array of dates for the Other Period 3.
Show Source
Nested Schema : otherPeriod3PCAutoSeqName
Name of the PC autosequence of the Other Totals period 3.
Match All
Show Source
Nested Schema : sOMAlternateDates
Type: array
An 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: array
An 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 : sOWPCAutoSeqName
Name of the PC autosequence of start of week
Match All
Show Source
Nested Schema : sOYAlternateDates
Type: array
An array of dates for the start of year
Show Source
Nested Schema : sOYPCAutoSeqName
Name of the PC autosequence of start of year.
Match All
Show Source
Nested Schema : LocationParameters_AlternateDates
Type: object
Show Source
Nested Schema : LocationParams_backupSMTPServer
Type: object
An object containing the backup SMTP server details for email configuration of the property.
Show Source
Nested Schema : LocationParams_htmlFormatting
Type: object
An object containing the text formatting settings of the email configuration of the location.
Show Source
Nested Schema : LocationParams_primarySMTPServer
Type: object
An object containing the primary SMTP server settings of the location.
Show Source
Nested Schema : LocationParams_textFormatting
Type: object
An object containing the text formatting settings of the email configuration of the location.
Show Source
Nested Schema : LocationParams_serviceHosts
Type: object
Show Source
Nested Schema : TranslatedString_serviceHostName
Type: object
A string that contains translations of serviceHostName into multiple languages
Example:
{
    "en-US":"Service Host",
    "de-DE":"Service-Host",
    "ar-AR":"?????????????? ????????????"
}
Nested Schema : TranslatedStringdefaultTransactionHelpScreenName
Type: object
A string that contains translations of defaultTransactionHelpScreenName into multiple languages
Example:
{
    "en-US":"Help Screen",
    "de-DE":"Hilfebildschirm",
    "ar-AR":"???????? ????????????????"
}
Back to Top

Response

Supported Media Types

200 Response

A response body for Location Parameters
Body ()
Root Schema : LocationParametersResponse
Type: object
Show Source

400 Response

400 Bad Request
Body ()
Root Schema : ErrorDetails
Type: object
Response body when the request returns an error.
Show Source
Back to Top