Get a list of locations

  • Updated on Aug 9, 2024
  • Published on Aug 8, 2024
  • 1 minute(s) reading time
Prev Next
Get
/v{version}/Locations

Locations are searched from top to bottom, starting with the start location. Locations are implicitly filtered by the user's read permission.

Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Default"1.17"
Query parameters
startId
integer (int32)

Unique ID of the start location

Maximum2147483647.0
Minimum0.0
depth
integer (int32)

Depth of the search

Maximum255.0
Minimum0.0
name
string

Name of the location

categoryId
array of integer

Unique ID of the category

hasPlayer
boolean

If true, the returned locations must have at least one player. If the parameter is not specified (default), the locations are returned regardless of whether the location has a player or not.

isLeaf
boolean

If true, the returned locations don't have any child location. If the parameter is not specified (default), the locations are returned regardless of whether the location has any child location or not.

includePermissions
boolean

If true, the property Permissions is populated with the location's permissions. Default: true.

includeAdditionalData
boolean

If true, the returned locations should include the additional data. Default: false.

Responses
200

OK

Array of object
object

Location

Id
integer (int32)

Unique ID of the location

ParentId
integer (int32)

Unique ID of the parent location

Maximum2147483647.0
Minimum1.0
Name
string

Name of the location

Country
string

Country of the location

City
string

City of the location

ZipCode
string

ZIP code of the location

Address
string

Address of the location

Email
string

Email address of the location

Fax
string

Fax number of the location

CategoryIds
Array of integer

List of category IDs of the location

integer (int32)
HolidayListIds
Array of integer

List of holiday list IDs of the location

integer (int32)
AdditionalData
object

List of additional data of the location

property*
string additionalProperties
Permissions
object

Permissions.

Read
boolean
Write
boolean
ReceiveMessage
boolean
Created
string (date-time)

Creation date in UTC

Modified
string (date-time)

Modification date in UTC

400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Access denied

Expand All
object
Id
string
Type
string
Message
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Type
string
Message
string
Values
object
property*
object additionalProperties