AutoReport Webová aplikácia GPS systému UniTrack

Transcription

1 AutoReport Webová aplikácia GPS systému UniTrack UniTrack Webová služba (technická dokumentácia) DeMoTech s.r.o. Prekážka 724, Liptovský Hrádok Web: Mobil: Tel./Fax:

2 1. Základné informácie o použití webovej služby Webová aplikácia AutoReport poskytuje najdôležitejšie informácie okrem štandardného webového rozhrania aj vo forme webovej služby. Pre komunikáciu s webovou službou sa používa štandardný SOAP protokol a rozhranie webovej služby je opísané jazykom WSDL. Pre pripojenie k webovej službe je potrebné zadefinovať WSDL opis webovej služby, ktorý je dostupný na adrese: Webová služba je dostupná cez štandardný HTTP aj zabezpečený HTTPS protokol. 2. rozhrania webovej služby Webová služba pre AutoReport vo verzii ( ) poskytuje prostredníctvom rozhrania 5 funkcií, ktorých podrobný opis je uvedený nižšie. Autentifikácia Príklad volania: login(username, password) login('demo', 'demo') String Pre potreby autentifikácie je potrebné použiť rovnaké prihlasovacie údaje, aké boli používateľovi poskytnuté pre prístup cez štandardné webové rozhrania. Po úspešnej autentifikácií webová služba vygeneruje náhodný token, ktorý slúžia na autentifikáciu počas ďalších volaní. Názov parametru parametru Predvolená hodnota username password Prihlasovacie meno pridelené používateľovi pre službu AutoReport Prihlasovacie heslo pridelené používateľovi pre službu AutoReport Povinný parameter Povinný parameter reťazca Vygenerovaný autentifikačný token Príklad demo:ws:53f3a52a74ba25046b4922c54d94fdf8 DeMoTech, s.r.o

3 Zoznam dostupných vozidiel Príklad volania: getvehiclelist(sessionkey) getvehiclelist('demo:ws:53f3a52a74ba25046b4922c54d94fdf8') Vehicle[] Funkcia vráti zoznam vozidiel, ku ktorým má prihlásený používateľ právo pristupovať. Názov parametru parametru Predvolená hodnota sessionkey Prihlasovací token Povinný parameter Názov atribútu atribútu Príklad id Identifikátor vozidla 1 reg_no EČ vozidla LM-137AS type Typ vozidla Peugeot Partner code Kód vozidla DEMO1 DeMoTech, s.r.o

4 Zoznam online záznamov vozidla Príklad volania: getvehiclerecords(sessionkey, vehicleid, starttime, endtime) getvehiclerecords ('demo:ws:53f...', 1, ' :00:00', ' :59:59') VehicleRecord[] Funkcia vráti zoznam online záznamov pre zvolené vozidlo v zadanom časovom intervale. Existujú dva typy online záznamov podľa hodnoty návratového kľúča type : position záznam obsahuje pozíciu vozidla (popis miesta, rýchlosť, súradnice) system záznam obsahuje textovú správu zaslanú z vozidla (napr. stav vozidla, alarmové hlásenie...) Názov parametru parametru Predvolená hodnota sessionkey Prihlasovací token Povinný parameter vehicleid Identifikátor vozidla Povinný parameter starttime Začiatočný dátum intervalu Povinný parameter endtime Koncový dátum intervalu Aktuálny čas Názov atribútu atribútu Príklad záznamu typu position id Identifikátor záznamu vehicle_id Identifikátor vozidla 1 type Typ záznamu (position alebo system) position date Dátum a čas prijatého záznamu (formát ISO 8601) T07:32:29+01:00 day_of_week Deň v týždni zodpovedajúci dátumu a času Streda description Pomenovanie najbližšieho nájdeného miesta zodpovedajúceho súradniciam vozidla distance Vzdialenosť od nájdeného miesta v metroch 81 Liptovský Mikuláš - Pod Stráňami speed Aktuálna rýchlosť v km/hod gps_validity Platnosť GPS polohy (1 platná, 0 neplatná) 1 latitude Zemepisná šírka longitude Zemepisná dĺžka vehicle_state Aktuálny stav vozidla (snímaných digitálnych vstupov GPS jednotky) Motor zapnuty, Sluzobna jazda, Motohodiny vypnute DeMoTech, s.r.o

5 Názov atribútu atribútu Príklad záznamu typu system id Identifikátor záznamu vehicle_id Identifikátor vozidla 1 type Typ záznamu (position alebo system) system date Dátum a čas prijatého záznamu (formát ISO 8601) T07:32:29+01:00 day_of_week Deň v týždni zodpovedajúci dátumu a času Piatok description Textová správa zaslaná z vozidla Motor vypnuty, Sluzobna jazda distance Vzdialenosť od nájdeného miesta v metroch 0 speed Aktuálna rýchlosť v km/hod 0.0 gps_validity Platnosť GPS polohy (1 platná, 0 neplatná) 1 latitude Zemepisná šírka 0.0 longitude Zemepisná dĺžka 0.0 vehicle_state Aktuálny stav vozidla (snímaných digitálnych vstupov GPS jednotky) Motor vypnuty, Sluzobna jazda, Motohodiny vypnute DeMoTech, s.r.o

