Orsoft Doku
Dokumentace a nápověda pro IS Orsoft Open

SVizualisCompanyCalendarRestService

Popis

REST API služba pro export firemního kalendáře do systému Vizualis. Součást skupiny integračních REST služeb pro Vizualis (společný základ SVizualisBaseRest).

Základní informace

  • URL endpointu: `/v1/company-calendar`
  • Metoda: `GET`
  • Formát výstupu: `application/json`
  • Autentizace: API klíč (anotace @ApiKeySecured)

Parametry

Parametr Typ Povinný Popis
year integer (query) ne Rok, pro který se má firemní kalendář vrátit. Pokud není zadán, chování závisí na implementaci SVizualisCompanyCalendarServiceImpl.

Příklad požadavku

GET /v1/company-calendar?year=2026

Autentizace

Endpoint je zabezpečen API klíčem (@ApiKeySecured). Klíč je nastaven pro uživatele s loginem vizualis v OR-SYSTEM Open – operace přes toto API se provádí pod tímto uživatelským účtem.

Swagger / OpenAPI

Viz společné Swagger UI (IP adresa aplikačního serveru, port dle ws_cfg.properties).

===== Poznámky