Änderungen von Dokument positions/get_pos_data.php

Zuletzt geändert von YellowFox_RD am 2025/03/05 13:49

Von Version 5.1
bearbeitet von YellowFox_RD
am 2025/03/05 13:49
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 1.1
bearbeitet von YellowFox_RD
am 2024/12/19 10:11
Änderungskommentar: Imported from XAR

Zusammenfassung

Details

Seiteneigenschaften
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
... ... @@ -93,12 +93,10 @@
93 93  value = Temperatur in °C
94 94  
95 95  == JSON ==
96 -
97 97  Eine JSON Schema Beschreibung der Rückgabe finden Sie [[hier>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].
98 98  
99 -{{code language="java"}}
100 -{
101 - "_date" => null,
89 +{{code language="java"}}{
90 + "_date" => null,
102 102   "_links" => {
103 103   "next" => {
104 104   "href" => null
... ... @@ -105,7 +105,7 @@
105 105   }
106 106   },
107 107   "has_more" => false,
108 - "items": [
97 + "items": [
109 109   {
110 110   "vehicle_sign": "FTL YF 123",
111 111   "rti_ident": "",
... ... @@ -141,20 +141,20 @@
141 141   "value": 0
142 142   }
143 143   ],
144 - "trailer_info": {
133 + "trailer_info": {
145 145   "date": "2022-09-22T13:18:35+02:00",
146 146   "type": "TRAILER",
147 147   "name": "Trailer 123",
148 - "rti_ident": "TR_ID",
137 + "rti_ident": "TR_ID",
149 149   "state":"CONNECTED"
150 150   },
151 151   "digital_temperature_values": [
152 - {
141 + {
153 153   "nr": 1,
154 154   "value": 13.2,
155 - "set_point": 13.3
144 + "set_point": 13.3
156 156   }
157 - ],
146 + ],
158 158   "analogue_temperature_values": [
159 159   {
160 160   "nr": 1,
... ... @@ -166,17 +166,16 @@
166 166   }
167 167   ]
168 168   }
169 - ]
170 -}
171 -{{/code}}
158 + ]
159 +}{{/code}}
172 172  
173 173  = Beispielaufrufe =
174 -
175 175  **Abfrage Zeitraum für eine Gruppe**
176 -{{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}}
177 177  
178 178  **Abfrage fester Zeitpunkt für ein Fahrzeug**
179 -{{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}}
180 180  
181 181  **Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident**
182 -{{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 +