Add Locations
post
/config/sim/v1/hierarchy/locations
Add Location object to a specified hierarchy unit of specified organization. After inserting the Location, the corresponding Location Parameter needs to be added manually.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that Identifies that who made the change
Location object of the organization
Root Schema : LocationInsertRequestBody
Type:
objectModel for Location Object
Show Source
-
address1:
string
The address line 1 for the property.Example:
Address Line 1 -
address2:
string
The address line 2 for the property.Example:
Address Line 2 -
address3:
string
The address line 3 for the property.Example:
1 -
city:
string
The city for the propertyExample:
City -
comment:
string
Additional information about the property.Example:
Comment -
consumerFacingName:
object consumerFacingName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the consumer facing name in the configured languages
-
countryCode:
string
The country code for the property.Example:
US -
dataExtensions:
array dataExtensions
An array of data extensions
-
inventoryEnabled:
boolean
Flag indicating if inventory is enabled,Example:
false -
laborEnabled:
boolean
Flag indicating if enterprise labor is enabled,Example:
false -
laborLogin:
string
The username to use to connect to the Simphony Labor Service. Either both laborLogin and laborPassword have to be null or non-null.Example:
user123 -
laborPassword:
string
The password to use to log on to the Simphony Labor Service. Either both laborLogin and laborPassword have to be null or non-null.Example:
slkdrtj132@!#$1 -
latitude:
string
The property latitude. Latitude must be within range -90 to +90Example:
12.23 -
localeInfoId:
integer
Unique reference of the locale for the property to determine the use of decimal or thousand separators.Example:
1 -
locRef(required):
string
The unique reference for the location in Simphony ReportingExample:
Loc1 -
longitude:
string
The property longitude. Longitude must be between -180 and 180Example:
12.34 -
name(required):
object name
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
objectNum(required):
integer
Object number of the hierarchy unitExample:
1 -
phone:
string
The phone number of the property. If it is not null, the phoneCountryCode is required.Example:
1234567890 -
phoneCountryCode:
string
The phone number country code of the property. It cannot be null when assigning a phone number to the property.Example:
US -
reportingLocName(required):
string
The location name created in Simphony Reporting.Example:
Location1 -
reportingParentEnterpriseLevelName(required):
string
The name of the parent organization level under which this location is to be reported.Example:
District -
stateOrRegion:
string
The state or region for the property. It cannot be null when stateOrRegionCode is not null.Example:
New York -
stateOrRegionCode:
string
The state or region code for the property. It cannot be null when stateOrRegion is not null.Example:
NY -
tZIndex(required):
integer
The index time zone of the property.Example:
20 -
zipOrPostalCode:
string
The state or region for the property. The ZIP or postal code for the property.Example:
YXA123
Nested Schema : consumerFacingName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the consumer facing name in the configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : name
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : items
Type:
Show Source
object-
columnName:
string
Name of the extension fieldExample:
extension column 1 -
value:
string
Value of the extension fieldExample:
Value1
Response
Supported Media Types
- application/json
200 Response
Location object of the organization
Root Schema : LocationResponse
Type:
Show Source
object-
hierUnitId(required):
integer
unique hierarchy unit valueExample:
1 -
objectNum(required):
integer
Object number of the printerExample:
1
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