Dosys:API/pass/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/pass GET}} {{VERSIONINFO|Dosys|4.3.6.1}} == Přehled == Endpoint slouží pro přístup k datům průchodů ve formátu JSON. == Parametry == ;id : typ [[{{NAMESPACE}}:API#Typy_parametrů|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 e…“)
 
 
(Není zobrazeno 7 mezilehlých verzí od stejného uživatele.)
Řádek 1: Řádek 1:
{{DISPLAYTITLE:API/pass GET}}
{{DISPLAYTITLE:API/pass GET}}
{{VERSIONINFO|Dosys|4.3.6.1}}
{{VERSIONINFO|Dosys|4.3.6.1}}
<pre>
GET [url docházky]?doc=api/pass
</pre>


== Přehled ==
== Přehled ==
Řádek 7: Řádek 10:
== Parametry ==
== Parametry ==
;id
;id
: typ [[{{NAMESPACE}}:API#Typy_parametrů|int]]
:typ [[{{NAMESPACE}}:API#Typy_parametrů|int]]
:ID konkrétního projektu.
:ID průchodu.
 
;passDate
:typ [[{{NAMESPACE}}:API#Typy_parametrů|date]]
:Datum průchodu.
 
;employee
:typ [[{{NAMESPACE}}:API#Typy_parametrů|string]]:
:Identifikátor zaměstnance.
 
;employee.number
:typ [[{{NAMESPACE}}:API#Typy_parametrů|string]]:
:Osobní číslo zaměstnance.


== Výsledek ==
== 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.
Formát návratové hodnoty závisí na existenci parametru '''id'''. Je-li uveden, vrací API objekt odpovídající průchodu s tímto ID. Pokud průchod s tímto ID neexistuje, vrací API HTTP error 404.


Není-li parametr '''id''' uveden, vrací endpoint seznam projektů.
Není-li parametr '''id''' uveden, vrací endpoint seznam průchodů, odpovídajících ostatním výběrovým podmínkám.
{| class="wikitable"
{| class="wikitable"
! Údaj || Typ || Popis
! Údaj || Typ || Popis
|-
|-
| ID || int || Unikátní identifikátor projektu.
| ID || int || Unikátní identifikátor průchodu.
|-
| CreateTime || dateTime || Čas vytvoření průchodu.
|-
| CreateUser || string || Jméno uživatele, který vytvořil průchod.
|-
| ModifyTime || datetime || Čas poslední změny průchodu.
|-
| ModifyUser || string || Jméno uživatele, který naposledy změnil průchod.
|-
| Employee || string || Identifikátor zaměstnance.
|-
| PassDate || date || Den docházky, ke kterému průchod náleží.
|-
| Term || int || Číslo terminálu.
|-
| TermCode || string || Číslo čipu.
|-
| PassType || string || Typ průchodu.
|-
| PassTerm || datetime || Čas průchodu v terminálu.
|-
| BtnTerm || int || Číslo tlačítka terminálu.
|-
| Pass || datetime || Čas průchodu.
|-
| PassReg || datetime || Čas průchodu, upravený podle pravidel docházky.
|-
| Door || int || Číslo dveří.
|-
| Dir || int || Směr 0 - příchod, 1 - odchod.
|-
| DocumentNumber || string || Číslo dokladu (např. neschopenky).
|-
|-
| OrderNumber || string || Číslo projektu.
| OrderItemID || int || Identifikátor projektu.
|-
|-
| Date || date || Datum projektu.
| Latitude || decimal || Zeměpisná šířka.
|-
|-
| AssemblyDate || date || Datum montáže.
| Longitude || decimal || Zeměpisná délka.
|-
|-
| OrderStatus || int || Stav projektu.
| Reg || int || Indikátor průchodu, spadajícího do docházky. 1 - ano, 0 - ne (například otevření dveří...).
|-
|-
| CustomerContactName || string || Zákazník.
| Err || int || Indikátor chybného - vyřazeného průchodu. 1 - ano, 0 - ne.
|-
|-
| Text|| string || Popis.
| Del || int || Indikátor smazaného průchodu. 1 - ano, 0 - ne.
|-
|-
| Note || string || Poznámka.
| Auto || int || Indikátor automaticky vloženého průchodu. 1 - ano, 0 - ne.
|}
|}


== Příklad ==
== Příklad ==
<pre>
<pre>
https://dochazka.mojefirma.cz?doc=api/orderItem
https://dochazka.mojefirma.cz?doc=api/pass


https://dochazka.mojefirma.cz?doc=api/orderItem&id=14
https://dochazka.mojefirma.cz?doc=api/pass&id=14
</pre>
</pre>


Aktuální verze z 22. 5. 2024, 08:59

Dosys 4.3.6.1 

GET [url docházky]?doc=api/pass

Přehled

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

Parametry

id
typ int
ID průchodu.
passDate
typ date
Datum průchodu.
employee
typ string:
Identifikátor zaměstnance.
employee.number
typ string:
Osobní číslo zaměstnance.

Výsledek

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

Není-li parametr id uveden, vrací endpoint seznam průchodů, odpovídajících ostatním výběrovým podmínkám.

Údaj Typ Popis
ID int Unikátní identifikátor průchodu.
CreateTime dateTime Čas vytvoření průchodu.
CreateUser string Jméno uživatele, který vytvořil průchod.
ModifyTime datetime Čas poslední změny průchodu.
ModifyUser string Jméno uživatele, který naposledy změnil průchod.
Employee string Identifikátor zaměstnance.
PassDate date Den docházky, ke kterému průchod náleží.
Term int Číslo terminálu.
TermCode string Číslo čipu.
PassType string Typ průchodu.
PassTerm datetime Čas průchodu v terminálu.
BtnTerm int Číslo tlačítka terminálu.
Pass datetime Čas průchodu.
PassReg datetime Čas průchodu, upravený podle pravidel docházky.
Door int Číslo dveří.
Dir int Směr 0 - příchod, 1 - odchod.
DocumentNumber string Číslo dokladu (např. neschopenky).
OrderItemID int Identifikátor projektu.
Latitude decimal Zeměpisná šířka.
Longitude decimal Zeměpisná délka.
Reg int Indikátor průchodu, spadajícího do docházky. 1 - ano, 0 - ne (například otevření dveří...).
Err int Indikátor chybného - vyřazeného průchodu. 1 - ano, 0 - ne.
Del int Indikátor smazaného průchodu. 1 - ano, 0 - ne.
Auto int Indikátor automaticky vloženého průchodu. 1 - ano, 0 - ne.

Příklad

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

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

Odkazy

API - přehled

Domovská stránka

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