Podrobný popis API

Přenášené údaje

Data jsou předávána ve formátu, pro který je určen typ interface (např. JSON, XML, CSV a pod.) Více informací naleznete zde.

Hlavička zprávy

Hlavička je určena vždy pro konkrétní nastavení konkrétní služby. Jedna služba může být volána z více aplikací, i v takovém případě budou údaje hlavičky stejné. Hlavička by měla být v aplikaci nastavitelná (podle údajů z nastavení služby Maatrix).

Parametry zprávy

V části Parametry jsou vstupní a výstupní údaje pro konkrétní zprávu či dotaz. Jednotlivá pole vstupních a výstupních parametrů jsou určována šablonou, ze které služba vznikla. Pokud interface umožňuje nastavení seznamu vlastností Vstupních a Výstupních parametrů, může být rozhraní přiřazeno k více šablonám, jedná se o tzv. univerzální rozhraní (podle nastavení šablony, resp. vstupních polí šablony a významu těchto polí je rozhraní použitelné pro různé komunikační služby různých významů). Rozhraní však může mít definici seznamu vstupních polí „na pevno“, v takovém případě je možné rozhraní použít pouze na takové šablony, které mají stejná vstupní pole se stejným významem.

Parametry mohou nabývat následujících typů:

string - textové údaje

integer - celočíselná hodnota

boolean - 0/1

ListOfK - seznam klíčů

ListOfT - seznam textů

ListOfKT - seznam objektů se dvěma atributy, klíčem a textem

ArrayOfTO - pole objektů definovaných klíčem se dvěma atributy: textem a pořadím

Pokud je vstupním či výstupním parametrem uživatel a nebo seznam uživatelů, předává se v podobě mailů těchto uživatelů.