Wiki source code of WS tacho

Version 2.7 by Admin on 2019/09/09 08:24

Show last authors
1 {{code language="none" title="**Request URL**"}}
2 GET http://etransportas.aktkc.lt/gps/api/ws/tacho.ws?key=5907351580FFA97BC3C5E173DF409549&uid=25454
3 {{/code}}
4
5
6 |=(% colspan="4" style="text-align: center;" %)Request parameters
7 |=(% style="text-align: center;" %)Property|=(% style="text-align: center;" %)Type|=(% style="text-align: center;" %)Description|=Default
8 |uid|Number|User Id in Webfleet system|
9 |key|String|Authentication key: MD5(username;password;client_IP_Address)|
10
11 {{code language="json" title="**Response**"}}
12 {
13 "status": {
14 "code": 200,
15 "message": "OK"
16 },
17 "body": {
18 "tachos": [{
19 "carId": 15159,
20 "carNr": "KJO 617",
21 "tachoState": 3,
22 "driver1EventMinutesBefore": 4,
23 "driver1EventDateTime": "09-09 10:25",
24 "driver1FullName": "VAIDAS SESETAS",
25 "driver1Data": {
26 "driveShort": 245,
27 "driveLong": 531,
28 "restingNow": 0,
29 "restLeft": 0,
30 "driveThisWeek": 3291,
31 "weekTotalDrivenMinutes": 69,
32 "driveThisWeekLeft": 3291,
33 "minutesToDailyRest": 1105,
34 "minutesTillWeeklyRest": 4223,
35 "weekReducedDailyRests": 0,
36 "nineHoursTimesExceeded": 0
37 },
38 "driver2EventMinutesBefore": 880,
39 "driver2EventMinutesBeforeFormatted": 0,
40 "driver2FullName": "LAIMUTIS SAMUOLIS",
41 "bothDriversCombinedData": {
42 "driveLong": 833,
43 "driveThisWeek": 5114
44 }
45 },
46 {
47 "carId": 13268,
48 "carNr": "HZA 917",
49 "tachoState": 0,
50 "driver1EventMinutesBefore": 1,
51 "driver1EventDateTime": "09-09 10:28",
52 "driver1FullName": "ARUNAS MILEVSKIS",
53 "driver1Data": {
54 "driveShort": 270,
55 "driveLong": 600,
56 "restingNow": 847,
57 "restLeft": 0,
58 "driveThisWeek": 3360,
59 "weekTotalDrivenMinutes": 0,
60 "driveThisWeekLeft": 3360,
61 "minutesToDailyRest": 1260,
62 "minutesTillWeeklyRest": 7775,
63 "weekReducedDailyRests": 0,
64 "nineHoursTimesExceeded": 0
65 },
66 "driver2EventMinutesBefore": 4870,
67 "driver2EventMinutesBeforeFormatted": 0,
68 "driver2FullName": "JOSIF MACEL",
69 "bothDriversCombinedData": {
70 "driveLong": 1002,
71 "driveThisWeek": 6028
72 }
73 },
74 {
75 "carId": 10762,
76 "carNr": "GZD 408",
77 "tachoState": 0,
78 "driver1EventMinutesBefore": 4,
79 "driver1EventDateTime": "09-09 10:25",
80 "driver1FullName": "SIARHEI HERASIMIUK",
81 "driver1Data": {
82 "driveShort": 0,
83 "driveLong": 181,
84 "restingNow": 33,
85 "restLeft": 0,
86 "driveThisWeek": 0,
87 "weekTotalDrivenMinutes": 360,
88 "driveThisWeekLeft": 0,
89 "minutesToDailyRest": 396,
90 "minutesTillWeeklyRest": 0,
91 "weekReducedDailyRests": 0,
92 "nineHoursTimesExceeded": 0
93 }
94 }
95 }]
96 }
97 }
98 {{/code}}
99
100
101 |=(% colspan="3" style="text-align: center;" %)Json Body parameters
102 |=(% style="text-align: center;" %)Property|=(% style="text-align: center;" %)Type|=(% style="text-align: center;" %)Description
103 |tachos|Array|Array of tacho records
104
105 |=(% colspan="3" style="text-align: center;" %)ObjectNode vehicleGroups parameters
106 |=(% style="text-align: center;" %)Property|=(% style="text-align: center;" %)Type|=(% style="text-align: center;" %)Description
107 |carId|Long|Car ID webfleet app
108 |carNr|String|format "XXX 111"
109 |overallDrivenTimeSumString|String|Overall driven time in String, format "hh:mm:ss"
110 |engineTimeSum |Long|Engine work time overall in milliseconds
111 |engineTimeSumString |String|Engine work time overall in String, format "hh:mm:ss"
112 |durationSum |Long|Duration of all events time in milliseconds
113 |durationSumString |String|Duration of all events time in String, format "hh:mm:ss"
114 |driveTimeDaySum |Long|Day drive time in milliseconds
115 |driveTimeDaySumString |String|Daytime driven time overall in String, format "hh:mm:ss"
116 |driveTimeNightSum |Long|Night drive time in milliseconds
117 |driveTimeNightSumString |String|Night time driven time overall in String, format "hh:mm:ss"
118 |distanceGPSSum |Double|Distance traveled overall value from GPS (km)
119 |distanceGPSSumString |String|Distance by S overall value in String, format "x.yy"
120 |distanceFMSSum |Double|Distance traveled overall value from FMS (km)
121 |distanceFMSSumString |String|Distance by FMS overall value in String, format "x.yy"
122 |**Events** |ArrayNode|Array of car events
123
124 |=(% colspan="3" style="text-align: center;" %)ArrayNode Events parameters
125 |=(% style="text-align: center;" %)Property|=(% style="text-align: center;" %)Type|=(% style="text-align: center;" %)Description
126 |endDate |{{{String}}}|Event start date in String, format "yyyy-MM-dd hh:mm:ss"
127 |startDate |{{{String}}}|Event end date in String, format "yyyy-MM-dd hh:mm:ss"
128 |drivenTimeOverallString |String|String value of **overallTime**, format "hh:mm:ss"
129 |engineTimeString |String|String value of **engineTime**, format "hh:mm:ss"
130 |durationString |String|String value of **duration**, format "hh:mm:ss"
131 |driveTimeNightString |String|String value of **driveTimeNight**, format "hh:mm:ss"
132 |driveTimeDayString |String|String value of **driveTimeDay**, format "hh:mm:ss"
133 |distanceGPSString |String|String value of **distanceGPS**, format "x.yy"
134 |distanceFMSString |String|String value of **distanceFMS**, format "x.yy"
135 |duration |Long|Duration between events in milliseconds
136 |engineTime |Long|Event engine time in milliseconds
137 |overallTime |Long|Event overall driven time in milliseconds
138 |driveTimeDay |Long|Event day driven time in milliseconds
139 |driveTimeNight |Long|Event night driven time in milliseconds
140 |distanceGPS |Double|Distance traveled value from GPS (km)
141 |distanceFMS |Double|Distance traveled value from FMS (km)