Änderungen von Dokument positions/get_pos_data.php

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

Von Version 3.1
bearbeitet von Dominic Lippmann
am 2025/03/05 13:13
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 4.1
bearbeitet von Dominic Lippmann
am 2025/03/05 13:47
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,14 +1,21 @@
1 1  (% class="box" %)
2 -(((Inhaltsverzeichnis)))
2 +(((
3 +Inhaltsverzeichnis
4 +)))
5 +
3 3  {{toc/}}
4 4  
5 5  Gibt die Positionsdaten eines Fahrzeuges oder einer Fahrzeuggruppe zurück.
6 6  Wird keine Zeitraumsbegrenzung mitgegeben, wird die jeweilig aktuelle Position zurückgeliefert.
10 +
7 7  = Beschreibung =
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//
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 +
9 9  = Parameter =
16 +
10 10  |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
11 -|company|RTI Firmenschlüssel|string||ja
18 +|company|RTI Firmenschlüssel|string| |ja
12 12  |vehicle|RTI Fahrzeugschlüssel|string|entweder vehicle oder group Parameter| (ja)
13 13  |group|RTI Gruppenschlüssel|string|entweder vehicle oder group Parameter| (ja)
14 14  |start|Anfang des Abfragezeitraum|datestring|Format: ISO 8601 (//YYYY-MM-DDTHH:MM:SS+HH:mm//)|nein
... ... @@ -17,17 +17,17 @@
17 17  |format|Rückgabeformat|string|json (Standard)|nein
18 18  |date_type|Welches Datum bildet die Grundlage für die Zeitraumseingrenzung|string|'insert' (Standard) = Verarbeitungsdatum
19 19  'gps' = Datum an dem die Positionsmeldung stattgefunden hat|nein
20 -|additional_data|Zusätzliche Parameter um bestimmte Informationen zusätzlich zu erhalten|string[]| (((
27 +|additional_data|Zusätzliche Parameter um bestimmte Informationen zusätzlich zu erhalten|string[]|(((
21 21  * 'temp' holt die Temperaturwerte der Digitalen Sensoren 1-8 und Analogen Sensoren 1-4
22 22  * 'trailer' holt die Trailerinformationen
23 23  )))|nein
24 -|hide_display|Blendet Meldungen vom Display aus|int| (((
31 +|hide_display|Blendet Meldungen vom Display aus|int|(((
25 25  * 0 (Standard) = Displaymeldungen werden mit ausgegeben
26 26  * 1 = Displaymeldungen werden nicht mit ausgegeben
27 27  )))|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
35 +|offset|Die Anfrage liefert maximal 5000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.|int| |nein
29 29  
30 -(% class="box" %)
37 +(% class="box info" %)
31 31  (((
32 32  **Hinweis zur Datumseingrenzung**
33 33  Sie können 3 verschiedene Modi nutzen:
... ... @@ -37,9 +37,11 @@
37 37  )))
38 38  
39 39  = Rückgabe =
47 +
40 40  Es wird ein **string** zurückgegeben. Im Fehlerfall wird "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben.
41 41  
42 42  == Feldbeschreibung ==
51 +
43 43  |=Feld|=Beschreibung
44 44  |vehicle_sign|Kennzeichen
45 45  |rti_ident|RTI Ident
... ... @@ -84,10 +84,12 @@
84 84  value = Temperatur in °C
85 85  
86 86  == JSON ==
96 +
87 87  Eine JSON Schema Beschreibung der Rückgabe finden Sie [[hier>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].
88 88  
89 -{{code language="java"}}{
90 - "_date" => null,
99 +{{code language="java"}}
100 +{
101 + "_date" => null,
91 91   "_links" => {
92 92   "next" => {
93 93   "href" => null
... ... @@ -94,7 +94,7 @@
94 94   }
95 95   },
96 96   "has_more" => false,
97 - "items": [
108 + "items": [
98 98   {
99 99   "vehicle_sign": "FTL YF 123",
100 100   "rti_ident": "",
... ... @@ -130,20 +130,20 @@
130 130   "value": 0
131 131   }
132 132   ],
133 - "trailer_info": {
144 + "trailer_info": {
134 134   "date": "2022-09-22T13:18:35+02:00",
135 135   "type": "TRAILER",
136 136   "name": "Trailer 123",
137 - "rti_ident": "TR_ID",
148 + "rti_ident": "TR_ID",
138 138   "state":"CONNECTED"
139 139   },
140 140   "digital_temperature_values": [
141 - {
152 + {
142 142   "nr": 1,
143 143   "value": 13.2,
144 - "set_point": 13.3
155 + "set_point": 13.3
145 145   }
146 - ],
157 + ],
147 147   "analogue_temperature_values": [
148 148   {
149 149   "nr": 1,
... ... @@ -155,10 +155,12 @@
155 155   }
156 156   ]
157 157   }
158 - ]
159 -}{{/code}}
169 + ]
170 +}
171 +{{/code}}
160 160  
161 161  = Beispielaufrufe =
174 +
162 162  **Abfrage Zeitraum für eine Gruppe**
163 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}}
164 164