Metody (KS webAPI)

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.

GetData

Metoda GetData vrací data z databáze KS mzdy dle zadaných kritérií.

Nastavení parametrů struktury KSWebAPI_Parameters

• ItemGroup

Povinný údaj. Předá se název skupiny údajů (entity) v KS mzdy (např. 'KmenoveUdaje').

• Items

Předá se seznam položek, které budou v návratové datové struktuře. Jednotlivé položky se oddělí čárkou (Příklad: OsCislo, Jmeno, Prijmeni).

• JsonSearchCriteria - předá se vyhledávací podmínka v JSON formátu.

• JsonOptions - nepovinný údaj, slouží pro doplnění speciálních parametrů, které ovlivní zpracovávanou skupinu údajů.

Popis údajů v návratové struktuře KSWebAPI_Response

• Data

Očekávané data vyhovující podmínce v JsonSearchCriteria ve formátu JSON.

InsertData

Metoda InsertData zapisuje data do databáze KS mzdy.

Nastavení parametrů struktury KSWebAPI_Parameters

• ItemGroup

Povinný údaj. Předá se název skupiny údajů (entity) v KS mzdy (např. 'KmenoveUdaje').

• JsonChangeData

Povinný údaj. V JSON struktuře se předají data, která mají být zapsána do databáze KS mzdy. Vždy se jedná o pole, kde v jednotlivých objektech pole jsou data pro insert.

Příklad dat pro vložení jednoho záznamu

[{ "IdPodniku": "1", "Jmeno": "Karel", "Prijmeni": "Nový", "RodneCislo": "800101111", "MistoNarozeni": "Vsetín", "StatNar": "CZ", "StPrisl": "203", "RodinStav": "2", "TrCislo": "100", "PscTrv": "75501", "MistoTrv": "Vsetín", "KmenStr": "1", "DatumNastupu": "2019-01-01"}]

Příklad dat pro vložení více záznamů

[{ "IdPodniku": "1", "Jmeno": "Karel", "Prijmeni": "Nový", "RodneCislo": "800101111", "MistoNarozeni": "Vsetín", "StatNar": "CZ", "StPrisl": "203", "RodinStav": "2", "TrCislo": "100", "PscTrv": "75501", "MistoTrv": "Vsetín", 
   "KmenStr": "1", "DatumNastupu": "2019-01-01"},
   { "IdPodniku": "1", "Jmeno": "Petr", "Prijmeni": "Test", "RodneCislo": "81101111", "MistoNarozeni": "Vsetín", "StatNar": "CZ", "StPrisl": "203", "RodinStav": "2", "TrCislo": "101", "PscTrv": "75501", "MistoTrv": "Vsetín", 
   "KmenStr": "1", "DatumNastupu": "2019-02-01"},
   { "IdPodniku": "1", "Jmeno": "Marie", "Prijmeni": "Nová", "RodneCislo": "820101111", "MistoNarozeni": "Vsetín", "StatNar": "CZ", "StPrisl": "203", "RodinStav": "2", "TrCislo": "102", "PscTrv": "75501", "MistoTrv": "Vsetín", 
   "KmenStr": "1", "DatumNastupu": "2019-03-01"}]

Popis údajů v návratové struktuře KSWebAPI_Response

• Data

V JSON formátu jsou předána data, která byla vložena do databáze.

Při volání metody InsertData jsou ve struktuře KSWebAPI_Response, ve vlastnosti Data, vrácena všechna zapsaná data, které poskytuje KS webAPI dané skupiny údajů. Budou tam tedy i údaje určené pouze pro čtení, typicky např ID záznamu, které je generováno aplikační logikou při vkládání záznamu. V položce Data je vrácena množina vložených záznamů ve formátu JSON jako pole objektů. Níže je uveden příklad hodnoty položky Data, pro skupinu údajů RodinniPrislusnici, metodu InsertData.

[{'OsCislo': 95950,'Prijmeni': 'Králik','Jmeno': 'Adam','DatumNarozeni': '2021-02-01','RodneCislo': '210201000','Vztah': 'syn','NarokPd': 'n','IdRodPrisl': 143},
{'OsCislo': 95950,'Prijmeni': 'Králik','Jmeno': 'Petr','DatumNarozeni': '2022-01-01','RodneCislo': '220101000','Vztah': 'syn','NarokPd': 'n','IdRodPrisl': 144}] 

UpdateData

Metoda UpdateData provádí změnu dat v databázi KS mzdy.

Nastavení parametrů struktury KSWebAPI_Parameters

• ItemGroup

Povinný údaj. Předá se název skupiny údajů (entity) v KS mzdy (např. 'KmenoveUdaje').

• JsonChangeData

Povinný údaj. V JSON struktuře se předají data, která mají být změněna v databázi KS mzdy. Vždy se jedná o pole. V poli by měl být pouze jeden objekt s měněnými položkami.

Příklad dat pro změnu údajů

[{ "KmenStr": "100", "DatumVystupu": "2019-12-31" }]

• JsonSearchCriteria - předá se vyhledávací podmínka v JSON formátu, pro omezení množiny dat, které mají být změněny.

• JsonOptions - nepovinný údaj, slouží pro doplnění speciálních parametrů, které ovlivní zpracovávanou skupinu údajů.

DeleteData

Metoda DeleteData provádí mazání dat z databáze KS mzdy. Tuto metodu lze použít jen pro některé skupiny údajů.

Nastavení parametrů struktury KSWebAPI_Parameters

• ItemGroup

Povinný údaj. Předá se název skupiny údajů (entity) v KS mzdy (např. 'ZpracovanaDochazka').

• JsonSearchCriteria - předá se vyhledávací podmínka v JSON formátu, pro omezení množiny dat, které mají být smazány.

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ů.

• JsonOptions - vlastnost slouží pro doplnění speciálních parametrů, které ovlivní zpracovávanou skupinu údajů.

KSWebAPI_Response

Struktura obsahuje parametry:

• ResponseDatetime

Datum a čas odpovědi.

• StatusCode

Stav odpovědi. 200 – OK, 500 – chyba.

• Message

Zpráva odpovědi.

• IsError

Indikace zda nastala chyba.

• ErrorMessage

Chybová zpráva o chybovém stavu při zpracování metody.

• Data

Data ve formátu JSON.

Odkazy

• Klient (KS webAPI)