inventory/get_history.php
Inhaltsverzeichnis
Gibt die gebuchten Aktivitäten und Positionsaktualisierungen (nur in Verbindung mit einem YellowFox Beacon) für ein- oder mehrere Objekte im gewünschten Zeitraum wieder.
Beschreibung
GET /inventory/get_history.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY
Parameter
| Parameter | Beschreibung | Typ | Hinweis | Pflicht |
|---|---|---|---|---|
| company | RTI Firmenschlüssel | string | ja | |
| import | RTI Importschlüssel | string | ja | |
| offset | unsigned int | Pro Abfrage werden bis zu 1000 Einträge zurück geliefert. Um weitere Einträge zu erhalten, können Sie ein Offset angeben. | nein | |
| date_from | Format: ISO 8601 (YYYY-MM-DD) | datestring | Startzeit, ab wann Buchungen abgerufen werden sollen. Ist kein Wert für date_from und date_to gesetzt, wird einen Monat zurück gegangen. | nein |
| date_to | datestring | Endzeit, bis wann Buchungen abgerufen werden sollen. Ist keine Zeit angegeben, wird der Zeitpunkt der Abfrage verwendet. | nein | |
| profiles[] | Profiles UUID | [] string | optionale Einschränkung auf eine Liste an Objektprofilen | nein |
| objects[] | Objects UUID | [] string | optionale Einschränkung auf eine Liste an Objekten | nein |
| groups[] | Gruppenname UUID | [] string | optionale Einschränkung auf eine Liste an Objektgruppen | nein |
| with_beacon | Beacon Positionsmeldungen | bool |
| nein |
Hinweis zur Datumseingrenzung
Sie können 3 verschiedene Modi nutzen:
a) ohne Datumsangabe (date_from, date_to) werden die Daten des letzten Monats abgerufen
b) mit gesetztem Startdatum (date_from) werden alle Daten ab diesem Datum abgerufen (maximal 1 Monat)
c) mit gesetztem Start- und Enddatum werden alle Daten im angegebenen Zeitraum abgerufen (maximal 1 Monat)
Rückgabe
Bei Erfolg erhalten Sie die Rückgabe im JSON Format. Bei fehlenden Pflichtparametern oder Fehlern wird ein "ERROR:Beschreibung" zurückgegeben.
Mögliche Fehlerwerte
| Fehler | Beschreibung |
|---|---|
| MISSING_COMPANY | Firmenschlüssel fehlt |
| INVALID_COMPANY | Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen. |
| ERROR_MAINTENANCE | Ihre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich. |
| MISSING_IMPORT | Import-Schlüssel fehlt. |
| INVENTORY_NOT_ACTIVATED | Objektverwaltung ist für ihre Firma nicht aktiviert. |
| INVALID_DATE_RANGE | Zeitraum wurde überschreiten. |
| MISSING_DATE_FROM | DateFrom fehlt |
| INVALID_FORMAT_OFFSET | Offset ist falsch |
JSON
Die genaue Spezifikation finden Sie anhand einer JSON Schema Datei hier.
Beispiel Ausgabe
"_date": "2025-02-26T10:13:17+01:00",
"_links": {
"next": {
"href": null
}
},
"events": [
{
"uuid": "7d64c6ac-49fd-0d4e-27e6-f7c1ea727b2b",
"gpsdate": "2025-02-25T11:59:20+01",
"data_source": "booking",
"driver_name": null,
"vehicle_sign": null,
"lat": 0,
"lon": 0,
"satellites": 0,
"text_position": "",
"customer_text": null,
"activities": [
{
"value": "Abgesetzt",
"description": "Status"
},
{
"value": "Bauhof",
"description": "Status"
},
{
"value": 1,
"description": "Betriebsgewicht"
},
{
"value": 12,
"description": "Verdichtungstiefe"
},
{
"value": 22,
"description": "Flächenleistung"
},
{
"value": "Hallo",
"description": "Status 2"
},
{
"value": 1,
"description": "test"
}
]
},
{
"uuid": "a5ddb6a3-20ad-a418-5236-bc7e6a229b55",
"gpsdate": "2025-02-25T11:58:29+01",
"data_source": "position",
"driver_name": null,
"vehicle_sign": null,
"lat": 51.03629,
"lon": 13.59799,
"satellites": 8,
"text_position": null,
"customer_text": "test",
"activities": []
}
]
}