KS WebAPI: Porovnání verzí

Z Prirucky
(Založena nová stránka: ''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…)
 
(Přesměrování na KS webAPI)
 
(Není zobrazeno 18 mezilehlých verzí od 2 dalších uživatelů.)
Řádek 1: Řádek 1:
#REDIRECT [[KS webAPI]]
<!--
''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í.
''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í.


Řádek 5: Řádek 8:


=Zpřístupnění KS WebAPI=
=Zpřístupnění KS WebAPI=
 
KS WebAPI je placený modul, a to v závislosti na zvolené variantě. Jsou dostupné '''3 varianty''', které se liší množinou zpracovávaných dat a povolením pro čtení a zápis údajů:
KS WebAPI je potřeba aktivovat přes Rozšíření aplikace v aplikaci KS mzdy (menu: Nápověda > Rozšíření aplikace).
Jsou dostupné 3 varianty, které se liší množinou zpracovávaných dat a povolením pro čtení a zápis údajů:


* '''KS WebAPI Free'''
* '''KS WebAPI Free'''
Řádek 18: Řádek 19:
:Obecné rozhraní pro čtení a zápis dat zaměstnanců do/ze systému KS mzdy.
:Obecné rozhraní pro čtení a zápis dat zaměstnanců do/ze systému KS mzdy.


'''Pro zpřístupnění je potřeba provést tyto kroky:'''
=== Postup ===
# [[Rozšíření aplikace]]
# [[Úprava databáze]]
# [[Generování (KS WebAPI)|Generování]]
 
== Aktualizace položek KS WebAPI ==
* [[Generování (KS WebAPI)|Generování]]


# V aplikaci KS mzdy, v okně 'Rozšíření aplikace' (menu: Nápověda > Rozšíření aplikace), aktivovat požadované rozšíření.
#Provést úpravu databáze.
#V aplikaci KS mzdy spustit úlohu WebAPI (menu: Systém > Web API). Potvrzením volby 'Ano' dojde k vygenerování dokumentace k přenášeným údajům (ve formě HTML). Generování dokumentace je potom potřeba  provádět vždy, pokud bude vydaná nová verze KS WebAPI.
=Operace dostupné pomocí KS WebAPI=
=Operace dostupné pomocí KS WebAPI=


V tabulce jsou uvedeny pouze hlavní operace dostupné všem zákazníkům. Někteří zákazníci mohou mít zpřístupněny další specifické operace. Vždy je nutné vygenerovat si dokumentaci k WebAPI pomocí C/S aplikace.
V tabulce jsou uvedeny pouze hlavní operace dostupné všem zákazníkům. Někteří zákazníci mohou mít zpřístupněny další specifické operace. Dále se seznam liší dle varianty (Free, Reader, Writer).
 
'''Vždy je nutné vygenerovat si dokumentaci k WebAPI pomocí desktop aplikace.'''


{|border="1" cellpadding="3" cellspacing="0"
{|class="wikitable sortable" border="1" cellpadding="3" cellspacing="0"
|- style="background-color: #eeeeee"
|- style="background-color: #eeeeee"
|'''Souhrn údajů'''
|'''Souhrn údajů'''
Řádek 149: Řádek 155:
| Dosažené vzdělání zaměstnanců
| Dosažené vzdělání zaměstnanců
|-
|-
 
| [[WebAPI KumulacePoVyuctovani|KumulacePoVyuctovani]] || Ano || Ne || Měsíční kumulace a další údaje po vyúčtování za os.číslo.
|-
| [[WebAPI MimoevidencniStavy|MimoevidencniStavy]] || Ano || Ne || [[Mimoevidenční stav]]
|-
| [[WebAPI Poznamky|Poznamky]] || || || Poznámky
|-
| [[WebAPI CiselnikJazyku|CiselnikJazyku]] || || || Číselník jazyků
|-
| [[WebAPI CiselnikStupnuVzdelani|CiselnikStupnuVzdelani]] || || || Číselník stupňů vzdělání
|-
| [[WebAPI iTutor_Courses|iTutor_Courses]] || || ||
|-
| [[WebAPI Plánované směny|Plánované směny]] ||  ||  ||
|-
| [[WebAPI Požadavky|Požadavky]] || ||  || [[Požadavky]]
|}
|}


