positions/get_pos_data.php
Inhaltsverzeichnis
Gibt die Positionsdaten eines Fahrzeuges oder einer Fahrzeuggruppe zurück.
Wird keine Zeitraumsbegrenzung mitgegeben, wird die jeweilig aktuelle Position zurückgeliefert.
Beschreibung
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
Parameter
| Parameter | Beschreibung | Typ | Hinweis | Pflicht |
|---|---|---|---|---|
| company | RTI Firmenschlüssel | string | ja | |
| vehicle | RTI Fahrzeugschlüssel | string | entweder vehicle oder group Parameter | (ja) |
| group | RTI Gruppenschlüssel | string | entweder vehicle oder group Parameter | (ja) |
| start | Anfang des Abfragezeitraum | datestring | Format: ISO 8601 | nein |
| end | Ende des Abfragezeitraum | datestring | Format: ISO 8601 | nein |
| query_date | Datum zu welchen Zeitpunkt die jeweilige Position angezeigt werden soll | datestring | Format: ISO 8601 | nein |
| format | Rückgabeformat | string | json (Standard) | nein |
| date_type | Welches Datum bildet die Grundlage für die Zeitraumseingrenzung | string | 'insert' (Standard) = Verarbeitungsdatum 'gps' = Datum an dem die Positionsmeldung stattgefunden hat | nein |
| additional_data | Zusätzliche Parameter um bestimmte Informationen zusätzlich zu erhalten | string[] |
| nein |
| hide_display | Blendet Meldungen vom Display aus | int |
| nein |
| offset | Die Anfrage liefert maximal 5000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen. | int | nein |
Hinweis zur Datumseingrenzung
Sie können 3 verschiedene Modi nutzen:
a) Sie geben start und end an und erhalten damit alle Positionen innerhalb dieser Zeitspanne (diese beiden Zeitangaben dürfen maximal 24 Stunden auseinander liegen)
b) Sie geben nur query_date an und erhalten damit pro Fahrzeug die zu diesem Zeitpunkt aktuellste Meldung
c) Sie geben keinen Datumsparameter an und erhalten damit die derzeit aktuellste Position pro Fahrzeug
Rückgabe
Es wird ein string zurückgegeben. Im Fehlerfall wird "ERROR:Beschreibung" zurückgegeben.
Feldbeschreibung
| Feld | Beschreibung |
|---|---|
| vehicle_sign | Kennzeichen |
| rti_ident | RTI Ident |
| insert_date | Wann wurde diese Meldung von YellowFox verarbeitet? |
| gps_date | Wann wurde diese Meldung von dem Fahrzeug gesendet? |
| lat | Latitude |
| lon | Logitude |
| text_position | Textaddresse der GPS Position |
| customer | Kundenname (sofern die Adresse zu einem Kunden gehört) |
| direction | Richtung in Grad |
| satellites | Anzahl der Satelliten zur Positionsbestimmung |
| speed | Geschwindigkeit in km/h |
| ignition | Ist die Zündung an (1) oder aus (0) ? |
| reason | Warum wurde diese Positionsmeldung generiert? |
| km | Kilometerstand |
| bszX | Wert des Betriebsstundenzählers |
| driver_X | Name des Fahrers |
| driverkey_X | Personalschlüssel des Fahrers |
| eta_time | Wenn zu einem Ziel navigiert wird: Planmäßige Ankunft |
| eta_distance | Wenn zu einem Ziel navigiert wird: verbleibende Distanz |
| eta_duration | Wenn zu einem Ziel navigiert wird: verbleibende Dauer |
| eta_lat | Wenn zu einem Ziel navigiert wird: Latitude der Zielposition |
| eta_lon | Wenn zu einem Ziel navigiert wird: Longitude der Zielposition |
| eta_desc | Wenn zu einem Ziel navigiert wird: Textadresse der Zielposition |
| digital_inputs | Status der Telemetrieeingänge nr = Nummer des Eingangs (1 bis 7) name = Name des Eingangs state = Status des Eingangs als Text value = Status des Eingangs (1 = an, 0 = aus) |
| trailer_info | Optionales Feld. Beinhaltet Informationen zum Kopplungszustand mit einem Trailer date = Datum des Status type = verbunden mit Trailer (TRAILER) oder Zugmaschine (VEHICLE) name = Name des verbunden Trailers/Zugmaschine rti_ident = RTI Ident des Trailers state = Verbindungsstatus (CONNECTED oder DISCONNECTED) |
| digital_temperature_values | Optionales Feld. Beinhaltet digitale Temperaturdaten. nr = Nummer des Eingangs value = Temperatur in °C set_point = Angestrebter Wert in °C |
| analogue_temperature_values | Optionales Feld. Beinhaltet analoge Temperaturdaten. nr = Nummer des Eingangs value = Temperatur in °C |
JSON
Eine JSON Schema Beschreibung der Rückgabe finden Sie hier.
"_date" => null,
"_links" => {
"next" => {
"href" => null
}
},
"has_more" => false,
"items": [
{
"vehicle_sign": "FTL YF 123",
"rti_ident": "",
"insert_date": "2022-09-22T13:23:35+02:00",
"gps_date": "2022-09-22T13:23:23+02:00",
"lat": 48.20398,
"lon": 16.22613,
"text_position": "A-1140 Wien (Penzing) Wientalstraße (B1)",
"customer": null,
"direction": 155,
"satellites": 12,
"speed": 0,
"ignition": 0,
"reason": "AnalogMinuteInterval",
"km": 361549,
"bsz1": null,
"bsz2": null,
"driver_1": null,
"driverkey_1": null,
"driver_2": null,
"driverkey_2": null,
"eta_time": null,
"eta_distance": null,
"eta_duration": null,
"eta_lat": null,
"eta_lon": null,
"eta_desc": null,
"digital_inputs": [
{
"nr": 2,
"name": "Sensor 2",
"state": "",
"value": 0
}
],
"trailer_info": {
"date": "2022-09-22T13:18:35+02:00",
"type": "TRAILER",
"name": "Trailer 123",
"rti_ident": "TR_ID",
"state":"CONNECTED"
},
"digital_temperature_values": [
{
"nr": 1,
"value": 13.2,
"set_point": 13.3
}
],
"analogue_temperature_values": [
{
"nr": 1,
"value": 21.56
},
{
"nr": 2,
"value": 11.83
}
]
}
]
}
Beispielaufrufe
Abfrage Zeitraum für eine Gruppe
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
Abfrage fester Zeitpunkt für ein Fahrzeug
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
Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident
https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}