Changes for page plan_sequence.php

Last modified by YellowFox_RD on 2025/01/23 10:07
From version 2.1
edited by YellowFox_RD
on 2025/01/23 10:07
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
Content
... ... @@ -1,20 +1,14 @@
1 1  (% class="box" %)
2 -(((
3 -Table of Contents
4 -)))
5 -
2 +(((Table of Contents)))
6 6  {{toc/}}
7 7  
8 8  Route optimization function (only for customers with PTV as map provider or customers who have booked the Multi Map Option)
9 9  
10 10  = Beschreibung =
11 -
12 -(% class="blue mark" %)**POST**(%%)** plan_sequence.php?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&profile=**truck**&points=points_json_array**
13 -
8 +**(% class="blue mark" %)POST(%%) plan_sequence.php?****company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&profile=**truck**&points=points_json_array**
14 14  = Parameters =
15 -
16 16  |=Parameter|=Description|=Type|=Notes|=Mandatory
17 -|company|RTI Company key|string| |Yes
11 +|company|RTI Company key|string||Yes
18 18  |vehicle|RTI Vehicle key|string|One of the parameters vehicle, group or import must always be given!|(Yes)
19 19  |group|RTI Group key|string|One of the parameters vehicle, group or import must always be given!|(Yes)
20 20  |import|RTI Import key (All vehicles)|string|One of the parameters vehicle, group or import must always be given!|(Yes)
... ... @@ -24,13 +24,13 @@
24 24  )))|string|Standard is "car"|No
25 25  |points|The orders / destinations which should be optimized|json-array|See description "points_json_array"|Yes
26 26  
27 -== **points_json_array** ==
21 +=== **points_json_array** ===
28 28  
29 29  |=Parameter|=Description|=Type|=Notes|=Mandatory
30 -|id| |int| |Yes
31 -|lat|Latitude of the point|double| |Yes
32 -|lon|Longitude of the point|double| |Yes
33 -|meta| |string| |No
24 +|id||int||Yes
25 +|lat|Latitude of the point|double||Yes
26 +|lon|Longitude of the point|double||Yes
27 +|meta||string||No
34 34  |type|(((
35 35  * start
36 36  * end
... ... @@ -37,11 +37,8 @@
37 37  )))|string|with this you can set the start and/or the end of the tour|No
38 38  
39 39  = Return =
40 -
41 41  A string is returned. If successful, "**OK**" is returned as response. Otherwise an "**ERROR:Description**" is returned.
42 -
43 43  == JSON Format ==
44 -
45 45  |=Parameter|=Description|=Type
46 46  |id|passed id|int
47 47  |type|"start", "end" oder ""|string
... ... @@ -51,47 +51,46 @@
51 51  
52 52  **example**
53 53  {{code language="js"}}{
54 - [
55 - {
56 - "id": 1,
57 - "type": "start",
58 - "lat": 51.0311742,
59 - "lon": 13.6034718,
60 - "meta": "YF"
61 - },
62 - {
63 - "id": 3,
64 - "type": "",
65 - "lat": 51.042972,
66 - "lon": 13.794998,
67 - "meta": "Dresden"
68 - },
69 - {
70 - "id": 2,
71 - "type": "",
72 - "lat": 51.268333,
73 - "lon": 14.326741,
74 - "meta": "Neschwitz"
75 - },
76 - {
77 - "id": 4,
78 - "type": "",
79 - "lat": 51.305518,
80 - "lon": 13.295992,
81 - "meta": "Riesa"
82 - },
83 - {
84 - "id": 5,
85 - "type": "end",
86 - "lat": 51.0311742,
87 - "lon": 13.6034718,
88 - "meta": "YF"
89 - }
90 - ]
45 + [
46 + {
47 + "id": 1,
48 + "type": "start",
49 + "lat": 51.0311742,
50 + "lon": 13.6034718,
51 + "meta": "YF"
52 + },
53 + {
54 + "id": 3,
55 + "type": "",
56 + "lat": 51.042972,
57 + "lon": 13.794998,
58 + "meta": "Dresden"
59 + },
60 + {
61 + "id": 2,
62 + "type": "",
63 + "lat": 51.268333,
64 + "lon": 14.326741,
65 + "meta": "Neschwitz"
66 + },
67 + {
68 + "id": 4,
69 + "type": "",
70 + "lat": 51.305518,
71 + "lon": 13.295992,
72 + "meta": "Riesa"
73 + },
74 + {
75 + "id": 5,
76 + "type": "end",
77 + "lat": 51.0311742,
78 + "lon": 13.6034718,
79 + "meta": "YF"
80 + }
81 + ]
91 91  }{{/code}}
92 92  
93 93  = Example =
94 -
95 95  **with fixed start and end**
96 96  {{code language="java"}}https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"start"},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"end"}]
97 97  
... ... @@ -113,7 +113,6 @@
113 113  https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.6034718},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"end"}]{{/code}}
114 114  
115 115  = Error =
116 -
117 117  |=Error|=Description
118 118  |ERROR:PTV_OR_MULTI_MAP_IS_REQUIRED|You need PTV as a card provider or the paid option "multi card", please contact our sales department
119 119  |ERROR:NO_CAR_IN_MIN_BUSINESS_TARIFF|At least 1 vehicle must have a business tariff or higher