Changes for page get_cars.php

Last modified by YellowFox_RD on 2025/04/17 10:09
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 YellowFox_RD
on 2025/04/17 10:09
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,13 +1,20 @@
1 1  (% class="box" %)
2 -(((Table of Contents)))
2 +(((
3 +Table of Contents
4 +)))
5 +
3 3  {{toc/}}
4 4  
5 5  Shows a list of cars which are affected by a RTI request.
9 +
6 6  = Description =
7 -****(% class="green mark" %)GET(%%) **get_cars.php****?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//
11 +
12 +(% class="green mark" %)GET(%%) **get_cars.php?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//
13 +
8 8  = Parameter =
15 +
9 9  |=Parameter|=Description|=Typ|=Note|=Mandatory
10 -|company|RTI company key|string||yes
17 +|company|RTI company key|string| |yes
11 11  |vehicle|RTI vehicle key|string|either vehicle, group or import parameter|(yes)
12 12  |group|RTI group key|string|either vehicle, group or import parameter|(yes)
13 13  |import|RTI import key|string|either vehicle, group or import parameter|(yes)
... ... @@ -14,9 +14,13 @@
14 14  |format|Output format|string|csv or json, default: csv|no
15 15  
16 16  = Return =
24 +
17 17  Return a **string**. In case of error it returns "(% class="error" %)**ERROR:Description**(%%)".
26 +
18 18  == CSV ==
28 +
19 19  === Meta informations ===
30 +
20 20  |=Separator|Semicolon ( ; )
21 21  |=Delimiter|Double quote ( " )
22 22  |=Line break|0x0D 0x0A (CarriageReturn LineFeed)
... ... @@ -24,6 +24,7 @@
24 24  |=Encoding|UTF-8
25 25  
26 26  === Columns ===
38 +
27 27  |=Column|=Description
28 28  |CARNAME|name of the vehicle
29 29  |IDENT|RTI Ident
... ... @@ -30,32 +30,37 @@
30 30  |COSTCENTER|cost center of the vehicle
31 31  |VEHICLEGROUPS|group of vehicles
32 32  |KMCORRECTIONFACTOR|km correction factor
45 +|VEHICLEVIN|chassis number (VIN)
46 +|VEHICLEIDENT|vehicle ident
47 +|VEHICLEDESCRIPTION|vehicle description
33 33  
34 34  === Example ===
50 +
35 35  **Return in CSV**
36 -{{code language="java"}}"CARNAME";"IDENT";"COSTCENTER";"VEHICLEGROUPS"
37 -"CAR1";"IDENT1";"COSTCENTER1";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1"
38 -"CAR2";"IDENT2";"COSTCENTER2";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1"
39 -"CAR3";"IDENT3";"COSTCENTER3";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1"
40 -"CAR4";"IDENT4";"COSTCENTER4";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1"
41 -"CAR5";"IDENT5";"COSTCENTER5";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1"
42 -"CAR6";"IDENT6";"COSTCENTER6";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1"{{/code}}
52 +{{code language="java"}}"CARNAME";"IDENT";"COSTCENTER";"VEHICLEGROUPS";"KMCORRECTIONFACTOR";"VEHICLEVIN";"VEHICLEIDENT";"VEHICLEDESCRIPTION"
53 +"CAR1";"IDENT1";"COSTCENTER1";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"1DB69T687HT";"35fdebee00dfa3278fa88c54cd7f8c2f";"Transporter"
54 +"CAR2";"IDENT2";"COSTCENTER2";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"3DB69T687HT";"45fdebee00dfa3278fa88c54cd7f8c2f";"Transporter 2"
55 +"CAR3";"IDENT3";"COSTCENTER3";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"5DB69T687HT";"49fdebee00dfa3278fa88c54cd7f8c2f";"Transporter 3"
56 +"CAR4";"IDENT4";"COSTCENTER4";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"3UO69T687HT";"98fdebee00dfa3278fa88c54cd7f8c2f";"Transporter 4"
57 +"CAR5";"IDENT5";"COSTCENTER5";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"3DB697487HT";"4ff7debee00dfa3278fa88c54cd7f8c2f";"Transporter 5"
58 +"CAR6";"IDENT6";"COSTCENTER6";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"";"526debee00dfa3278fa88c54cd7f8c2f";"Kranwagen"{{/code}}
43 43  
44 44  == JSON ==
45 45  
46 -{{code language="java"}}[
47 - {
48 - "vehicle_sign": "FTL YF 123",
49 - "rti_ident": null,
50 - "tracking_mode": "IntelligentLocating",
51 - "tracking_interval": 0,
52 - "supported_modes": [
53 - "CourseChange",
54 - "IntelligentLocating",
55 - "DistanceInterval",
56 - "MinuteInterval"
62 +{{code language="java"}}
63 +[
64 + {
65 + "vehicle_sign": "FTL YF 123",
66 + "rti_ident": null,
67 + "tracking_mode": "IntelligentLocating",
68 + "tracking_interval": 0,
69 + "supported_modes": [
70 + "CourseChange",
71 + "IntelligentLocating",
72 + "DistanceInterval",
73 + "MinuteInterval"
57 57   ],
58 - "vehicle_groups": [
75 + "vehicle_groups": [
59 59   {
60 60   "name": "gruppe1"
61 61   },
... ... @@ -62,12 +62,17 @@
62 62   {
63 63   "name": "gruppe2"
64 64   }
65 - ],
66 - "km_correction":1
67 -       }
68 -]{{/code}}
82 + ],
83 + "km_correction":1,
84 + "vehicle_vin": "1DB69T6847HT",
85 + "vehicle_ident": "35fdebee00dfa3278fa88c54cd7f8c2f",
86 + "vehicle_description": "Transporter"
87 + }
88 +]
89 +{{/code}}
69 69  
70 70  = Example Calls =
92 +
71 71  **Name of one vehicle**
72 72  {{code language="java"}}https://map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY
73 73  
... ... @@ -79,6 +79,5 @@
79 79  **All cars, which are requestable over the RTI**
80 80  {{code language="java"}}https://map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY{{/code}}
81 81  
82 -//
83 -//
84 -
104 +
105 +\\