Service: Station

Reading and editing the stations

Functions

Result	Name / Params			Comment
GetResult	station.Get			Returns a filtered list of Station 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. (Max : 100000)
GetResult	station.Get			Returns a filtered list of Station 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. (Max : 100000)
Station	station.GetOne			Returns a single Station Object identified by the given id.
		id	guid	The Station's id.
		select	string[]	(Optional) List of properties that should be contained in the result object.
guid	station.Create			Creates the Station in the system and returns the id of the Station. The Station must not have an id. If an id is set, the creation is rejected and an empty id is returned.
guid		object	Station	The Station to create.
bool	station.Update			Updates a Station with data from the provided Object.
bool		object	Station	Station to update
bool	station.Set			Sets specific properties of a Station Object.
		id	guid	Id of the Station 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	station.Delete			Deletes a Station Object. Returns true if successfully deleted or if no such Object existed to begin with.
bool		id	guid	Id of the Station to delete.
bool	station.BulkModify			Performs a bulk of changes at once.
		create	Station[]	(Optional) List of Station Objects to create.
		update	Station[]	(Optional) List of Station Objects to update.
		set	ObjectAspect[]	(Optional) List of Station Object properties to set.
		delete	guid[]	(Optional) List of Station ids to delete.

Notifications

Name / Params			Comment
station.Created			Notifies about new Station Objects.
	objects	Station[]	Newly created Station Objects.
station.Updated			Notifies about updated Station Objects.
	objects	Station[]	Changed Station Objects.
station.Deleted			Notifies about deleted Station Objects.
	ids	guid[]	Ids of the deleted Station Objects.
station.State			Notifies about state changes.
	states	StationState[]	Modified states.

Objects

Station

Property	Type	Description
Id	guid	(Unique, Readonly)
SegmentIds	guid[]	Assigned segments.
Num	int	(Unique) (Deprecated) Station number, used as unique identifier for the station.
Code ≥wg 0.5.0	string	(Unique) Station code, used as unique identifier for the station. Only values which can be converted to [1,4094] are allowed (similar to X4 extension code).
Type ≥wg 0.5.0	int	See EnumStationType.
Name	string	(Localized) Station name
Desc	string	(Localized)
Address ≥wg 0.5.0	string	Default address to reach the station.
Port ≥wg 0.5.0	int	Default port to reach the station.
Flags	int	See EnumStationFlags.
LocationId	guid
ProfileIds	guid[]	Assigned profiles.
Destinations ≥wg 0.5.0	string[]	Uplink station codes for this station.
EffectiveDestinations ≥wg 0.5.0	string[]	(Computed) Effective uplink stations for this station. This is a dynamic property that heeds current active server information.
GroupName ≥wg 0.5.0	string	A name to group stations.
GroupRank ≥wg 0.5.0	int	Rank within the associated station group (the lower the more important).
Certificate	string	Station’s assigned certificate fingerprint (hash).
State ≥wg 0.5.0	StationState	(Not in default set, Computed)
EditTime	time	(Readonly, Not in default set)
EditUser	string	(Readonly, Not in default set)

StationState ≥wg 0.5.0

Property	Type	Description
StationCode	string	Station code, identifying the station to which the state belongs. This is only set inside notifications.
RequiredAction ≥wg 0.5.5	int	Indicates whether the station must reconnect or restart for configuration changes to take effect. See EnumRequiredAction.
User	string	The user currently logged in to the station.
License	string	The license currently used for the station.
UpConnections	UpConnection[]	All current up-connections of this station. Disconnected connections are not listed.

UpConnection ≥wg 0.5.0

Property	Type	Description
StationCode	string	Station code, identifying the connection target station.
Active	bool	Indicates whether the connection is currently active or inactive.

Enums

EnumStationType ≥wg 0.5.0

Name	Value	Description
Standalone	0
Server	1
LocalServer	2	Client (with local server functionality)
ExtensionServer	3	Client (with extension server)
Client	4
Display	5
Floating	6	AOP client (e.g. web client)
Unknown ≥wg 0.6.2	65535	Invalid type

EnumStationFlags (Flags)

Name	Value	Description
UsedForCOP	0x2
Exposed	0x8	Not allowed for server and local server

Last modified September 25, 2026