Get Locations
post
/config/sim/v2/hierarchy/getLocations
Gets all the locations
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : LocationGetRequestBodyv2
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
Objects included in responseExample:
hierUnitId, objectNum, locRef -
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 -
langIds:
string
If specified, limits translated strings returned.Example:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.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:asc -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Location entities in an organization.
Root Schema : LocationGetResponsev2
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Location objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Location objects of the organization.
Show Source
-
Array of:
object Locationv2
Model for Location Object
Nested Schema : Locationv2
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
A group of string objects representing the consumer facing name in the configured languages
-
country:
string
The country for the property.Example:
United States -
countryCode:
string
The country code for the property.Example:
US -
dataExtensions:
array dataExtensions
An array of data extensions
-
hierStrucId:
integer
Unique reference of the hierarchy structure of the property. Excluded by default.Example:
2 -
hierUnitId:
integer
Unique reference of the hierarchy unit of the propertyExample:
2 -
inventoryEnabled:
boolean
Flag indicating if inventory is enabled. Search operation using this field is not allowed.Example:
false -
laborEnabled:
boolean
Flag indicating if enterprise labor is enabled. Search operation using this field is not allowed.Example:
false -
laborLogin:
string
The username to use to connect to the Simphony Labor Service. Search operation using this field is not allowed.Example:
user123 -
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:
string
Unique string of the Location Reference of the property.Example:
Loc1 -
longitude:
string
The property longitude. Longitude must be between -180 and 180Example:
12.34 -
name:
object name
A group of string objects representing the name of the hierarchy unit configured languages
-
objectNum:
integer
Object number of the hierarchy unitExample:
1 -
phone:
string
The phone number of the propertyExample:
1234567890 -
phoneCountryCode:
string
The phone number country code of the property.Example:
US -
phoneNumberPrefix:
integer
The phone number prefix of the property.Example:
1 -
reportingLocName:
string
The location name created in Simphony Reporting. Search operation using this field is not allowed.Example:
Location1 -
reportingParentEnterpriseLevelName:
string
The name of the parent organization level under which this location is to be reported. Search operation using this field is not allowed.Example:
District -
stateOrRegion:
string
The state or region for the property.Example:
New York -
stateOrRegionCode:
string
The state or region code for the property.Example:
NY -
tZIndex:
integer
The index time zone of the property.Example:
20 -
tzName:
string
The name time zone of the property.Example:
(GMT-06:00) Central Time (US and Canada) -
zipOrPostalCode:
string
The state or region for the property. The ZIP or postal code for the property.Example:
YXA123
Nested Schema : consumerFacingName
Type:
objectA group of string objects representing the consumer facing name in the configured languages
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : name
Type:
objectA group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"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
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