Řádek 170: Řádek 190:
: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).
: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'''
* '''[[JsonSearchCriteria]]''' - předá se vyhledávací podmínka v JSON formátu.
:Předá se vyhledávací podmínka v JSON formátu.


* '''JsonOptions'''
* '''[[JsonOptions]]''' - nepovinný údaj, slouží pro doplnění speciálních parametrů, které ovlivní zpracovávanou skupinu údajů.
:Nepovinný údaj, slouží pro doplnění speciálních parametrů, které ovlivní zpracovávanou skupinu údajů.




Řádek 237: Řádek 255:
</pre>
</pre>


* '''JsonSearchCriteria'''
* '''[[JsonSearchCriteria]]''' - předá se vyhledávací podmínka v JSON formátu, pro omezení množiny dat, které mají být změněny.
: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=
=KSWebAPI_Parameters=
Řádek 252: Řádek 271:
* '''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ů.
: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.
 
* '''JsonOptions'''
:Vlastnost slouží pro doplnění speciálních parametrů, které ovlivní zpracovávanou skupinu údajů. Konkrétní použití je uvedeno v popisu jednotlivých skupin údajů. (Aby klienti KS WebAPI mohli tuto novou vlastnost používat, je potřeba, aby provedli aktualizaci reference na KS WebAPI.)
 
Přípustné logické operátory: '''OR, AND'''


Přípustné operátory porovnání:''' =, <=, >=, >, <, LIKE, NOT LIKE, IN, NOT IN'''
* '''[[JsonOptions]]''' - vlastnost slouží pro doplnění speciálních parametrů, které ovlivní zpracovávanou skupinu údajů.
 
===Příklady===
 
'''1 (jednoduchý výraz)'''
<pre>
[
    { "Item": "OsCislo", "Operator": "<=", "Value": 100 }
]
</pre>
 
'''1 AND 2'''
<pre>
[
    { "Item": "OsCislo", "Operator": "<=", "Value": 100 },
    "AND",
    { "Item": "DatumNastupu", "Operator": ">=", "Value": "2000-01-01" }
]
 
</pre>
'''1 OR 2'''
<pre>
[
    { "Item": "Jmeno", "Operator": "=", "Value": "Karel" },
    "OR",
    { "Item": "Jmeno", "Operator": "=", "Value": "Marie" }
]
 
</pre>
'''(1 OR 2) AND (3 OR 4)'''
<pre>
[
    [
        { "Item": "DatumNastupu", "Operator": "=", "Value": "2000-01-01" },
        "OR",
        { "Item": "DatumNastupu", "Operator": "=", "Value": "2010-01-01" }
    ],
    "AND",
    [
        { "Item": "Jmeno", "Operator": "=", "Value": "Karel" },
        "OR",
        { "Item": "Jmeno", "Operator": "=", "Value": "Marie" }
    ]
]
</pre>
 
'''1 OR (2 AND (3 OR 4))'''
<pre>
[
    { "Item": "DatumNastupu", "Operator": "=", "Value": "2000-01-01" },
    "OR",
    [
        { "Item": "DatumNastupu", "Operator": "=", "Value": "2010-01-01" },
        "AND",
        [
            { "Item": "Jmeno", "Operator": "=", "Value": "Karel" },
            "OR",
            { "Item": "Jmeno", "Operator": "=", "Value": "Marie" }
        ]
    ]
]
 
</pre>


=KSWebAPI_Response=
=KSWebAPI_Response=
Řádek 517: Řádek 468:
* [[Systémová příručka]]
* [[Systémová příručka]]
* [[Přenosy dat]]
* [[Přenosy dat]]
-->

Aktuální verze z 28. 4. 2022, 13:21

Přesměrování na:

Citováno z „http://prirucky.ksprogram.cz/index.php?title=KS_WebAPI&oldid=43281“