Änderungen von Dokument positions/get_pos_data.php

Zuletzt geändert von YellowFox_RD am 2025/04/15 10:43

Von Version 6.1
bearbeitet von YellowFox_RD
am 2025/04/15 10:40
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 2.1
bearbeitet von Dominic Lippmann
am 2025/01/20 15:37
Änderungskommentar: Replaced user [XWiki.YellowFox_RD] in fields [author, contentAuthor, creator] to user [XWiki.yf-dominic]

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.YellowFox_RD
1 +XWiki.yf-dominic
Inhalt
... ... @@ -1,26 +1,19 @@
1 1  (% class="box" %)
2 -(((
3 -Inhaltsverzeichnis
4 -)))
5 -
2 +(((Inhaltsverzeichnis)))
6 6  {{toc/}}
7 7  
8 8  Gibt die Positionsdaten eines Fahrzeuges oder einer Fahrzeuggruppe zurück.
9 9  Wird keine Zeitraumsbegrenzung mitgegeben, wird die jeweilig aktuelle Position zurückgeliefert.
10 -
11 11  = Beschreibung =
12 -
13 -(% class="green mark" %)**GET**(%%)** positions/get_pos_data.php?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&start**=//YYYY-MM-DDTHH:MM:SS+HH:mm**&end**//=//YYYY-MM-DDTHH:MM:SS+HH:mm//
14 -
8 +**(% class="green mark" %)GET(%%) positions/get_pos_data.php****?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&start**=//YYYY-MM-DDTHH:MM:SS+HH:mm**&end**//=//YYYY-MM-DDTHH:MM:SS+HH:mm//
15 15  = Parameter =
16 -
17 17  |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
18 -|company|RTI Firmenschlüssel|string| |ja
19 -|vehicle|RTI Fahrzeugschlüssel|string|entweder vehicle oder group Parameter| (ja)
20 -|group|RTI Gruppenschlüssel|string|entweder vehicle oder group Parameter| (ja)
21 -|start|Anfang des Abfragezeitraum|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
22 -|end|Ende des Abfragezeitraum|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
23 -|query_date|Datum zu welchen Zeitpunkt die jeweilige Position angezeigt werden soll|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
11 +|company|RTI Firmenschlüssel|string||ja
12 +|vehicle|RTI Fahrzeugschlüssel|string|entweder vehicle oder group Parameter|(ja)
13 +|group|RTI Gruppenschlüssel|string|entweder vehicle oder group Parameter|(ja)
14 +|start|Anfang des Abfragezeitraum|datestring|Format: ISO 8601|nein
15 +|end|Ende des Abfragezeitraum|datestring|Format: ISO 8601|nein
16 +|query_date|Datum zu welchen Zeitpunkt die jeweilige Position angezeigt werden soll|datestring|Format: ISO 8601|nein
24 24  |format|Rückgabeformat|string|json (Standard)|nein
25 25  |date_type|Welches Datum bildet die Grundlage für die Zeitraumseingrenzung|string|'insert' (Standard) = Verarbeitungsdatum
26 26  'gps' = Datum an dem die Positionsmeldung stattgefunden hat|nein
... ... @@ -32,9 +32,9 @@
32 32  * 0 (Standard) = Displaymeldungen werden mit ausgegeben
33 33  * 1 = Displaymeldungen werden nicht mit ausgegeben
34 34  )))|nein
35 -|offset|Die Anfrage liefert maximal 5000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.|int| |nein
28 +|offset|Die Anfrage liefert maximal 5000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.|int||nein
36 36  
37 -(% class="box info" %)
30 +(% class="box" %)
38 38  (((
39 39  **Hinweis zur Datumseingrenzung**
40 40  Sie können 3 verschiedene Modi nutzen:
... ... @@ -44,11 +44,9 @@
44 44  )))
45 45  
46 46  = Rückgabe =
47 -
48 48  Es wird ein **string** zurückgegeben. Im Fehlerfall wird "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben.
49 49  
50 50  == Feldbeschreibung ==
51 -
52 52  |=Feld|=Beschreibung
53 53  |vehicle_sign|Kennzeichen
54 54  |rti_ident|RTI Ident
... ... @@ -73,15 +73,11 @@
73 73  |eta_lat|Wenn zu einem Ziel navigiert wird: Latitude der Zielposition
74 74  |eta_lon|Wenn zu einem Ziel navigiert wird: Longitude der Zielposition
75 75  |eta_desc|Wenn zu einem Ziel navigiert wird: Textadresse der Zielposition
76 -|digital_inputs|(((
77 -Status der Telemetrieeingänge
67 +|digital_inputs|Status der Telemetrieeingänge
78 78  nr = Nummer des Eingangs (1 bis 7)
79 79  name = Name des Eingangs
80 80  state = Status des Eingangs als Text
81 81  value =  Status des Eingangs (1 = an, 0 = aus)
82 -
83 -ident = technisches Identifikationsmerkmal, kann in den fahrzeugbezogenen Einstellungen festgelegt werden
84 -)))
85 85  |trailer_info|Optionales Feld. Beinhaltet Informationen zum Kopplungszustand mit einem Trailer
86 86  date = Datum des Status
87 87  type = verbunden mit Trailer (TRAILER) oder Zugmaschine (VEHICLE)
... ... @@ -97,12 +97,10 @@
97 97  value = Temperatur in °C
98 98  
99 99  == JSON ==
100 -
101 101  Eine JSON Schema Beschreibung der Rückgabe finden Sie [[hier>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].
102 102  
103 -{{code language="java"}}
104 -{
105 - "_date" => null,
89 +{{code language="java"}}{
90 + "_date" => null,
106 106   "_links" => {
107 107   "next" => {
108 108   "href" => null
... ... @@ -109,7 +109,7 @@
109 109   }
110 110   },
111 111   "has_more" => false,
112 - "items": [
97 + "items": [
113 113   {
114 114   "vehicle_sign": "FTL YF 123",
115 115   "rti_ident": "",
... ... @@ -145,20 +145,20 @@
145 145   "value": 0
146 146   }
147 147   ],
148 - "trailer_info": {
133 + "trailer_info": {
149 149   "date": "2022-09-22T13:18:35+02:00",
150 150   "type": "TRAILER",
151 151   "name": "Trailer 123",
152 - "rti_ident": "TR_ID",
137 + "rti_ident": "TR_ID",
153 153   "state":"CONNECTED"
154 154   },
155 155   "digital_temperature_values": [
156 - {
141 + {
157 157   "nr": 1,
158 158   "value": 13.2,
159 - "set_point": 13.3
144 + "set_point": 13.3
160 160   }
161 - ],
146 + ],
162 162   "analogue_temperature_values": [
163 163   {
164 164   "nr": 1,
... ... @@ -170,17 +170,16 @@
170 170   }
171 171   ]
172 172   }
173 - ]
174 -}
175 -{{/code}}
158 + ]
159 +}{{/code}}
176 176  
177 177  = Beispielaufrufe =
178 -
179 179  **Abfrage Zeitraum für eine Gruppe**
180 -{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&start=2022-09-22T13:23:00%2B00:00:00&end=2022-09-22T14:23:00%2B00:00:00&additional_data[]=temp{{/code}}
163 +{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&start=2022-09-22T13:23:00%2B00:00:00&end=2022-09-22T14:23:00%2B00:00:00&additional_data[]=temp{{/code}}
181 181  
182 182  **Abfrage fester Zeitpunkt für ein Fahrzeug**
183 -{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&query_date=2022-09-22T13:23:00%2B00:00:00{{/code}}
166 +{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&query_date=2022-09-22T13:23:00%2B00:00:00{{/code}}
184 184  
185 185  **Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident**
186 -{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}{{/code}}
169 +{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}{{/code}}
170 +