Get Locations
post
/config/sim/v1/hierarchy/getLocations
Gets all the locations
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-OrgShortName: string(string)
Org Identifier
A request body
Root Schema : LocationGetRequestBody
Type:
objectThe input Body model that needs to be given.
Show Source
-
include(optional):
string
Objects included in response
-
languages(optional):
string
If specified, limits translated strings returned
-
limit(optional):
integer
If using paging, number of results returned in this page.
-
offset(optional):
integer
Starting resource record index. Not required if paging parameters are not supported
-
orderBy(optional):
integer
Sorts the response by the specified field name and sort order.
-
searchCriteria(optional):
string
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
A collection of Location entities in an organization.
Root Schema : Location
Type:
objectModel for Location Object
Show Source
-
address1(optional):
string
The address line 1 for the property.Example:
Address Line 1 -
address2(optional):
string
The address line 2 for the property.Example:
Address Line 2 -
address3(optional):
string
The address line 3 for the property.Example:
1 -
city(optional):
string
The city for the propertyExample:
City -
comment(optional):
string
Additional information about the property.Example:
Comment -
consumerFacingName(optional):
object consumerFacingName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the consumer facing name in the configured languages
-
country(optional):
string
The country for the property.Example:
United States -
hierUnitId(optional):
integer
Unique reference of the hierarchy unit of the propertyExample:
2 -
latitude(optional):
string
The property latitude. Latitude must be within range -90 to +90Example:
12.23 -
localeInfoId(optional):
integer
Unique reference of the locale for the property to determine the use of decimal or thousand separators.Example:
1 -
localeName(optional):
object localeName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the locale for the property to determine the use of decimal or thousand separators in configured languages.
-
longitude(optional):
string
The property longitude. Longitude must be between -180 and 180Example:
12.34 -
name:
object name
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
objectNum:
integer
Object number of the hierarchy unitExample:
1 -
phone(optional):
string
The phone number of the propertyExample:
1234567890 -
stateOrRegion(optional):
string
The state or region for the property.Example:
Region -
tZIndex:
integer
The index time zone of the property.Example:
20 -
tzName(optional):
string
The name time zone of the property.Example:
(GMT-06:00) Central Time (US and Canada) -
zipOrPostalCode(optional):
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",
"es-SS":"Empresa",
"lt=LT":"??mon??"
}Nested Schema : localeName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the locale for the property to determine the use of decimal or thousand separators in configured languages.
Example:
{
"en-US":"Locale 1",
"es-SS":"",
"lt=LT":""
}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",
"es-SS":"Empresa",
"lt=LT":"??mon??"
}400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(optional):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(optional):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(optional):
integer
Error code of the problemExample:
55223 -
status(optional):
integer
HTTP status code.Example:
400 -
title(optional):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(optional):
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