Basic Service

Registering services and subscribing notifications

Functions

Result	Name / Params			Comment
bool	RegisterService			Registers functions and notifications that can be used immediately afterwards by a consumer.
		functions	string[]	(Optional) List of provided functions.
		notifications	string[]	(Optional) List of provided notifications.
bool	UnregisterService			Removes functions and notifications that were registered before.
		functions	string[]	(Optional) List of functions to unregister.
		notifications	string[]	(Optional) List of notifications to unregister.
RegisterHttpEndpointResult	RegisterHttpEndpoint ≥aop 0.4.0			Registers HTTP endpoints.
		tlsServerFingerprint	string	SHA-256 hash of the ephemeral TLS certificate used by the HTTP server hosting the Extension-provided endpoints, encoded as hex string.
		endpoints	HttpEndpoint[]	The endpoints to register.
bool	SubscribeNotification			Subscribes to a notification.
		notification	string	Name of notification to subscribe to.
		params	value{}	Additional, subscription specific parameters (see individual notifications for further details).
bool	UnsubscribeNotification			Unsubscribes from notifications.
bool		notifications	string[]	List of notifications to unsubscribe from.
SessionInfo	GetSessionInfo ≥aop 0.3.0			Returns information about a session.
SessionInfo		session	string	ID of the session to retrieve information about.
MethodDesc[]	GetFunctions			Returns a list with all available functions.
MethodDesc[]	GetNotifications			Returns a list with all available notifications.

Notifications

Name / Params			Comment
ServiceRegistered			Triggered when a service is registered.
	client	string	(Optional) ID of the client that is providing the service.
	functions	string[]	(Optional) Added functions.
	notifications	string[]	(Optional) Added notifications.
ServiceUnregistered			Triggered when a service is unregistered and thus removing its functions and notifications.
	client	string	(Optional) ID of the client that was providing the service.
	functions	string[]	(Optional) Removed functions.
	notifications	string[]	(Optional) Removed notifications.

Objects

HttpEndpoint ≥aop 0.4.0

Property	Type	Description
Url	string	Absolute URL to forward requests to. Typically, but not necessarily hosted by the Extension. Example: “https://localhost:27365/some/path”. Note that plain HTTP is not allowed here.
MappedPath	string	Relative path for routing, e.g., “/my/endpoint”.
Methods	RequestPolicy[]	Possible request methods with access permissions.

RequestPolicy ≥aop 0.4.0

Property	Type	Description
Method	string	Permissable HTTP request method. See EnumRequestMethod.
Permission	string	(Optional) See EnumPermission.
Authentication	string	See EnumAuthenticationRequirement.

RegisterHttpEndpointResult ≥aop 0.4.0

Property	Type	Description
TlsClientFingerprint	string	TLS certificate fingerprint used by the client (e.g., upstream server), as a SHA-256 hash.
MappedBaseUrl	string	Base URL under which the registered endpoints are made available by the hosting application, e.g., “https://wgserver:1234/ext/myclientId/”. Can be used as prefix for ‘MappedPath’s if the Extension needs to expose absolute URLs to its mapped endpoints.

SessionInfo ≥aop 0.3.0

Property	Type	Description
Client	string	ID of the client the session is associated with.
Station	string	Code of the station the session is associated with (if available).
User	string	Code of the user the session is associated with (if available).
Profile	SessionProfileInfo	Additional info regarding active profiles (if available).

SessionProfileInfo ≥aop 0.3.0

Property	Type	Description
User	string	ID of the active user profile (if available).
Station	string	ID of the active station profile (if available).
Functions	string[]	List of function profile IDs (if available).
Rights	string[]	List of right profile IDs (if available).

MethodDesc

Property	Type	Description
Name	string	The method’s name.
Clients	string[]	List of client IDs that provide the specific method.

Enums

EnumPermission ≥aop 0.4.0

Name	Value	Description
Read	read	`api.read` right required to access this endpoint.
Write	write	`api.write` right required to access this endpoint.
Control	control	`api.control` right required to access this endpoint.

EnumAuthenticationRequirement ≥aop 0.4.0

Name	Value	Description
None	none	Any unauthenticated client may access this endpoint. Access permissions are not checked.
Session	session	Only authenticated clients may access this endpoint, i.e., the session header must identify an active IPC session. Configured access permissions are checked.

EnumRequestMethod ≥aop 0.4.0

Name	Value	Description
GET	GET	Requests a representation of the specified resource.
POST	POST	Submits an entity to the target resource.
PUT	PUT	Requests that the enclosed entity be stored.
OPTIONS	OPTIONS	Requests information about the communication options available for the target resource or server.

Last modified September 25, 2026