Kuba1: Porovnání verzí
| Řádek 14: | Řádek 14: | ||
Struktura obsahuje parametry: | Struktura obsahuje parametry: | ||
* '''ItemGroup''' Povinný údaj. Předává se název skupiny údajů (entity) v KS mzdy (např. 'KmenoveUdaje'). | * '''ItemGroup''' | ||
:Povinný údaj. Předává se název skupiny údajů (entity) v KS mzdy (např. 'KmenoveUdaje'). | |||
* '''Items''' | * '''Items''' | ||
Vyplňuje se v případe volání metody '''GetData'''. Předává se seznam položek, které budou v návratové datové struktuře, na které má uživatel oprávnění. Jednotlivé položky se oddělují čárkou (Příklad: OsCislo, Jmeno, Prijmeni). | :Vyplňuje se v případe volání metody '''GetData'''. Předává se seznam položek, které budou v návratové datové struktuře, na které má uživatel oprávnění. Jednotlivé položky se oddělují čárkou (Příklad: OsCislo, Jmeno, Prijmeni). | ||
* '''JsonChangeData''' | * '''JsonChangeData''' | ||
Vyplňuje se v případe volání metody '''InsertData''' nebo '''UpdateData'''. V JSON struktuře se předávají data, která mají být zapsána do databáze KS mzdy. Vždy se jedná o JSON pole. | :Vyplňuje se v případe volání metody '''InsertData''' nebo '''UpdateData'''. V JSON struktuře se předávají data, která mají být zapsána do databáze KS mzdy. Vždy se jedná o JSON pole. | ||
* '''JsonSearchCriteria''' | * '''JsonSearchCriteria''' | ||
Slouží k předání vyhledávacích kritérií pro omezení množiny zpracovávaných údajů. Podmínka se zapisuje v JSON formátu. Vyhledávací kritérium se skládá z výrazů (výraz obsahuje atributy 'Item', 'Operator', 'Value'), přičemž může být zadán buď jediný výraz nebo složený, oddělený logickými operátory. | :Slouží k předání vyhledávacích kritérií pro omezení množiny zpracovávaných údajů. Podmínka se zapisuje v JSON formátu. Vyhledávací kritérium se skládá z výrazů (výraz obsahuje atributy 'Item', 'Operator', 'Value'), přičemž může být zadán buď jediný výraz nebo složený, oddělený logickými operátory. | ||
Přípustné logické operátory: '''OR, AND''' | ====Přípustné logické operátory:==== '''OR, AND''' | ||
Přípustné operátory porovnání:''' =, <=, >=, >, <, LIKE, NOT LIKE, IN, NOT IN''' | ====Přípustné operátory porovnání:====''' =, <=, >=, >, <, LIKE, NOT LIKE, IN, NOT IN''' | ||
Verze z 21. 4. 2021, 08:39
KS WebAPI je webová služba postavená na technologii Windows Communication Foundation. Umožňuje předávat údaje z databáze KS mzdy klientské aplikaci nebo ukládat údaje do databáze KS mzdy zaslané klientskou aplikací.
Komunikační protokol
Pro hostování webové služby se využívá KS aplikační server. Komunikačním protokolem je http, případně ve spojení se SSL (HTTPS). Pro výměnu zpráv se používá protokol SOAP. Ve výchozím nastavení je připraven typ endpointu wsHttpBinding.
Metody webové služby
KS WebAPI nabízí metody: GetData, InsertData, UpdateData.
Všechny metody přebírají v parametru strukturu KSWebAPI_Parameters a vrací návratovou strukturu KSWebAPI_Response.
KSWebAPI_Parameters
Struktura obsahuje parametry:
- ItemGroup
- Povinný údaj. Předává se název skupiny údajů (entity) v KS mzdy (např. 'KmenoveUdaje').
- Items
- Vyplňuje se v případe volání metody GetData. Předává se seznam položek, které budou v návratové datové struktuře, na které má uživatel oprávnění. Jednotlivé položky se oddělují čárkou (Příklad: OsCislo, Jmeno, Prijmeni).
- JsonChangeData
- Vyplňuje se v případe volání metody InsertData nebo UpdateData. V JSON struktuře se předávají data, která mají být zapsána do databáze KS mzdy. Vždy se jedná o JSON pole.
- JsonSearchCriteria
- Slouží k předání vyhledávacích kritérií pro omezení množiny zpracovávaných údajů. Podmínka se zapisuje v JSON formátu. Vyhledávací kritérium se skládá z výrazů (výraz obsahuje atributy 'Item', 'Operator', 'Value'), přičemž může být zadán buď jediný výraz nebo složený, oddělený logickými operátory.
====Přípustné logické operátory:==== OR, AND
====Přípustné operátory porovnání:==== =, <=, >=, >, <, LIKE, NOT LIKE, IN, NOT IN
