Alert Web Service Interface

Version 1.2 — Edition: 2025-09-11

About This Document

Purpose

This document describes the interface between the outside world and the Management System through a Web Service Interface (Web API). It describes how the interface is to be accessed and what data in what format are exchanged.

Scope

The document provides a description of the public API which can be used to access data and the functionality provided by the system platform. This document applies to the system version 1.0.

Target Audience

• Testers of the public API
• Developers/Clients accessing the public API

Cyber Security Disclaimer

Micromedia products and solutions provide security functions to ensure the secure operation of building comfort, fire safety, security management and physical security systems. The security functions on these products and solutions are important components of a comprehensive security concept.

It is, however, necessary to implement and maintain a comprehensive, state-of-the-art security concept that is customized to individual security needs. Such a security concept may result in additional site-specific preventive action to ensure that the building comfort, fire safety, security management or physical security system for your site are operated in a secure manner. These measures may include, but are not limited to, separating networks, physically protecting system components, user awareness programs, defense in depth, etc.

For additional information on building technology security and our offerings, contact Micromedia sales department. We strongly recommend customers to follow our security advisories, which provide information on the latest security threats, patches and other mitigation measures.

Document Revision History

Index	Edition Date	Brief Description
A	2019-04-25	First Release Edition
B	2024-04-01

Introduction

References

Links

Ref.	Abbreviation	Link Description
[1]	HAL	http://stateless.co/hal_specification.html
[2]	SignalR	https://github.com/SignalR/SignalR/wiki
[3]	Base64url	http://www.ietf.org/rfc/rfc4648.txt
[4]	OAuth	https://tools.ietf.org/html/rfc6749
[5]	Language-Tags	http://tools.ietf.org/html/rfc5646
[6]	JSON	http://www.ietf.org/rfc/rfc4627.txt
[7]	REST	http://en.wikipedia.org/wiki/Representational_state_transfer
[8]	URI	https://tools.ietf.org/html/rfc3986
[9]	EBNF	http://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_Form
[10]	Media-Types	http://www.iana.org/assignments/media-types/media-types.xhtml
[11]	Swagger	http://swagger.io

Online Documentation

The Web Service Interface also provides an interactive online documentation (web page). The documentation is based on Swagger [11] and is a runtime representation of the API. It requires a running Web Service Interface and can be accessed by the following URL:

http(s)://[hostname]:[port]/alertws/swagger/ui/index

Example:

http://localhost:80/alertws/swagger/ui/index

Definitions, Acronyms and Abbreviations, Conventions

Glossary

Term	Description
HAL	Simple format that gives a consistent and easy way to hyperlink between resources.
HTTP	Hypertext transfer protocol: http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol
JSON	JavaScript Object Notation: http://en.wikipedia.org/wiki/JSON
OAuth 2.0	Open standard to authorization. OAuth provides client applications a 'secure delegated access' to server resources on behalf of a resource owner.
REST	Representational state transfer: http://en.wikipedia.org/wiki/Representational_state_transfer
Real-time push	Push notification from a server (our Web Service in this case) to a client; used for notification of changes of values as long as client application is running. Notifies the client about events in the system, including change of value, as long as the client application is running.
Reverse Proxy	Retrieves resources on behalf of a client from a server. These resources are then returned to the client as though they originated from the server itself.
SignalR	Library for ASP.NET. SignalR allows bi-directional communication between server and client.