Paczki operacji (asynchroniczne)
Protokół bimo pozwala na zlecanie i weryfikowanie statusu przetwarzania paczek operacji na Informacjach Gospodarczych i zobowiązaniach. Paczki te są przetwarzane w SIBIG asynchronicznie, tzn. system klienta nie otrzymuje natychmiast potwierdzenia przetworzenia paczki, lecz weryfikuje status przetwarzania paczki po pewnym czasie od zlecenia.
Dostępne dla subskrybentów operacje na paczkach są wymienione i opisane w specyfikacji BIG API.
Lista komunikatów wejściowych dla operacji na paczkach
| Nazwa operacji | Komunikat wejściowy |
|---|---|
| Rejestracja zlecenia przetworzenia paczki operacji | Element addOrderRequest |
| Usunięcie zlecenia przetworzenia paczki operacji | Element removeOrderRequest |
| Pobranie listy zarejestrowanych zleceń | Element getOrderListRequest |
| Pobranie statusu zlecenia | Element getOrderStatusRequest |
Przykładowy scenariusz zlecenia i odebrania rezultatu przetworzenia paczki
- Subkrybent rejestruje zlecenie przetworzenia paczki operacji - operacja addOrder z elementem data wypełnionym zgodnie ze specyfikacją addOrderRequest
- Odpowiedź z BIG API zawiera Element addOrderResponse, z uchwytem do zleconej paczki (Atrybut orderId).
- Subskrybent odpytuje o status paczki - operacja getOrderStatus, używając w elemencie orderId w getOrderStatusRequest, uzyskanego wcześniej uchwytu.
- Subskrybent powtarza odpytanie o status paczki co określony interwał (np. co 15 minut), aż do uzyskania wartości processed w elemencie orderStatus.
- W przypadku statusu paczki processed, odpowiedź z BIG API zawiera również wypełnione elementy:
- Element orderProcessingSummary (Typ złożony PackageOrderProcessingSummary) - z podsumowaniem statystycznym przetworzenia paczki.
- Element orderResult (Typ złożony LiabilitiesManagementResultPackage) - z rezultatami przetworzenia dla poszczególnych operacji.
- Jeśli paczka nie została poprawnie przetworzona (nie zostały wykonane żadne zlecone operacje), to jej status ma wartość failed lub canceled.
Zobacz także