Service: Location

Reading, editing and operating locations

Functions

Result	Name / Params			Comment
GetResult	location.Get			Returns a filtered list of Location Objects.
		filter	string	(Optional) Filter expression which determines the result set.
		select	string[]	(Optional) List of properties that should be contained in the result objects.
		limit	int	(Optional) Maximum amount of Objects that should be returned.
GetResult	location.Get			Returns a filtered list of Location Objects as a follow up to a previous Get call.
		context	string	The context received within the last get result. Mandatory for subsequent get calls with pagination.
		scroll	int	Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. See EnumPaginationScroll.
		offset	int	(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination.
		limit	int	(Optional) Maximum amount of Objects that should be returned.
Location	location.GetOne			Returns a single Location Object identified by the given id.
		id	guid	The Location's id.
		select	string[]	(Optional) List of properties that should be contained in the result object.
guid	location.Create			Creates the Location in the system and returns the id of the Location. The Location must not have an id. If an id is set, the creation is rejected and an empty id is returned.
guid		object	Location	The Location to create.
bool	location.Update			Updates a Location with data from the provided Object.
bool		object	Location	Location to update
bool	location.Set			Sets specific properties of a Location Object.
		id	guid	Id of the Location to modify.
		props	value{}	List of properties that should be set. Property paths may be used as ids to address any partial aspect of the Object.
bool	location.Delete			Deletes a Location Object. Returns true if successfully deleted or if no such Object existed to begin with.
		id	guid	Id of the Location to delete.
		deleteDependents	bool	(Optional) If set to true descendant of the Object identified by 'id' will also be deleted. If the parameter is not set, the default value is false.
bool	location.BulkModify			Performs a bulk of changes at once. The changes are applied transactionally, so if any of the individual changes fails, none of the changes are applied.
		create	Location[]	(Optional) List of Location Objects to create.
		update	Location[]	(Optional) List of Location Objects to update.
		set	ObjectAspect[]	(Optional) List of Location Object properties to set.
		delete	guid[]	(Optional) List of Location ids to delete.
		deleteDependents	bool	(Optional) If set to true descendant of the Object identified by 'id' will also be deleted. If the parameter is not set, the default value is false.

Notifications

Name / Params			Comment
location.Created			Notifies about new Location Objects.
	objects	Location[]	Newly created Location Objects.
location.Updated			Notifies about updated Location Objects.
	objects	Location[]	Changed Location Objects.
location.Deleted			Notifies about deleted Location Objects.
	ids	guid[]	Ids of the deleted Location Objects.

Objects

Location

Property	Type	Description
Id	guid	(Unique, Readonly)
ParentId	guid
SegmentId	guid
Order	string	(Unique) Defines the sequential order of the Objects. Should contain only letters A-Z, must never end with ‘A’.
Type	int	Assigned data segment. See EnumLocationType.
Name	string	(Localized) The location’s name.
Desc	string	(Localized) User defined description.
TimeZoneId ≥wg 0.6.1	string	The IANA ID which defines the time zone of the location
Tags	string	Tags enclosed in vertical bars (pipes), such as “\|tag1\|tag2\|tag3\|”.
Graphic	string	Graphic file string with params.
Text	string	Text file string with params.
ExtRef	string	Optional reference for external mapping.
GeoPos	GeoPosition	Geographical coordinates.
EffectiveTags	string	(Computed) Effective list tags (assigend or inherited), enclosed in vertical bars (pipes), such as “\|tag1\|tag2\|tag3\|”.
EffectiveText	string	(Computed) Effective text (with inheritance).
EffectiveGraphic	string	(Computed) Effective graphics(with inheritance).
EffectiveGeoPos	GeoPosition	(Computed) Geographical coordinates (assigned or inherited).
EffectivePath ≥wg 0.4.11	string	(Computed) The full location path showing the complete hierarchy
EffectiveTimeZoneId ≥wg 0.6.1	string	(Computed) Effective time zone ID (with inheritance)
EditTime	time	(Readonly, Not in default set)
EditUser	string	(Readonly, Not in default set)

GeoPosition

Property	Type	Description
Latitude	float	(DistinctNull)
Longitude	float	(DistinctNull)
Altitude	float	(DistinctNull)

Enums

EnumLocationType

Name	Value	Description
Auto	0
Facility	10
Building	11
Floor	12
Room	13
Point	14

Last modified September 25, 2026