Changes for page get_info.php

Last modified by YellowFox_RD on 2025/01/23 09:45
From version 1.1
edited by YellowFox_RD
on 2024/12/19 10:11
Change comment: Imported from XAR
To version 2.1
edited by Dominic Lippmann
on 2025/01/23 09:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.YellowFox_RD
1 +XWiki.yf-dominic
Content
... ... @@ -1,60 +1,67 @@
1 1  (% class="box" %)
2 -(((Table of Contents)))
2 +(((
3 +Table of Contents
4 +)))
5 +
3 3  {{toc/}}
4 4  
5 5  Here you can do an ETA request, which can also use the shift data of the driver and the current position of the vehicle.
9 +
6 6  (% class="box" %)
7 7  (((
8 8  This function is only available if the company has booked the module "truck routing".
9 9  )))
14 +
10 10  = Description =
16 +
11 11  (% class="blue mark" %)POST(%%)// **/eta/get_info.php?company=**RTI_COMPANYKEY**&vehicle=**RTI_VEHICLEKEY//
18 +
12 12  = Parameters =
20 +
13 13  == Query parameters ==
22 +
14 14  |=Parameters|=Description|=Type|=Hint|=Mandatory
15 -|company|RTI company key|string||yes
16 -|vehicle|RTI vehicle key|string||yes
24 +|company|RTI company key|string| |yes
25 +|vehicle|RTI vehicle key|string| |yes
17 17  
18 18  == Body parameters ==
28 +
19 19  |=Parameters|=Description|=Type|=Hint|=Mandatory
20 20  |target|Target coordinate
21 21  Struktur:
22 -
23 23  {{code language="java"}}"target": {
24 - "coordinates": {
25 - "latitude": 0,
26 - "longitude": 0
27 - }
33 + "coordinates": {
34 + "latitude": 0,
35 + "longitude": 0
36 + }
28 28  }{{/code}}|object||yes
29 29  |departure|Start coordinate for routing
30 -
31 31  {{code language="java"}}"departure": {
32 - "coordinates": {
33 - "latitude": 0,
34 - "longitude": 0
35 - },
36 - "time": "YYYY-MM-DDTHH:ii:ss+HH:ii"
40 + "coordinates": {
41 + "latitude": 0,
42 + "longitude": 0
43 + },
44 + "time": "YYYY-MM-DDTHH:ii:ss+HH:ii"
37 37  }{{/code}}|object|If //departure //is not given, the last known position of the vehicle will be used.
38 38  If //departure //is given, the coordinates are mandatory. Giving a time value is optional. Time is formatted as ISO 8601.|no
39 39  |options|Routing options
40 -
41 41  {{code language="java"}}"options": {
42 - "traffic_incidents": false,
43 - "driving_regulation_ec_561": false,
44 - "historic_speed": false
49 + "traffic_incidents": false,
50 + "driving_regulation_ec_561": false,
51 + "historic_speed": false
45 45  }{{/code}}|object|By default all options are deactivated. You can also use only some of these options. The following options are available:
46 46  (((
47 47  * **traffic_incidents**: Indicates if current traffic info (traffic jams, construction work etc.) should be used.
48 48  * **driving_regulation_ec_561**: Indicates if rules regarding steer and rest times according to EC 561/2006 should be used. Only if this is activated, the data given at //driver_info //will be used. If //driver_info //is not given, the data of the current driver of the vehicle will be used.
49 49  * **historic_speed**: Indicates if historical traffic info should be used, e.g. that driving during rush hour usually takes longer.
50 -)))|no
57 +)))
58 +|no
51 51  |driver_info|Driver data
52 -
53 53  {{code language="java"}}"driver_info": {
54 - "last_time_the_driver_worked": "YYYY-MM-DDTHH:ii:ss+HH:ii",
55 - "accumulated_driving_time_since_last_break": 0,
56 - "accumulated_driving_time_since_last_daily_rest": 0,
57 - "elapsed_time_since_end_of_last_daily_rest": 0
61 + "last_time_the_driver_worked": "YYYY-MM-DDTHH:ii:ss+HH:ii",
62 + "accumulated_driving_time_since_last_break": 0,
63 + "accumulated_driving_time_since_last_daily_rest": 0,
64 + "elapsed_time_since_end_of_last_daily_rest": 0
58 58  }{{/code}}|object|If //driver_info //is not given, the data of the current driver of the vehicle will be used.
59 59  The option //driving_regulation_ec_561 //has to be activated in order to use the driver data.
60 60  The following infos can be given:
... ... @@ -63,9 +63,11 @@
63 63  * **accumulated_driving_time_since_last_break**: Steering time since end of last break in seconds. The driver is not allowed to drive longer than 4.5 hours without break. If 4.5 hours have already been exceeded, the request will do the same as if the time is 4.5 hours.
64 64  * **accumulated_driving_time_since_last_daily_rest**: Steering time since end of last daily rest time in seconds. The driver is not allowed to drive longer than 9 hours before doing his next daily rest time. If 9 hours have already been exceeded, the request will do the same as if the time is 9 hours.
65 65  * **elapsed_time_since_end_of_last_daily_rest**: Time since end of last daily rest time in seconds. The driver has to do the next daily rest time 13 hours after shift begin at maximum. If 13 hours have already been exceeded, the request will do the same as if the time is 13 hours. This value can not be greater than //accumulated_driving_time_since_last_daily_rest.//
66 -)))|no
73 +)))
74 +|no
67 67  
68 68  = Return value =
77 +
69 69  If an error occured "(% class="error" %)**ERROR:description**(%%)" will be returned. Else the data is formatted as JSON.
70 70  You can find a detailled description of the structure of the return value as JSON schema [[here>>https://map.yellowfox.de/rti/schema/eta_get_info_schema.json]].
71 71  **Return value example**
... ... @@ -131,9 +131,12 @@
131 131  }{{/code}}
132 132  
133 133  = Example calls =
143 +
134 134  **Request with RTI key**
145 +
135 135  |https:~/~/map.yellowfox.de/rti/eta/get_info.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY
136 136  
137 137  **Request with RTI ident**
149 +
138 138  |https:~/~/map.yellowfox.de/rti/eta/get_info.php?company=COMPANY_RTIKEY={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}
139 139