inventory/get_latest_history.php

Version 1.1 von Dominic Lippmann am 2025/03/04 16:31

Inhaltsverzeichnis

Gibt den jeweils aktuellsten Status samt Position zu einem oder mehreren Objekten zurück.

Beschreibung

GET /inventory/get_latest_history.php?company=RTI_COMPANYKEY&import=IMPORTKEY

Parameter

ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstringja
importRTI Importschlüsselstringja
offsetintPro Abfrage werden bis zu 1000 Einträge zurück geliefert.  Um weitere Einträge zu erhalten, können Sie ein Offset angeben.nein
profiles[]Profiles UUID[] stringoptionale Einschränkung auf eine Liste an Objektprofilennein
objects[]Objects UUID[] stringoptionale Einschränkung auf eine Liste an Objektennein
groups[]Gruppenname UUID[] stringoptionale Einschränkung auf eine Liste an Objektgruppennein
with_beaconBeacon Positionsmeldungenbool
  • false: der letzte Status wird nur anhand der gebuchten Aktivitäten zurückgegeben
  • true: Als Zeitpunkt des letzten Status werden auch Beacon-Positionsmeldungen beachtet.
nein

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

FehlerBeschreibung
MISSING_COMPANYFirmenschlüssel fehlt
INVALID_COMPANYFirma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen.
ERROR_MAINTENANCEIhre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich.
MISSING_IMPORTImport-Schlüssel fehlt.
INVENTORY_NOT_ACTIVATEDObjektverwaltung ist für ihre Firma nicht aktiviert.
INVALID_FORMAT_OFFSETOffset ist falsch.

JSON

Die genaue Spezifikation finden Sie anhand einer JSON Schema Datei hier.

Beispiel Ausgabe

{
   "_date": "2025-02-26T10:17:58+01:00",
   "_links": {
       "next": {
           "href": null
        }
    },
   "events": [
        {
           "uuid": "7a2f9959-7ee1-83ec-8599-59901fcbfd93",
           "description": "TestBeacon",
           "gpsdate": "2025-02-26T11:11:06+01",
           "last_status": {
               "value": "aktiv",
               "description": "Status"
            },
           "vehicle_sign": null,
           "driver_key": null,
           "driver_name": null,
           "lat": 51.036697,
           "lon": 13.599357,
           "satellites": 9,
           "text_position": null,
           "customer_text": "Würth",
           "orderdescr": null,
           "data_source": "position",
           "activities": []
        },
        {
           "uuid": "a5ddb6a3-20ad-a418-5236-bc7e6a229b55",
           "description": "046C8",
           "gpsdate": "2025-02-26T11:11:06+01",
           "last_status": {
               "value": "AAAA",
               "description": "dsfdsfsd"
            },
           "vehicle_sign": null,
           "driver_key": null,
           "driver_name": null,
           "lat": 51.036682,
           "lon": 13.5993805,
           "satellites": 9,
           "text_position": null,
           "customer_text": "Würth",
           "orderdescr": null,
           "data_source": "position",
           "activities": []
        }
    ]
}

Beispielaufrufe

https://map.yellowfox.de/rti/inventory/get_latest_history.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY