Obsah
SVizualisCustomerDeliveryAddressRestService
Popis
REST API služba pro export dodacích adres zákazníků 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/customer-delivery-addresses`
- Metoda: `GET`
- Formát výstupu: `application/json`
- Autentizace: API klíč (anotace
@ApiKeySecured)
Parametry
Endpoint nemá žádné vstupní parametry – vrací kompletní seznam dodacích adres zákazníků.
Příklad požadavku
GET /v1/customer-delivery-addresses
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 (stejný účet jako u ostatních REST služeb skupiny Vizualis).
Swagger / OpenAPI
Viz společné Swagger UI (IP adresa aplikačního serveru, port dle ws_cfg.properties).
Poznámky
- Služba dědí ze společné třídy
SVizualisBaseRest(jednotné zpracování chyb a odpovědí, metodahandle). - Skutečná implementace exportu je ve třídě
SVizualisCustomerDeliveryAddressServiceImpl. - Související služby: SVizualisCustomerRestService, SVizualisCompanyCalendarRestService.