Příklady metod Developer API

Metody Developer API umožňují získat z databáze aplikace vybrané souhrnné informace ve standardizovaném formátu pro jejich další zpracování v klientských aplikacích. Základní exporty jsou pro uživatele aplikace dostupné zdarma (ve verzích Standard a Premium).

Kontaktuje svého obchodníka pro bližší informace.

Exporty knihy jízd

• Kniha Jízd - Export základní
  Export vrací dataset obsahující dvě tabulky následující struktury:

  • vyjezd_datum (System.DateTime) - Datum výjezdu vozidla
  • prijezd_datum (System.DateTime) - Datum příjezdu vozidla
  • mista (System.String) - Místa trasy vozidla
  • ucel (System.String) – Účel trasy
  • ridic (System.String) - Řidič
  • delka_osobni (System.Decimal) - Ujetá vzdálenost osobní
  • delka_firemni (System.Decimal)- Ujetá vzdálenost služební
  • delka (System.Decimal) - Celková ujetá vzdálenost
  • tachometr (System.Decimal) - Vzdálenost podle tachometru
  • gps_kniha (System.Boolean) - Příznak, zda jsou trasy neschválené

  
  

  • vozidlo_spz (System.String) - SPZ vozidla
  • vozidlo_nazev (System.String) - Název vozidla
  • tachometr_pocatecni (System.Decimal) - Počáteční stav tachometru
  • tachometr_koncovy (System.Decimal) – Koncový stav tachometru
• Kniha jízd - Základní - Za firmu
  Základní export systému zahrnující všechna vozidla firmy. Exportuje standardní knihu jízd pro všechna vozidla firmy za určené časové období.

  Export vrací dataset obsahující dvě tabulky následující struktury:

  • vozidlo_spz (System.String) - SPZ vozidla
  • vyjezd_datum (System.DateTime) - Datum výjezd vozidla
  • prijezd_datum (System.DateTime) - Datum příjezdu vozidla
  • mista (System.String) – Místa trasy vozidla
  • ucel (System.String) - Účel cesty
  • ridic (System.String) - Řidič
  • delka_osobni (System.Decimal)- Ujetá vzdálenost osobní
  • delka_firemni (System.Decimal) - Ujetá vzdálenost služební
  • delka (System.Decimal) - Celková ujetá vzdálenost
  • tachometr (System.Decimal) - Vzdálenost podle tachometru
  • pocet_projetych_sekund (System.Int32) - Počet projetých sekund za trasu

  
  

  • vozidlo_spz (System.String) - SPZ vozidla
  • vozidlo_nazev (System.String) - Název vozidla
  • suma_delka_osobni (System.Decimal) - Celková ujetá vzdálenost osobní
  • suma_delka_firemni (System.Decimal) – Celková ujetá vzdálenost firemní
  • suma_delka (System.Decimal) – Celková ujetá vzdálenost
  • suma_pocet_projetych_sekund (System.Int32) – Celkový počet projetých sekund

Exporty posledních poloh

• Kniha Jízd - Export vozidel v pohybu
  Export všech vozidel v pohybu, na které má uživatel právo.

  Export vrací dataset obsahující jedinou tabulku následující struktury:

  • RFID (System.String) - Přijatý RFID kód vozidla
  • ID_Vozidla (System.String) - ID vozidla
  • SPZ (System.String) - SPZ vozidla
  • Druh_Vozidla (System.String) – Druh vozidla
  • Stav_Prepravy (System.String) - Stav přepravy
  • Datum_Vyjezdu (System.DateTime) - Datum a čas výjezdu
  • Ridic (System.String)- Jméno a příjmení řidiče
  • Mobil_Ridice (System.String) - Telefonnní číslo na mobil řidiče
