Changes for page get_info.php

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

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.yf-dominic
1 +XWiki.YellowFox_RD
Content
... ... @@ -1,67 +1,60 @@
1 1  (% class="box" %)
2 -(((
3 -Table of Contents
4 -)))
5 -
2 +(((Table of Contents)))
6 6  {{toc/}}
7 7  
8 8  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 -
10 10  (% class="box" %)
11 11  (((
12 12  This function is only available if the company has booked the module "truck routing".
13 13  )))
14 -
15 15  = Description =
16 -
17 17  (% class="blue mark" %)POST(%%)// **/eta/get_info.php?company=**RTI_COMPANYKEY**&vehicle=**RTI_VEHICLEKEY//
18 -
19 19  = Parameters =
20 -
21 21  == Query parameters ==
22 -
23 23  |=Parameters|=Description|=Type|=Hint|=Mandatory
24 -|company|RTI company key|string| |yes
25 -|vehicle|RTI vehicle key|string| |yes
15 +|company|RTI company key|string||yes
16 +|vehicle|RTI vehicle key|string||yes
26 26  
27 27  == Body parameters ==
28 -
29 29  |=Parameters|=Description|=Type|=Hint|=Mandatory
30 30  |target|Target coordinate
31 31  Struktur:
22 +
32 32  {{code language="java"}}"target": {
33 - "coordinates": {
34 - "latitude": 0,
35 - "longitude": 0
36 - }
24 + "coordinates": {
25 + "latitude": 0,
26 + "longitude": 0
27 + }
37 37  }{{/code}}|object||yes
38 38  |departure|Start coordinate for routing
30 +
39 39  {{code language="java"}}"departure": {
40 - "coordinates": {
41 - "latitude": 0,
42 - "longitude": 0
43 - },
44 - "time": "YYYY-MM-DDTHH:ii:ss+HH:ii"
32 + "coordinates": {
33 + "latitude": 0,
34 + "longitude": 0
35 + },
36 + "time": "YYYY-MM-DDTHH:ii:ss+HH:ii"
45 45  }{{/code}}|object|If //departure //is not given, the last known position of the vehicle will be used.
46 46  If //departure //is given, the coordinates are mandatory. Giving a time value is optional. Time is formatted as ISO 8601.|no
47 47  |options|Routing options
40 +
48 48  {{code language="java"}}"options": {
49 - "traffic_incidents": false,
50 - "driving_regulation_ec_561": false,
51 - "historic_speed": false
42 + "traffic_incidents": false,
43 + "driving_regulation_ec_561": false,
44 + "historic_speed": false
52 52  }{{/code}}|object|By default all options are deactivated. You can also use only some of these options. The following options are available:
53 53  (((
54 54  * **traffic_incidents**: Indicates if current traffic info (traffic jams, construction work etc.) should be used.
55 55  * **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.
56 56  * **historic_speed**: Indicates if historical traffic info should be used, e.g. that driving during rush hour usually takes longer.
57 -)))
58 -|no
50 +)))|no
59 59  |driver_info|Driver data
52 +
60 60  {{code language="java"}}"driver_info": {
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
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
65 65  }{{/code}}|object|If //driver_info //is not given, the data of the current driver of the vehicle will be used.
66 66  The option //driving_regulation_ec_561 //has to be activated in order to use the driver data.
67 67  The following infos can be given:
... ... @@ -70,11 +70,9 @@
70 70  * **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.
71 71  * **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.
72 72  * **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.//
73 -)))
74 -|no
66 +)))|no
75 75  
76 76  = Return value =
77 -
78 78  If an error occured "(% class="error" %)**ERROR:description**(%%)" will be returned. Else the data is formatted as JSON.
79 79  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]].
80 80  **Return value example**
... ... @@ -140,12 +140,9 @@
140 140  }{{/code}}
141 141  
142 142  = Example calls =
143 -
144 144  **Request with RTI key**
145 -
146 146  |https:~/~/map.yellowfox.de/rti/eta/get_info.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY
147 147  
148 148  **Request with RTI ident**
149 -
150 150  |https:~/~/map.yellowfox.de/rti/eta/get_info.php?company=COMPANY_RTIKEY={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}
151 151