6 Prehľad posledných online záznamov vozidiel getlastrecords(sessionkey, time, vehicleid) Príklad volania: getlastrecords('demo:ws:53f...', ' :00:00', 1) LastRecord[] Funkcia vráti prehľad posledných pozičných a systémových online záznamov pre zvolené vozidlo/všetky vozidlá k zadanému dátumu a času. Názov parametru parametru Predvolená hodnota sessionkey Prihlasovací token Povinný parameter time Požadovaný dátum a čas Aktuálny čas vehicleid Identifikátor vozidla Všetky dostupné vozidlá Názov atribútu atribútu Príklad vehicle_id Identifikátor vozidla 1 position system Objekt obsahujúci poslednú pozičnú správu, atribúty objektu sú totožné s objektom vráteným funkciou getvehiclerecords (type=position) Objekt obsahujúci poslednú systémovú správu, atribúty objektu sú totožné s objektom vráteným funkciou getvehiclerecords (type=system) DeMoTech, s.r.o

7 Zoznam offline jázd vozidla Príklad volania: getvehiclerides(sessionkey, vehicleid, starttime, endtime) getvehiclerides('demo:ws:53f...', 1, ' :00:00', ' :59:59') VehicleRide[] Funkcia vráti zoznam offline jázd pre zvolené vozidlo v zadanom časovom intervale. Offline jazdy vozidla predstavujú záznamy o najazdených trasách, z ktorých sa generuje elektronická kniha jázd vozidla. Názov parametru parametru Predvolená hodnota sessionkey Prihlasovací token Povinný parameter vehicleid Identifikátor vozidla Povinný parameter starttime Začiatočný dátum intervalu Povinný parameter endtime Koncový dátum intervalu Aktuálny čas Názov atribútu atribútu Príklad id Identifikátor jazdy vehicle_id Identifikátor vozidla 1 departure_date Dátum a čas odchodu (ISO 8601) T07:32:29+01:00 departure_day_of_week Deň v týždni zodpovedajúci odchodu Piatok departure_place Miesto odchodu Liptovský Mikuláš - Pod Stráňami arrival_date Dátum a čas príchodu (ISO 8601) T07:32:29+01:00 arrival_day_of_week Deň v týždni zodpovedajúci príchodu Piatok arrival_place Miesto príchodu Podtureň distance Prejdená vzdialenosť v km duration Doba trvania jazdy v sekundách 1263 business_ride 0 služobná, 1 súkromná jazda 1 city_ride 0 jazda mimo mesta, 1 v meste 0 refueling_credit_amount Tankovanie na kredit počet litrov 46.5 refueling_credit_price Tankovanie na kredit cena s DPH refueling_cash_amount Tankovanie hotovosť počet litrov 0.0 refueling_cash_price Tankovanie hotovosť cena s DPH 0.0 refueling_vat_rate Sadzba DPH v % 20.0 fuel_consumption fuel_remaining Zmena paliva v nádrži v litroch (v prípade palivovej sondy) Zostatok paliva v nádrži v litroch (v prípade palivovej sondy) driver Meno vodiča Kováč Juraj order_id Identifikátor zákazky order_description Názov zákazky Obchodná činnosť note Poznámka k jazde Rozvoz tovaru DeMoTech, s.r.o

8 3. Príklad implementácie SOAP klienta Príklad implementácie klienta pracujúceho s funkciami webovej služby v jazyku PHP. 1. // Location of WSDL file 2. $client=new SoapClient(' /** 5. * Performs login to the web service by the same credentials as the web system AutoReport uses. 6. string the username 7. string the password 8. string a sessionkey */ 11. $sessionkey = $client->login('demo', 'demo'); /** 14. * Returns the list of vehicles logged in user has access to. 15. string the session key 16. Vehicle[] the vehicle list */ 19. print_r($client->getvehiclelist($sessionkey)); /** 23. * Returns online records for particular vehicle between specified times. 24. string the session key 25. integer the vehicle id 26. datetime the start time 27. datetime the end time (optional, default value is current time) 28. VehicleRecord[] the vehicle records */ 31. print_r($client->getvehiclerecords($sessionkey, 1, ' :00:00', ' :59:59')); /** 34. * Returns last position and system records for particular vehicle before specified time. 35. * If time is not specified, the current time is used. 36. * If vehicle id is not specified, last records for all vehicles are returned. 37. string the session key 38. datetime the time (optional, default value is current time) 39. integer the vehicle id (optional, if no vehicle id is specified, array for all vehicles is returned) 40. LastRecord[] the vehicles last position and system records */ 43. print_r($client->getlastrecords($sessionkey, ' :00:00')); /** 46. * Returns offline rides for particular vehicle between specified times 47. string the session key 48. integer the vehicle id 49. datetime the start time 50. datetime the end time (optional, default value is current time) 51. VehicleRide[] the vehicle rides */ 54. print_r($client->getvehiclerides($sessionkey, 1, ' :00:00', ' :59:59')); DeMoTech, s.r.o