• Kniha Jízd - Export vozidel v pohybu s detailem
  Export všech vozidel nebo jednoho vozidla v pohybu s detailem (např. poloha vozidla)

  Export vrací dataset obsahující jedinou tabulku následující struktury:

  • RFID (System.String) - Přijatý RFID kód vozidla
  • ID_Vozidla (System.String) - ID vozidla
  • Stav_Prepravy (System.String) - Stav přepravy
  • Stav_Nouze (System.String) – Informace zda nastal stav nouze
  • Datum_Vyjezdu (System.DateTime) - Datum a čas výjezdu
  • WGS_Delka (System.Decimal) - Zeměpisná délka poslední pozice (wgs souřadný systém)
  • WGS_Sirka (System.Decimal)- Zeměpisná šířka poslední pozice (wgs souřadný systém)
  • Poloha_Cas (System.DateTime) - Datum a čas poslední pozice
• Kniha Jízd - Poslední poloha vozidel
  Speciální export. Exportuje poslední polohu vozidel dostupných u uživatele nebo dle seznamu SPZ. Datum poslední polohy je ve formátu UTC.

  Export vrací dataset obsahující jedinou tabulku následující struktury:

  • spz (System.String) - SPZ vozidla
  • nazev_vozidla (System.String) - Název vozidla
  • vozidlo_id (System.Int32) - ID vozidla
  • vin (System.String) – VIN kód vozidla
  • datum (System.DateTime) - Datum a čas poslední pozice
  • wgs_delka (System.Decimal) - Zeměpisná délka poslední pozice (wgs souřadný systém)
  • wgs_sirka (System.Decimal)- Zeměpisná šířka poslední pozice (wgs souřadný systém)
  • misto (System.String) - Název místa poslední pozice
  • sluzebni_jizda (System.Boolean) - Příznak, zda je poslední pozice služební
  • klicek (System.Boolean) - Příznak, zda je zapnuto zapalování
  • ridic_prihlasen (System.Boolean) - Příznak, zda je řidič přihlášen
  • ridic_rfid (System.String) - RFID řidiče
  • ridic_jmeno (System.String) - Jméno řidiče
  • rfid (System.String)– Přijatý RFID kód

  Export může být volán nejčastěji jedenkrát za dvě minuty.

Exporty výdajů

• Seznam výdajů
  Export vrací dataset obsahující dvě tabulky následující struktury:

  • datum (System.DateTime) - Datum výdaje
  • misto (System.String) - Místo uskutečnění výdaje
  • nazev (System.String) - Název výdaje
  • ridic (System.String) – Řidič
  • vozidlo (System.String) - SPZ a název vozidla
  • phm (System.Boolean) - Příznak,zda je výdaj za pohonné hmoty
  • palivo (System.String)- Typ tankovaného paliva
  • pocet_litru (System.Decimal) - Počet tankovaných litrů
  • dph_sazba (System.Int32) - Sazba DPH
  • castka_dph (System.Decimal) - Částka DPH
  • cena_palivo (System.Decimal) - Cena za litr paliva
  • cena_zaklad (System.Decimal) - Cena bez DPH
  • cena_celkem (System.Decimal) - Celková cena s DPH

  
  

  • mena (System.String) - Měna výdaje
  • soucet_litru_celkem (System.Decimal) - Součet celkem tankovaných litrů
  • soucet_cena_zaklad (System.Decimal) - Součet všech cen bez DPH
  • suma_cena_celkem (System.Decimal) – součet všech cen s DPH

Administrace vozidel a uživatelů

• Seznam údajů o vozidle v knize jízd (SAP)
  Export vrací data pouze pro schválené trasy

  Export vrací dataset obsahující jedinou tabulku následující struktury:

  • cislo_jednotky (System.String) - Číslo jednotky
  • datum_jizdy_zacatek (System.Int32) - Datum zahájení trasy
  • cas_jizdy_zacatek (System.Int32) - Čas zahájení trasy
  • datum_jizdy_konec (System.Int32) – Datum ukončení trasy
  • cas_jizdy_konec (System.Int32) - Čas ukončení trasy
  • odkud (System.String) - Počáteční místo
  • kudy (System.String) - Přes
  • kam (System.String) - Koncové místo
  • zeme (System.String) - Země, kde byla vykonána trasa
  • ujeto (System.Int32)- Ujetá vzdálenost
  • tacho_od (System.Int32) - Stav tachometru na počátku trasy
  • tacho_do (System.Int32) - Stav tachometru na konci trasy
  • nadrz_do (System.Int32) - Stav nádrže na konci trasy
  • druh_jizdy (System.String) – Druh trasy
  • anomalie (System.String) - Anomálie
  • struktura_dodatecnych_dat (System.String) - Struktura dodatečných dat
  • dodatecna_data (System.String) - Dodatečná data
