Locations are searched from top to bottom, starting with the start location.
Locations are implicitly filtered by the user's read
permission.
Api Key
Session Id
The requested API version
Unique ID of the category
Depth of the search
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.
If true
, the returned locations should include the additional data.
Default: false
.
If true
, the property Permissions
is populated with the location's permissions.
Default: true
.
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.
Name of the location
Unique ID of the start location
OK
Location
List of additional data of the location
Address of the location
List of category IDs of the location
City of the location
Country of the location
Creation date in UTC
Email address of the location
Fax number of the location
List of holiday list IDs of the location
Unique ID of the location
Modification date in UTC
Name of the location
Unique ID of the parent location
Permissions.
ZIP code of the location
Bad request
Access denied
Unexpected error