Changes for page WS tacho

Last modified by Admin on 2019/09/10 07:10

From version 2.1
edited by Admin
on 2019/09/09 08:14
To version 2.2
edited by Admin
on 2019/09/09 08:15
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,76 +1,76 @@
1 - 1: ~{~{code language="none" title="~*~*Request URL~*~*"}}
2 - 2: GET http:~/~/etransportas.aktkc.lt/gps/api/webservices/FranceReport.ws?key=5907351580FFA97BC3C5E173DF409549&uid=25454&dateFrom=2016-12-01_000000&dateTo=2016-12-31_235959
3 - 3: ~{~{/code}}
4 - 4:
5 - 5:
6 - 6: |=~(% colspan="4" style="text-align: center;" %)Request parameters
7 - 7: |=~(% style="text-align: center;" %)Property|=~(% style="text-align: center;" %)Type|=~(% style="text-align: center;" %)Description|=Default
8 - 8: |uid|Number|User Id in Webfleet system|~\~\
9 - 9: |key|String|Authentication key: MD5(username;password;client_IP_Address)|~\~\
10 -10: |key2|String|Authentication key: ~[~[Key generation algorithm>>doc:webfleet_ws_key_generation]]|~\~\
11 -11: |dateFrom|String|Date from in format yyyy-dd-MM |~\~\
12 -12: |dateTo|String|Date to in format yyyy-dd-MM |~\~\
13 -13:
14 -14: ~{~{code language="json" title="~*~*Response~*~*"}}
15 -15: "body":{"FranceReport":
16 -16: {"vehicleGroups":[
17 -17: {
18 -18: "carNr":"ZZZ 001","overallDrivenTimeSum":75267000,"overallDrivenTimeSumString":"20:54:27","engineTimeSum":88592000,"engineTimeSumString":"24:36:32","durationSum":260436000,"durationSumString":"72:20:36","driveTimeDaySum":45468000,"driveTimeDaySumString":"12:37:48","driveTimeNightSum":29799000,"driveTimeNightSumString":"08:16:39","distanceGPSSum":1258.6050197303023,"distanceGPSSumString":"1258.61","distanceFMSSum":1272.5049999991897,"distanceFMSSumString":"1272.5",
19 -19: "Events":[
20 -20: {"endDate":"2016-12-02 08:13:30","startDate":"2016-12-02 06:08:00","drivenTimeOverallString":"01:47:29","engineTimeString":"01:47:29","durationString":"02:05:30","driveTimeNightString":"01:34:07","driveTimeDayString":"00:13:22","distanceGPSString":"132.16","distanceFMSString":"135.38","duration":7530000,"engineTime":6449000,"overallTime":6449000,"driveTimeDay":802000,"driveTimeNight":5647000,"distanceGPS":132.15733675720702,"distanceFMS":135.37999999988824},
21 -21: {"endDate":...
22 -22: ]
23 -23: }
24 -24: }
25 -25: {
26 -26: "carNr":"ZZZ 001",...
27 -27: "Events":[...]
28 -28: }
29 -29: ]
30 -30: }
31 -31: }
32 -32: ~{~{/code}}
33 -33:
34 -34:
35 -35: |=~(% colspan="3" style="text-align: center;" %)Json FranceReport parameters
36 -36: |=~(% style="text-align: center;" %)Property|=~(% style="text-align: center;" %)Type|=~(% style="text-align: center;" %)Description
37 -37: |vehicleGroups|Array|Array of single car records
38 -38:
39 -39: |=~(% colspan="3" style="text-align: center;" %)ObjectNode vehicleGroups parameters
40 -40: |=~(% style="text-align: center;" %)Property|=~(% style="text-align: center;" %)Type|=~(% style="text-align: center;" %)Description
41 -41: |carNr |String~\~\|format "XXX 111"~\~\
42 -42: |overallDrivenTimeSum|Long~\~\|Overall driven time in milliseconds~\~\
43 -43: |overallDrivenTimeSumString|String~\~\|Overall driven time in String, format "hh:mm:ss"~\~\
44 -44: |engineTimeSum |Long~\~\|Engine work time overall in milliseconds~\~\
45 -45: |engineTimeSumString |String~\~\|Engine work time overall in String, format "hh:mm:ss"~\~\
46 -46: |durationSum |Long~\~\|Duration of all events time in milliseconds~\~\
47 -47: |durationSumString |String~\~\|Duration of all events time in String, format "hh:mm:ss"~\~\
48 -48: |driveTimeDaySum |Long~\~\|Day drive time in milliseconds~\~\
49 -49: |driveTimeDaySumString |String~\~\|Daytime driven time overall in String, format "hh:mm:ss"~\~\
50 -50: |driveTimeNightSum |Long~\~\|Night drive time in milliseconds~\~\
51 -51: |driveTimeNightSumString |String~\~\|Night time driven time overall in String, format "hh:mm:ss"~\~\
52 -52: |distanceGPSSum |Double~\~\|Distance traveled overall value from GPS (km)~\~\
53 -53: |distanceGPSSumString |String~\~\|Distance by S overall value in String, format "x.yy"~\~\
54 -54: |distanceFMSSum |Double~\~\|Distance traveled overall value from FMS (km)~\~\
55 -55: |distanceFMSSumString |String~\~\|Distance by FMS overall value in String, format "x.yy"~\~\
56 -56: |~*~*Events~*~* |ArrayNode~\~\|Array of car events~\~\
57 -57:
58 -58: |=~(% colspan="3" style="text-align: center;" %)ArrayNode Events parameters
59 -59: |=~(% style="text-align: center;" %)Property|=~(% style="text-align: center;" %)Type|=~(% style="text-align: center;" %)Description
60 -60: |endDate |~{~{~{String}}}|Event start date in String, format "yyyy-MM-dd hh:mm:ss"~\~\
61 -61: |startDate |~{~{~{String}}}|Event end date in String, format "yyyy-MM-dd hh:mm:ss"~\~\
62 -62: |drivenTimeOverallString |String~\~\|String value of ~*~*overallTime~*~*, format "hh:mm:ss"~\~\
63 -63: |engineTimeString |String~\~\|String value of ~*~*engineTime~*~*, format "hh:mm:ss"~\~\
64 -64: |durationString |String~\~\|String value of ~*~*duration~*~*, format "hh:mm:ss"~\~\
65 -65: |driveTimeNightString |String~\~\|String value of ~*~*driveTimeNight~*~*, format "hh:mm:ss"~\~\
66 -66: |driveTimeDayString |String~\~\|String value of ~*~*driveTimeDay~*~*, format "hh:mm:ss"~\~\
67 -67: |distanceGPSString |String~\~\|String value of ~*~*distanceGPS~*~*, format "x.yy"
68 -68: |distanceFMSString |String~\~\|String value of ~*~*distanceFMS~*~*, format "x.yy"
69 -69: |duration |Long~\~\|Duration between events in milliseconds~\~\
70 -70: |engineTime |Long~\~\|Event engine time in milliseconds~\~\
71 -71: |overallTime |Long~\~\|Event overall driven time in milliseconds~\~\
72 -72: |driveTimeDay |Long~\~\|Event day driven time in milliseconds~\~\
73 -73: |driveTimeNight |Long~\~\|Event night driven time in milliseconds~\~\
74 -74: |distanceGPS |Double~\~\|Distance traveled value from GPS (km)~\~\
75 -75: |distanceFMS |Double~\~\|Distance traveled value from FMS (km)~\~\
76 -
1 +
2 +{{code language="none" title="**Request URL**"}}
3 +GET http://etransportas.aktkc.lt/gps/api/webservices/FranceReport.ws?key=5907351580FFA97BC3C5E173DF409549&uid=25454&dateFrom=2016-12-01_000000&dateTo=2016-12-31_235959
4 +{{/code}}
5 +
6 +
7 +|=(% colspan="4" style="text-align: center;" %)Request parameters
8 +|=(% style="text-align: center;" %)Property|=(% style="text-align: center;" %)Type|=(% style="text-align: center;" %)Description|=Default
9 +|uid|Number|User Id in Webfleet system|\\
10 +|key|String|Authentication key: MD5(username;password;client_IP_Address)|\\
11 +|key2|String|Authentication key: [[Key generation algorithm>>doc:webfleet_ws_key_generation]]|\\
12 +|dateFrom|String|Date from in format yyyy-dd-MM |\\
13 +|dateTo|String|Date to in format yyyy-dd-MM |\\
14 +
15 +{{code language="json" title="**Response**"}}
16 +"body":{"FranceReport":
17 + {"vehicleGroups":[
18 + {
19 + "carNr":"ZZZ 001","overallDrivenTimeSum":75267000,"overallDrivenTimeSumString":"20:54:27","engineTimeSum":88592000,"engineTimeSumString":"24:36:32","durationSum":260436000,"durationSumString":"72:20:36","driveTimeDaySum":45468000,"driveTimeDaySumString":"12:37:48","driveTimeNightSum":29799000,"driveTimeNightSumString":"08:16:39","distanceGPSSum":1258.6050197303023,"distanceGPSSumString":"1258.61","distanceFMSSum":1272.5049999991897,"distanceFMSSumString":"1272.5",
20 + "Events":[
21 + {"endDate":"2016-12-02 08:13:30","startDate":"2016-12-02 06:08:00","drivenTimeOverallString":"01:47:29","engineTimeString":"01:47:29","durationString":"02:05:30","driveTimeNightString":"01:34:07","driveTimeDayString":"00:13:22","distanceGPSString":"132.16","distanceFMSString":"135.38","duration":7530000,"engineTime":6449000,"overallTime":6449000,"driveTimeDay":802000,"driveTimeNight":5647000,"distanceGPS":132.15733675720702,"distanceFMS":135.37999999988824},
22 + {"endDate":...
23 + ]
24 + }
25 + }
26 + {
27 + "carNr":"ZZZ 001",...
28 + "Events":[...]
29 + }
30 + ]
31 + }
32 +}
33 +{{/code}}
34 +
35 +
36 +|=(% colspan="3" style="text-align: center;" %)Json FranceReport parameters
37 +|=(% style="text-align: center;" %)Property|=(% style="text-align: center;" %)Type|=(% style="text-align: center;" %)Description
38 +|vehicleGroups|Array|Array of single car records
39 +
40 +|=(% colspan="3" style="text-align: center;" %)ObjectNode vehicleGroups parameters
41 +|=(% style="text-align: center;" %)Property|=(% style="text-align: center;" %)Type|=(% style="text-align: center;" %)Description
42 +|carNr |String\\|format "XXX 111"\\
43 +|overallDrivenTimeSum|Long\\|Overall driven time in milliseconds\\
44 +|overallDrivenTimeSumString|String\\|Overall driven time in String, format "hh:mm:ss"\\
45 +|engineTimeSum |Long\\|Engine work time overall in milliseconds\\
46 +|engineTimeSumString |String\\|Engine work time overall in String, format "hh:mm:ss"\\
47 +|durationSum |Long\\|Duration of all events time in milliseconds\\
48 +|durationSumString |String\\|Duration of all events time in String, format "hh:mm:ss"\\
49 +|driveTimeDaySum |Long\\|Day drive time in milliseconds\\
50 +|driveTimeDaySumString |String\\|Daytime driven time overall in String, format "hh:mm:ss"\\
51 +|driveTimeNightSum |Long\\|Night drive time in milliseconds\\
52 +|driveTimeNightSumString |String\\|Night time driven time overall in String, format "hh:mm:ss"\\
53 +|distanceGPSSum |Double\\|Distance traveled overall value from GPS (km)\\
54 +|distanceGPSSumString |String\\|Distance by S overall value in String, format "x.yy"\\
55 +|distanceFMSSum |Double\\|Distance traveled overall value from FMS (km)\\
56 +|distanceFMSSumString |String\\|Distance by FMS overall value in String, format "x.yy"\\
57 +|**Events** |ArrayNode\\|Array of car events\\
58 +
59 +|=(% colspan="3" style="text-align: center;" %)ArrayNode Events parameters
60 +|=(% style="text-align: center;" %)Property|=(% style="text-align: center;" %)Type|=(% style="text-align: center;" %)Description
61 +|endDate |{{{String}}}|Event start date in String, format "yyyy-MM-dd hh:mm:ss"\\
62 +|startDate |{{{String}}}|Event end date in String, format "yyyy-MM-dd hh:mm:ss"\\
63 +|drivenTimeOverallString |String\\|String value of **overallTime**, format "hh:mm:ss"\\
64 +|engineTimeString |String\\|String value of **engineTime**, format "hh:mm:ss"\\
65 +|durationString |String\\|String value of **duration**, format "hh:mm:ss"\\
66 +|driveTimeNightString |String\\|String value of **driveTimeNight**, format "hh:mm:ss"\\
67 +|driveTimeDayString |String\\|String value of **driveTimeDay**, format "hh:mm:ss"\\
68 +|distanceGPSString |String\\|String value of **distanceGPS**, format "x.yy"
69 +|distanceFMSString |String\\|String value of **distanceFMS**, format "x.yy"
70 +|duration |Long\\|Duration between events in milliseconds\\
71 +|engineTime |Long\\|Event engine time in milliseconds\\
72 +|overallTime |Long\\|Event overall driven time in milliseconds\\
73 +|driveTimeDay |Long\\|Event day driven time in milliseconds\\
74 +|driveTimeNight |Long\\|Event night driven time in milliseconds\\
75 +|distanceGPS |Double\\|Distance traveled value from GPS (km)\\
76 +|distanceFMS |Double\\|Distance traveled value from FMS (km)\\