Metody (KS webAPI) - Historie editací

Petrm: /* KSWebAPI_Response */

2024-05-21T06:56:17Z

KSWebAPI_Response

← Starší verze		Verze z 21. 5. 2024, 08:56
Řádek 132:		Řádek 132:
	* '''Data'''		* '''Data'''
	:Data ve formátu JSON.		:Data ve formátu JSON.

			Při volání metod KS webAPI "GetData", "InsertData", "UpdateData", "DeleteData" je vrácena návratová struktura "KSWebAPI_Response". V případě výskytu chyby je atribut "IsError" nastaven na hodnotu "true" a v atributu "ErrorMessage" je uveden výpis chybového stavu. Pokud je "IsError" nastaven na hodnotu "false", proběhl přenos dat v pořádku. Při volání metody "GetData" nebo "InsertData" jsou v atributu "Data" uvedena požadovaná nebo uložená data.
			Informace o přenosu dat je logována v logovacím souboru AS dané instance "KSAS_Server..._N73.log", pokud je logování povoleno - [[Logování (Aplikační server KS)]].

	== Odkazy ==		== Odkazy ==
	* [[Klient (KS webAPI)]]		* [[Klient (KS webAPI)]]

Milan v 30. 11. 2023, 11:52

2023-11-30T11:52:39Z

← Starší verze		Verze z 30. 11. 2023, 13:52
Řádek 84:		Řádek 84:

	* '''[[JsonOptions]]''' - nepovinný údaj, slouží pro doplnění speciálních parametrů, které ovlivní zpracovávanou skupinu údajů.		* '''[[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 ==		== KSWebAPI_Parameters ==

Petrm v 18. 4. 2023, 07:49

2023-04-18T07:49:41Z

← Starší verze		Verze z 18. 4. 2023, 09:49
Řádek 59:		Řádek 59:
	:V JSON formátu jsou předána data, která byla vložena do databáze.		:V JSON formátu jsou předána data, která byla vložena do databáze.

			<small>
			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}]
			</small>
	== UpdateData ==		== UpdateData ==
	Metoda '''UpdateData''' provádí změnu dat v databázi KS mzdy.		Metoda '''UpdateData''' provádí změnu dat v databázi KS mzdy.

Petrm: /* InsertData */

2022-09-07T10:28:02Z

InsertData

← Starší verze		Verze z 7. 9. 2022, 12:28
Řádek 40:		Řádek 40:
	'''Příklad dat pro vložení jednoho záznamu'''		'''Příklad dat pro vložení jednoho záznamu'''
	<pre>		<pre>
	[		[{ "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": "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"}]
	]
	</pre>		</pre>

	'''Příklad dat pro vložení více záznamů'''		'''Příklad dat pro vložení více záznamů'''
	<pre>		<pre>
	[		[{ "IdPodniku": "1", "Jmeno": "Karel", "Prijmeni": "Nový", "RodneCislo": "800101111", "MistoNarozeni": "Vsetín", "StatNar": "CZ", "StPrisl": "203", "RodinStav": "2", "TrCislo": "100", "PscTrv": "75501", "MistoTrv": "Vsetín",
	[ { "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"},		"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",		{ "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"},		"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",		{ "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"}		"KmenStr": "1", "DatumNastupu": "2019-03-01"}]
	]
	]
	</pre>		</pre>

Petrm v 4. 3. 2022, 14:41

2022-03-04T14:41:07Z

@@ Řádek 121: / Řádek 121: @@
 *	'''Data'''
 :Data ve formátu JSON.
 == Odkazy ==
 * [[Klient (KS webAPI)]]

Petrm v 4. 3. 2022, 14:39

2022-03-04T14:39:19Z

← Starší verze		Verze z 4. 3. 2022, 16:39
Řádek 1:		Řádek 1:
	~~''Metody (KS webAPI)''~~

	[[KS webAPI]] nabízí metody: ''GetData'', ''InsertData'', ''UpdateData''.		[[KS webAPI]] nabízí metody: ''GetData'', ''InsertData'', ''UpdateData''.

Petrm: /* Odkazy */

2022-03-02T09:44:55Z

Odkazy

← Starší verze		Verze z 2. 3. 2022, 11:44
Řádek 141:		Řádek 141:

	== Odkazy ==		== Odkazy ==
	* [[KS webAPI]]		* [[Klient (KS webAPI)]]

Petrm: Založena nová stránka: ''Metody (KS webAPI)'' KS webAPI nabízí metody: ''GetData'', ''InsertData'', ''UpdateData''. Všechny metody přebírají v parametru strukturu ''KSWebAPI_Parameter…

2022-03-01T10:01:58Z

Založena nová stránka: ''Metody (KS webAPI)'' KS webAPI nabízí metody: ''GetData'', ''InsertData'', ''UpdateData''. Všechny metody přebírají v parametru strukturu ''KSWebAPI_Parameter…

Nová stránka

''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'''
<pre>
[
[{ "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"}]
]
</pre>

'''Příklad dat pro vložení více záznamů'''
<pre>
[
[ { "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"}
]
]
</pre>

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.

== 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ů'''
<pre>
[{ "KmenStr": "100", "DatumVystupu": "2019-12-31" }]
</pre>

* '''[[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ů.

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

== Autentizace ==
Pro ověření uživatele se používá UserName autentizace, kdy se předává jméno a heslo uživatele při volání metody webové služby v části ClientCredentials.
Tato metoda musí být nastavena v konfiguračním souboru klienta.

== Příklady ==

<pre>
<security>
<message clientCredentialType="UserName" />
</security>
</pre>

Uživatelé se evidují v okně ''''Správa uživatelů''''

[[Soubor:Sprava-uzivatelu-KS-WEBAPI.jpg|350px]]

== Odkazy ==
* [[KS webAPI]]