• Administrativní služba

  Službu je možné použít pro vrácení seznamu, vytvoření, editaci nebo smazání uživatele nebo vozidla. Při import údajů je potřeba dodržet pevně danou strukturu uvedenou v následujících tabulkách. Zejména je potřeba dodržet počet, pořadí a očekávaný formát dat. U nepovinných hodnot je možné vynechat samotnou hodnotu, ale středník (;) ukončující danou hodnotu být vynechán nesmí.

  
  

  Seznam metod:

  • Vozidlo NoveVozidlo( string jmeno, string heslo, unsignedByte druh )
    Vrátí instanci třídy Vozidlo vyplněnou výchozími hodnotami stejně jako v aplikaci. Pro tuto akci je potřeba zadat druh vozidla jako jednu z výčtových hodnot v aplikaci. Tato akce fyzicky v databázi žádné vozidlo nevytváří, to se vytvoří až metodou UlozitVozidlo, za předpokladu, že ID vozidla zůstane nulové.
    
  • Bool UlozitVozidlo ( string jmeno, string heslo, Vozidlo vozidlo )
    Vytvoří nebo změní údaje u vozidla.
    
  • Bool SmazatVozidlo ( string jmeno, string heslo, int id )
    Úplně smaže vozidlo
    
  • Vozidlo[] SeznamVozidel ( string jmeno, string heslo )
    Vrátí seznam všech vozidel dostupných uživateli.
    
  • Uzivatel NovyUzivatel ( string jmeno, string heslo )
    Vrátí předvyplněnou třídu uživatel, stejně jako předvyplňuje formulář v aplikaci při založení nového uživatele. Uživatel není v db fyzicky vytvořen, to se provede až po nastavení zbývajících povinných hodnot a zavolání metody UlozitUzivatele. ID uživatele musí zůstat nevyplněné nebo vyplněné na hodnotu prázdného GUID (00000000-0000-0000-0000-000000000000).
    
  • Int UlozitUzivatele ( string jmeno, string heslo, Uzivatel uzivatel )
    Vytvoří nového nebo uloží změny u stávajícího uživatele.
    
  • Bool SmazatUzivatele ( string jmeno, string heslo, Guid id )
    Fyzicky odstraní uživatel z databáze.
    
  • Uzivatele[] SeznamUzivatelu ( string jmeno, string heslo )
    Vrátí seznam dostupných uživatelů firmy.
    
  • Oddeleni[] SeznamOddeleni ( string jmeno, string heslo )
    Vrátí seznam oddělení firmy dle oprávnění uživatele a firmy.
    
  • Sestava[] SeznamSestav ( string jmeno, string heslo )
    Vrátí seznam reportů (obecné reporty + reporty) dle oprávnění uživatele a firmy.
    
  • string[] Status ( string jmeno, string heslo )
    Metoda vrátí podrobnější informace o výsledku posledního volání nějaké jiné metody zadaným uživatelem.
    

  
  
  

  Popis polí zaznamu pro import uživatelů:
  Pole	Položka v aplikaci KJ	Příklad hodnoty	Přípustné hodnoty	Povinná hodnota	Popis
  ID	ID	12345678-1234-1234-1234-012345678910		Ano	Jedinečné identifikační číslo uživatele. Při vytváření nového uživatele musí zůstat nezadané nebo mít hodnotu 00000000-0000-0000-0000-000000000000
  SlozkaID	Oddělení	1458		Ano	Zařazení uživatele do organizační struktury Vaší společnosti
  VychoziVozidloID	Jednotka	20134		Ne	Výchozí vozidlo, které je v různých dialozích nabízeno jako první
  Jmeno	Jméno	Petr		Ano	Jméno uživatele
  Prijmeni	Příjmení	Novák		Ano	Příjmení uživatele
  Email	Email	petrnovak@mail.cz		Ano	Kontaktní e-mail uživatele
  Telefon	Telefon	+420987654321		Ne	Kontaktní telefon uživatele v mezinárodním formátu. Povinné pouze pokud má uživatel povolenu SMS autentizaci. Pokud je telefonní číslo zadáno musí být unikátní v rámci celé aplikace.
  Autentizace	Autentizace	0	0, 1, 3, 4	Ne	Autentizace (0 - Heslo, 1 - SMS, 3 - Google Authenticator, 4 - LATCH)
  KodUzivatele	Kód uživatele	0123456789		Ne	Kód RFID identifikátoru uživatele, nutný pro automatické zpracovávání dat. Musí mít přesně 10 znaků.
  CisloStrediska	Číslo střediska	874ABD879		Ne	Text z tohoto pole je doplňován u výdajů, vykazovaných na uživatele
  InterniID	Interní ID	879476		Ne	Interní identifikační číslo uživatele
  Jazyk	Jazyk	cs		Ne	Výchozí jazyk rozhraní aplikace
  Mena	Měna	czk		Ne	Výchozí měna, která bude použita při práci s výdaji
  Stat	Stát	cr		Ne	Výchozí stát uživatele
  VelikostStranky	Velikost stránky	20		Ne	Počet záznamů zobrazovaných ve výpisech na jedné stránce
  Timeout	Automatické odhlášení při nečinnosti za	20		Ne	Počet minut při nečinnosti, po uplynutí kterých dojde k automatickému odhlášení uživatele.
  UvodniStrana	Typ úvodní stránky	0	0, 1	Ne	Volba základního a dispečerského zobrazení úvodní stránky
  UvodniSestavaID	Report na úvodní stránce	1		Ne	Pokud zvolíte dispečerskou úvodní stránku, zadejte ID sestavy, která se má na stránce zobrazovat
  UvodniSestavaTyp	Typ reportu na úvodní stránce	3		Ne	Viz předchozí
  PrihlasovaciJmeno	Přihl. jméno	PetrNovak		Ano	Přihlašovací jméno je povinné, pokud je uživatel aktivní. Musí být unikátní v celé aplikaci (max. 50 znaků).
  PrihlasovaciHeslo	Přihl. heslo	pEtr1234		Ano	Heslo je povinné, pokud je uživatel aktivní. Heslo musí mít minimálně 8 znaků, musí obsahovat malé a velké písmeno, číslici a nesmí obsahovat uživatelské jméno.
  OdeslatPristupoveUdaje	Odeslat přístupové údaje	1	0, 1	Ne	Pro odeslání přístupových údajů uživatele na jeho email nastavte hodnotu 1
  Aktivni	Aktivní	1	0, 1	Ne	Pokud je hodnota nastavena na 0, nebude se uživatel moci přihlásit do aplikace
  Admin	Admin	1	0, 1	Ne	Nastavením hodnoty 1 získá uživatel přístup do modulu administrace
  Ridic	Řidič	1	0, 1	Ne	Definuje, zda je uživatel nabízen v dialozích, kde se pracuje s řidiči
  Dispecer	Dispečer	1	0, 1	Ne	Pokud je uživatel dispečer, zobrazuje se mu pouze úvodní stránka s mapou aktuální polohy vozidel, plánovač servisních úkonů a jeden vybraný report dle výchozího nastavení.
  Spolujezdec	Spolujezdec	1	0, 1	Ne	Definuje, zda je uživatel nabízen v dialozích, kde se pracuje se spolujezdci
  Leasing	Leasing	1	0, 1	Ne	Nastavením hodnoty 1 získá uživatel přístup do modulu leasingu (pokud je tato funkce v danné verzi aplikace podporována)
  Alerty	Alerty	1	0, 1	Ne	Nastavením hodnoty 1 získá uživatel přístup do modulu alerty (pokud je tato funkce v danné verzi aplikace podporována)
  NadrizenyID	Nadřízený ID	123		Ne	ID nadřízeného uživatele
  NadrizenyJmeno	Nadřízený jméno	Petr		Ne	Jméno nadřízeného uživatele (při importu je hodnota ignorována)
  NadrizenyPrijmeni	Nadřízený příjmení	Novák		Ne	Příjmení nadřízeného uživatele (při importu je hodnota ignorována)
  KartaAgip	Agip karta	12345678901234567890		Ne	Číslo čerpací karty společnosti Agip
  KartaAxigon	Axigon karta	12345678901234567890		Ne	Číslo čerpací karty společnosti Axigon
  KartaBenzina	Benzina karta	12345678901234567890		Ne	Číslo čerpací karty společnosti Benzina
  KartaCCS	CCS karta	12345678901234567890		Ne	Číslo čerpací karty společnosti CCS
  KartaCepro	Čepro karta	12345678901234567890		Ne	Číslo čerpací karty společnosti Čepro
  KartaCepsa	Cepsa karta	12345678901234567890		Ne	Číslo čerpací karty společnosti Cepsa
  KartaInnogy	CNG Innogy karta	12345678901234567890		Ne	Číslo čerpací karty společnosti CNG Innogy
  KartaCopec	Copec karta	12345678901234567890		Ne	Číslo čerpací karty společnosti Copec
  KartaDKV	DKV karta	12345678901234567890		Ne	Číslo čerpací karty společnosti DKV
  KartaEON	E.ON CNG karta	12345678901234567890		Ne	Číslo čerpací karty společnosti E.ON CNG
  KartaShell	(euro)Shell karta	12345678901234567890		Ne	Číslo čerpací karty společnosti Shell
  KartaEvotechVozidloID	Evotech karta	12345678901234567890		Ne	Číslo čerpací karty společnosti Evotech
  KartaMakro	Makro karta	12345678901234567890		Ne	Číslo čerpací karty společnosti MAKRO
  KartaMOL	MOL karta	12345678901234567890		Ne	Číslo čerpací karty společnosti MOL
  KartaOMV	OMV karta	12345678901234567890		Ne	Číslo čerpací karty společnosti OMV
  KartaRepsol	Repsol karta	12345678901234567890		Ne	Číslo čerpací karty společnosti Repsol
  KartaSlovnaft	Slovnaft karta	12345678901234567890		Ne	Číslo čerpací karty společnosti Slovnaft
  KartaStatoil	Statoil karta	12345678901234567890		Ne	Číslo čerpací karty společnosti Statoil
  KartaViaT	Via T karta	12345678901234567890		Ne	Číslo čerpací karty společnosti Via T
  KartaYPF	YPF karta	12345678901234567890		Ne	Číslo čerpací karty společnosti YPF
  PosledniMesic	Omezení záznamů	1	0, 1	Ne	Určuje, zda mají být ve výpisech zobrazovány záznamy pouze z aktuálního měsíce
  VydajeDetail	Detail výdaje	0	0, 1	Ne	Určuje, zda mají být při otevření záznamu výdaje importovaného z karty zobrazeny detailní údaje
  PamatovatPosledniCesty	Naposledy vložené	1	0, 1	Ne	Určuje, zda má být při vytváření nové trasy a výdaje formulář předvyplněný dle naposledy vytvořeného záznamu
  ZobrazovatUvodniStranku	Zobrazit úvodní stranu	1	0, 1	Ne	Nastavení zobrazení úvodní strany po přihlášení uživatele
  Poznamka	Poznámka			Ne	Poznámka u uživatele