Dosys:API/orderItem/GET: Porovnání verzí

Z Astea wiki
Skočit na navigaci Skočit na vyhledávání
(založena nová stránka s textem „{{DISPLAYTITLE:API/orderItem GET}} {{VERSIONINFO|Dosys|4.3.6.1}} == Přehled == Endpoint slouží pro přístup k datům projektů ve formátu JSON. == Parametry == ;dateFrom : typ [[{{NAMESPACE}}:API#Typy_parametrů|date]] :Začátek období exportovaných dat. Začátek období musí být vždy nastaven na první den měsíce. Povinný parametr. ;dateTo : typ [[{{NAMESPACE}}:API#Typy_parametrů|date]] :Konec období exportovaných dat. Hodnota mus…“)
 
 
(Není zobrazeno 11 mezilehlých verzí od stejného uživatele.)
Řádek 6: Řádek 6:


== Parametry ==
== Parametry ==
;dateFrom
;id
: typ [[{{NAMESPACE}}:API#Typy_parametrů|date]]
: typ [[{{NAMESPACE}}:API#Typy_parametrů|int]]
:Začátek období exportovaných dat. Začátek období musí být vždy nastaven na první den měsíce. Povinný parametr.
:ID konkrétního projektu.
;dateTo
: typ [[{{NAMESPACE}}:API#Typy_parametrů|date]]
:Konec období exportovaných dat. Hodnota musí být vyšší, než hodnota parametru ''dateFrom''.
;employee.number
: typ [[{{NAMESPACE}}:API#Typy_parametrů|string]]
:Osobní číslo zaměstnance, jehož data budou exportována.
;employee.salaryNumber
: typ [[{{NAMESPACE}}:API#Typy_parametrů|string]]
:Výplatní číslo zaměstnance, jehož data budou exportována.


== Výsledek ==
== Výsledek ==
API endpoint vrací pole objektů ve formátu JSON, kde každý prvek odpovídá jednomu dni docházky konkrétního zaměstnance.
Formát návratové hodnoty závisí na existenci parametru '''id'''. Je-li uveden, vrací API objekt odpovídající projektu s tímto ID. Pokud projekt s tímto ID neexistuje, vrací API HTTP error 404.
 
Není-li parametr '''id''' uveden, vrací endpoint seznam projektů.
{| class="wikitable"
{| class="wikitable"
! Údaj || Typ || Popis
! Údaj || Typ || Popis
|-
|-
| Employee || string || Interní číslo zaměstnance.
| ID || int || Unikátní identifikátor projektu.
|-
| Employee.Number || string || Evidenční číslo zaměstnance.
|-
| Employee.SalaryNumber || string || Výplatní číslo zaměstnance.
|-
| PassDate || date || Datum
|-
| WorkTime || string || Identifikátor pracovní doby.
|-
| WorkTimeShift || string || Identifikátor kalendáře.
|-
| WorkTimeHours || string || Identifikátor směny.
|-
|-
| WorkFrom || datetime || Datum a čas začátku práce po aplikaci pravidel výpočtu docházky.
| OrderNumber || string || Číslo projektu.
|-
|-
| WorkTo || datetime || Datum a čas konce práce po aplikaci pravidel výpočtu docházky.
| Date || date || Datum projektu.
|-
|-
| GetIn || datetime || Datum a čas skutečného příchodu. Od údaje ''WorkFrom'' se může lišit v důsledku kvantování, ignorování příchodu před začátkem směny a dalších výpočtových pravidel.
| AssemblyDate || date || Datum montáže.
|-
|-
| GetOut || datetime || Datum a čas skutečného odchodu. Od údaje ''WorkTo'' se může lišit v důsledku kvantování, ignorování příchodu před začátkem směny a dalších výpočtových pravidel.
| OrderStatus || int || Stav projektu.
|-
|-
| TmFund || time || Fond pracovní doby.
| CustomerContactName || string || Zákazník.
|-
|-
| TmWork || time || Odpracovaná doba.
| Text|| string || Popis.
|-
|-
| TmNA, TmOB, TmPR... || time || Časy jednotlivých přerušení.
| Note || string || Poznámka.
|}
|}


== Příklad ==
== Příklad ==
<pre>
<pre>
https://dochazka.mojefirma.cz?doc=api/attendance&dateFrom=2023-08-01&dateTo=2023-08-31
https://dochazka.mojefirma.cz?doc=api/orderItem


https://dochazka.mojefirma.cz?doc=api/attendance&dateFrom=2023-08-01&dateTo=2023-08-31&employee.number=100
https://dochazka.mojefirma.cz?doc=api/orderItem&id=14
</pre>
</pre>


Aktuální verze z 7. 5. 2024, 14:54

Dosys 4.3.6.1

Přehled

Endpoint slouží pro přístup k datům projektů ve formátu JSON.

Parametry

id
typ int
ID konkrétního projektu.

Výsledek

Formát návratové hodnoty závisí na existenci parametru id. Je-li uveden, vrací API objekt odpovídající projektu s tímto ID. Pokud projekt s tímto ID neexistuje, vrací API HTTP error 404.

Není-li parametr id uveden, vrací endpoint seznam projektů.

Údaj Typ Popis
ID int Unikátní identifikátor projektu.
OrderNumber string Číslo projektu.
Date date Datum projektu.
AssemblyDate date Datum montáže.
OrderStatus int Stav projektu.
CustomerContactName string Zákazník.
Text string Popis.
Note string Poznámka.

Příklad

https://dochazka.mojefirma.cz?doc=api/orderItem

https://dochazka.mojefirma.cz?doc=api/orderItem&id=14

Odkazy

API - přehled

Domovská stránka

Citováno z „https://wiki.astea.cz/index.php?title=Dosys:API/orderItem/GET&oldid=357“