Wiki source code of WS tacho

Version 3.6 by Admin on 2019/09/10 06:34

Show last authors
1 {{code language="none" title="**Request URL**"}}
2 GET http://etransportas.aktkc.lt/gps/api/webservices/tacho/events.ws?key=KEY&uid=UID
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 |key2|String|Authentication key: Key generation algorithm|
11
12 {{code language="json" title="**Response**"}}
13 {
14 "status": {
15 "code": 200,
16 "message": "OK"
17 },
18 "body": {
19 "tachos": [{
20 "carId": 15159,
21 "carNr": "KJO 617",
22 "tachoState": 3,
23 "driver1EventMinutesBefore": 4,
24 "driver1FullName": "VAIDAS SESETAS",
25 "driver1Data": {
26 "driveShort": 245,
27 "driveLong": 531,
28 "restingNow": 0,
29 "restLeft": 0,
30 "weekTotalDrivenMinutes": 69,
31 "driveThisWeekLeft": 3291,
32 "minutesToDailyRest": 1105,
33 "minutesTillWeeklyRest": 4223,
34 "weekReducedDailyRests": 0,
35 "nineHoursTimesExceeded": 0
36 },
37 "driver2EventMinutesBefore": 880,
38 "driver2FullName": "LAIMUTIS SAMUOLIS",
39 "bothDriversCombinedData": {
40 "driveLong": 833,
41 "driveThisWeek": 5114
42 }
43 },
44 {
45 "carId": 13268,
46 "carNr": "HZA 917",
47 "tachoState": 0,
48 "driver1EventMinutesBefore": 1,
49 "driver1FullName": "ARUNAS MILEVSKIS",
50 "driver1Data": {
51 "driveShort": 270,
52 "driveLong": 600,
53 "restingNow": 847,
54 "restLeft": 0,
55 "driveThisWeek": 3360,
56 "weekTotalDrivenMinutes": 0,
57 "driveThisWeekLeft": 3360,
58 "minutesToDailyRest": 1260,
59 "minutesTillWeeklyRest": 7775,
60 "weekReducedDailyRests": 0,
61 "nineHoursTimesExceeded": 0
62 },
63 "driver2EventMinutesBefore": 4870,
64 "driver2FullName": "JOSIF MACEL",
65 "bothDriversCombinedData": {
66 "driveLong": 1002,
67 "driveThisWeek": 6028
68 }
69 },
70 {
71 "carId": 10762,
72 "carNr": "GZD 408",
73 "tachoState": 0,
74 "driver1EventMinutesBefore": 4,
75 "driver1FullName": "SIARHEI HERASIMIUK",
76 "driver1Data": {
77 "driveShort": 0,
78 "driveLong": 181,
79 "restingNow": 33,
80 "restLeft": 0,
81 "weekTotalDrivenMinutes": 360,
82 "driveThisWeekLeft": 0,
83 "minutesToDailyRest": 396,
84 "minutesTillWeeklyRest": 0,
85 "weekReducedDailyRests": 0,
86 "nineHoursTimesExceeded": 0
87 }
88 }
89 }]
90 }
91 }
92 {{/code}}
93
94
95 |=(% colspan="3" style="text-align: center;" %)Json Body parameters
96 |=(% style="text-align: center;" %)Property|=(% style="text-align: center;" %)Type|=(% style="text-align: center;" %)Description
97 |tachos|Array|Array of tacho records
98
99 |=(% colspan="3" style="text-align: center;" %)Array node tachos parameters
100 |=(% style="text-align: center;" %)Property|=(% style="text-align: center;" %)Type|=(% style="text-align: center;" %)Description
101 |carId|Integer|Car ID webfleet app
102 |carNr|String|format "XXX 111"
103 |tachoState|Integer|Values: 0 - break/rest, 1 - availability, 2- work, 3 - drive
104 |driver1EventMinutesBefore|Integer|Driver 1 event data received before X minutes
105 |driver1FullName|String|Driver 1 full name
106 |driver1Data |Object|Data of driver 1
107 |driver2EventMinutesBefore |Integer|Driver 2 event data received before X minutes (if exists)
108 |driver2FullName |String|Driver 2 full name (if exists)
109 |bothDriversCombinedData |Object|Both drivers data (if exists)
110
111 |=(% colspan="3" style="text-align: center;" %)Object node driver1Data parameters
112 |=(% style="text-align: center;" %)Property|=(% style="text-align: center;" %)Type|=(% style="text-align: center;" %)Description
113 |driveShort|(% style="font-family:sans-serif; white-space:pre-wrap" %)Integer|4.5 hours interval left time in minutes
114 |driveLong |(% style="font-family:sans-serif; white-space:pre-wrap" %)Integer|Day left time in minutes
115 |restingNow |Integer|Resting now time in minutes
116 |restLeft|Integer|Rest time left in minutes
117 |weekTotalDrivenMinutes |Integer|Week drive total time in minutes
118 |driveThisWeekLeft|Integer|Week drive time left in minutes
119 |minutesToDailyRest |Integer|Minutes left until daily rest
120 |minutesTillWeeklyRest |Integer|Minutes left until weekly rest
121 |weekReducedDailyRests |Integer|Count of 9 hours rests during the week period
122 |nineHoursTimesExceeded|Integer|Count of more than 9 hours of work days during the week period
123
124 |=(% colspan="3" style="text-align: center;" %)Object node bothDriversCombinedData parameters
125 |=(% style="text-align: center; width: 343px;" %)Property|=(% style="text-align: center; width: 188px;" %)Type|=(% style="text-align: center;" %)Description
126 |(% style="width:343px" %)driveShort|(% style="font-family:sans-serif; white-space:pre-wrap; width:188px" %)Integer|4.5 hours interval left time in minutes (if exists)
127 |(% style="width:343px" %)driveLong|(% style="font-family:sans-serif; white-space:pre-wrap; width:188px" %)Integer|Day left time in minutes (if exists)
128 |(% style="width:343px" %)restingNow|(% style="font-family:sans-serif; white-space:pre-wrap; width:188px" %)Integer|Resting now time in minutes (if exists)
129 |(% style="width:343px" %)restLeft|(% style="font-family:sans-serif; white-space:pre-wrap; width:188px" %)Integer|Rest time left in minutes (if exists)
130 |(% style="width:343px" %)driveThisWeek |(% style="font-family:sans-serif; white-space:pre-wrap; width:188px" %)Integer|Week drive time left in minutes (if exists)