OBERON Web Services |  |
Táto referenčná príručka stručne popisuje objekty, metódy a udalosti vybraných webových služieb systému OBERON.
Webové služby umožňujú komunikáciu medzi systémom OBERON a ďalšími nadstavbovými modulmi, prípadne inými externými systémami pomocou protokolu SOAP (prípadne SOAP/JSON). Komunikácia prebieha pomocou sieťového protokolu Tcp-IP, pričom ako transportný protokol môže byť aj http alebo zabezpečené https.
Hlavnou výhodou webových služieb je nezávislosť na platforme a vývojovom jazyku, preto sa často používajú (či už v režime ako server alebo klient) na on-line komunikáciu s inými externými systémami. Táto dokumentácia obsahuje všetky metódy a triedy používaných v danej webovej službe. Implementovať a tak získať výpis daných tried webovej služby je možné použitím napr. vývojového nástroja Microsoft Visual Studio (po pridaní Service Reference), prípadne použiť z niektorých REST klient nástrojov, napr. http://www.getpostman.com/.
Ako hostiteľ webovej služby (v režime server) II. generácie je využívaný program OBERON Automation Center (OAC), ktorý je spustený ako Windows služba. Tu je možné nadefinovať jednu, prípadne súčasne aj viac webových služieb. Webová služba je napísaná vo Visual Studiu .NET - pre jednoduché použitie je možné v tomto prostredí automaticky vygenerovať jednotlivé volania a štruktúry. V iných vývojových prostrediach je možné pristupovať k daným metódam podľa tejto dokumentácie na daných URL a štruktúry uvádzať v JSON formáte.
V systéme OBERON sa nachádza viac typov webových služieb:
- OBERON [OBERONServiceGen2]- základná (hlavná) služba systému OBERON (slúži aj ako server pre aplikáciu OBERON Web) - zoznam dostupných metód.
- Pokladnica OBERON [OBERONCashRegisterService] - webová služba určená pre komunikáciu s modulom Pokladnica OBERON, najčastejšie riešenie pre mobilného čašníka.
- OBERON Vernostný systém (klient) - klient vernostného systému [Exa.OBERON.Shared.LoyaltyCardSystems.Drivers], ktorý obsahuje totožné štruktúry ako server [OBERONLoyaltySystemService] - z hľadiska implementácie server obsahuje popis metód, pričom štruktúry sú definované v klientovi.
Pre prvotné oznámenie sa s webovými službami OBERON, formátom JSON štruktúr a príkladom načítania skladových kariet odporúčame pozrieť metódu pre prihlásenie sa do webovej služby User_Login.
Namespaces| Namespace | Description |
|---|---|
| Exa.OBERON.ServicesGen2 | Webové služby umožňujú komunikáciu medzi systémom OBERON a ďalšími nadstavbovými modulmi, prípadne inými externými systémami pomocou protokolu JSON dátových správ. Komunikácia prebieha pomocou sieťového protokolu Tcp-IP, pričom ako transportný protokol môže byť aj http alebo zabezpečené https. Systém OBERON obsahuje niekoľko webových služieb, rozdelených podľa svojho určenia a využitia, základná a najobsiahlejšia služba (WebService) je IOBERONServiceGen2. |
| Exa.OBERON.ServicesGen2.Accounting.BankStatements | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre prácu s bankovými výpisami, napr. zoznam bankových výpisov - Accounting_BankStatements_List(BankStatementsListArg), načítanie konkrétneho riadka bankového výpisu - Accounting_BankStatement_Get(BankStatementGetArg), vytvorenie (import) nového riadka bankového výpisu - Accounting_BankStatement_Add(BankStatementAddArg) a podobne. |
| Exa.OBERON.ServicesGen2.Base | Tu sa nachádzajú základné triedy webovej služby (API rozhrania) IOBERONServiceGen2. |
| Exa.OBERON.ServicesGen2.Base.Web | Okrem základného API rozhrania, ktorá webová služba IOBERONServiceGen2 poskytuje, slúži aj ako server pre webovú aplikáciu OBERON Web. Tu sa nachádzajú metódy, obsluhujú UI aplikácie OBERON Web. |
| Exa.OBERON.ServicesGen2.BusinessPartners | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre prácu s obchodnými partnermi účtovnej jednotky, napr. BusinessPartners_List(BusinessPartnerListArg), BusinessPartner_CreditLimitInfo(BusinessPartnerCreditLimitArg) a podobne. |
| Exa.OBERON.ServicesGen2.Common.BankAccounts | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre načítanie bankových účtov účtovnej jednotky. Načítať zoznam používaných bankových účtov je možné pomocou metódy Common_BankAccounts_List. |
| Exa.OBERON.ServicesGen2.Common.BookSettings | Obsahuje spravidla zdieľané štruktúry API rozhrania IOBERONServiceGen2, napr. filtre, ktoré sa používajú pri načítaní záznamov z danej evidencie, napr. načítanie skladových kariet Stock_StockCards_List(StockCardsListArg). |
| Exa.OBERON.ServicesGen2.Common.Currency | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre načítanie používaných cudzích mien, ktoré sú v systéme OBERON definované a s ktorými systémpracuje . Načítať zoznam cudzích mien je možné pomocou metódy Common_Currency_List. |
| Exa.OBERON.ServicesGen2.Common.Document | Obsahuje spravidla zdieľané štruktúry API rozhrania IOBERONServiceGen2, napr. štruktúra položky dokladu, obchodného partnera na doklade (adresy), rekapitulácie súm dokladu a podobne. |
| Exa.OBERON.ServicesGen2.Common.FileRepository | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre prácu s prílohami (pripojenými dokumentami) rôznych evidencií, napr. FileRepository_Get(FileRepositoryGetArg) a podobne. |
| Exa.OBERON.ServicesGen2.Common.Info | Obsahuje spravidla zdieľané štruktúry API rozhrania IOBERONServiceGen2, napr. štruktúra adresy, bankovéh účtu, telefónneho čísla a podobne. |
| Exa.OBERON.ServicesGen2.Common.Units | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre načítanie merných jednotiek, s ktorými pracuje skladová položka, prípadne sa používajú v dokladoch. Načítať zoznam používaných merných jednotiek je možné pomocou metódy Common_Units_List. |
| Exa.OBERON.ServicesGen2.Company | Predstavuje triedy (JSON štruktúry), ktoré obsahujú základné nastavenia účtovnej jednotky. Základné info o firme je možné načítať pomocou Company_Info, nastavenia je možné načítať pomocou metódy Company_Settings. |
| Exa.OBERON.ServicesGen2.OBERON | Hlavná webová služba systému OBERON, ktorá slúži na množstvo rôznorodých úloh v systéme. Okrem iného slúži ako server pre webovú aplikáciu OBERON Web. Metódy, ktoré obsahuje táto webová služba popisuje rozhranie IOBERONServiceGen2. |
| Exa.OBERON.ServicesGen2.Stock.InvoicesIssued | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre prácu s vydanými faktúrami (Kniha pohľadávok), napr. zoznam vydaných faktúr - InvoicesIssued_List(InvoicesIssuedListArg), načítanie konkrétnej vydanej faktúry - InvoiceIssued_Get(InvoiceIssuedGetArg), vytvorenie novej vydanej faktúry - InvoiceIssued_Add(InvoiceIssuedAddArg) a podobne. |
| Exa.OBERON.ServicesGen2.Stock.InvoicesReceived | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre prácu s prijatými faktúrami (Kniha záväzkov), napr. zoznam prijatých (došlých) faktúr - InvoicesReceived_List(InvoicesReceivedListArg), načítanie konkrétnej prijatej faktúry - InvoiceReceived_Get(InvoiceReceivedGetArg), vytvorenie novej prijatej faktúry - InvoiceReceived_Add(InvoiceReceivedAddArg) a podobne. |
| Exa.OBERON.ServicesGen2.Stock.OrdersReceived | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre prácu s prijatými objednávkami, napr. zoznam prijatých objendávok - Stock_OrdersReceived_List(OrdersReceivedListArg), načítanie konkrétnej prijatej objednávky - Stock_OrderReceived_Get(OrderReceivedGetArg), vytvorenie novej prijatej objednávky - Stock_OrderReceived_Add(OrderReceivedAddArg) a podobne. |
| Exa.OBERON.ServicesGen2.Stock.ReceiveNotes | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre prácu so skladovými príjemkami, napr. zoznam príjemiek - Stock_ReceiveNotes_List(ReceiveNotesListArg), načítanie konkrétnej príjemky - Stock_ReceiveNote_Get(ReceiveNoteGetArg), vytvorenie novej príjemky - Stock_ReceiveNote_Add(ReceiveNoteAddArg) a podobne. |
| Exa.OBERON.ServicesGen2.Stock.ReleaseNotes | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre prácu so skladovými výdajkami, napr. zoznam výdajok - Stock_ReleaseNotes_List(ReleaseNotesListArg), načítanie konkrétnej výdajky - Stock_ReleaseNote_Get(ReleaseNoteGetArg), vytvorenie novej výdajky - Stock_ReleaseNote_Add(ReleaseNoteAddArg) a podobne. |
| Exa.OBERON.ServicesGen2.Stock.SerialNumbers | Obsahuje štukrtúry API rozhrania IOBERONServiceGen2, určené pre prácu s výrobnými alebo sériovými číslami pri príjme alebo výdaji (predaji). Používajú sa priamo v položke dokladu príjemky ReceiveNoteItem, výdajky ReleaseNoteItem, prípadne aj v prijatých InvoiceReceivedItem a vydaných InvoiceIssuedItem faktúrach. |
| Exa.OBERON.ServicesGen2.Stock.StockCards | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre prácu so skladovými kartami (skladovými položkami, alebo inak cenníkom), napr. načítanie zoznamu skladových kariet - Stock_StockCards_List(StockCardsListArg), načítanie (vyhľadanie) konkrétnej skladovej karty - Stock_StockCards_Find(StockCardsFindArg) a podobne. |
| Exa.OBERON.ServicesGen2.Stock.StockCardsInventory | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre prácu s inventúrovu skladu, napr. inventúrny súpis položiek - Stock_StockCardsInventory_List(StockCardInventoryListArg), načítanie konkrétnej inventúrnej skladovej položky - Stock_StockCardsInventory_Get(StockCardInventoryGetArg), vyhľadanie položky v invenúrnom zozname - Stock_StockCardsInventory_Find(StockCardInventoryFindArg) a podobne. |
| Exa.OBERON.ServicesGen2.Stock.StockCommon.MovementDocumentTypes | Obsahuje štruktúry API rozhrania IOBERONServiceGen2, určené pre načítanie druhov (typov) skladových pohybov Stock_MovementDocumentTypes_List(MovementDocumentTypesArgs). Skladové doklady Príjemky a Výdajky musia byť vždy tohto jedného typu, napr. štandardný výdajka, prevodka a podobne. |
| Exa.OBERON.ServicesGen2.Stock.StockCommon.OrdersReceivedStates | Obsahuje štruktúry API rozhrania IOBERONServiceGen2, určené pre načítanie stavov prijatých objednávok (ponúk) Stock_OrdersReceived_States_List. Stav objednávky sa používa na objednávke (pole OrderState/>). |
| Exa.OBERON.ServicesGen2.Stock.StockCommon.Shipping | Obsahuje štruktúry s údajmu o doprave daného dokladu, prípadne aj o balení Používa sa v dokladoch, napr. ako prijatá objednávka - OrderReceivedHeader, výdajka - ReleaseNoteHeader, vydaná faktúra - InvoiceIssuedHeader, a podobne. |
| Exa.OBERON.ServicesGen2.Stock.StockCommon.ShippingPackageType | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, určené pre načítanie používaných cudzích mien, ktoré sú v systéme OBERON definované a s ktorými systémpracuje . Načítať zoznam cudzích mien je možné pomocou metódy Common_Currency_List. |
| Exa.OBERON.ServicesGen2.Stock.StockCommon.StockCardGroups | Obsahuje údaje o skladových skupinách, podľa ktorých je možné členiť skladové karty. Skupina je dôležitá pri vytváraní nových skladových kariet, kde skupinu je potrebné zadať z dôvoduy číslovania kariet a načítanie predvolených hodnôt na danej skladovej karte (napr. nastavenie cenotvorby). Načítanie skladových skupín - Stock_StockCard_Groups_List. |
| Exa.OBERON.ServicesGen2.Stock.Stocks | Obsahuje štruktúry API rozhrania IOBERONServiceGen2, určené pre prácu so skladmi, napr. načítanie zoznamu skladov Stock_List, načítanie druhov (typov) skladových pohybov - Stock_MovementDocumentTypes_List(MovementDocumentTypesArgs) a podobne. |
| Exa.OBERON.ServicesGen2.Users | Obsahuje štruktúry API rozhrania IOBERONServiceGen2, určené pre prácu s používateľmi (klientami) danej webovej služby, napr. príhlásenie používateľa do webovej služby User_Login(UserLoginArg), načítanie zoznamu prihlásených používateľov Users_LoggedOnWebService a podobne. |
| Exa.OBERON.ServicesGen2.Users.Permissions | |
| Exa.OBERON.ServicesGen2.WebServiceSystem | Obsahuje systémové metódy API rozhrania IOBERONServiceGen2, napr. System_Ping, System_Version a podobne. |