API/pass GET
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