Podrobný popis API

Věta X - typ summary

Vlastnost Popis Povinné Poznámka
Hlavička
MessageType Typ zprávy = summary A  
ServiceID Identifikátor služby v podobě srv-xxx-xxx A  
ServiceExecutionID Globálně unikátní identifikátor zpracování služby - jednoznačný identifikátor konkrétního běhu komunikační služby Maatrix A  
ExternalID Externí ID daného volání služby (přiděleno volající externí aplikací) N Identifikátor převzatý z věty A-call
Subject

Subjekt dotazu:

Service - subjektem je daný výkon služby ServiceExecutionID, Maatrix vrátí jeho stav, a výstupní parametry

A  
SubjectResult Výsledek běhu služby (1/0) A  Odpovídá výstupnímu parametru <:ResultOK>
SubjectStatus

Stav běhu služby:

closed - subjekt korektně proběhl (služba /blok ukončena, má výsledek)

stopped - subjekt byl buď násilně ukončen, nebo zkolaboval (služba / blok byla přerušena, výsledky nejsou platné, a nikdy platné nebudou),

 

A  
Timestamp časová značka přijetí zprávy (UTC čas) A  
Výstupní parametry
Results Pole s jednotlivými výstupními parametry v závislosti na zvolené komunikační službě   Názvy jednotlivých výstupních parametrů jsou klíčem tohoto pole, hodnota je závislá na typu výstupního parametru.
<:OutputPara> Jednotlivé výstupní parametry služby. Názvy parametrů jsou uvedeny včetně povinného uzavření mezi "<: a >" A Seznam těchto parametrů je k dispozici v portálu systému Maatrix u nastavení služby. Význam jednotlivých typů výstupních parametrů naleznete zde.