Wiki-Quellcode von inventory/get_history.php
Version 1.1 von Dominic Lippmann am 2025/03/04 16:20
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | ~(% class="box" %) | ||
| 2 | ~(~(~(Inhaltsverzeichnis~)~)~) | ||
| 3 | ~{~{toc/}} | ||
| 4 | |||
| 5 | 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. | ||
| 6 | ~= Beschreibung = | ||
| 7 | ~/~/~*~*GET ~*~*~/~/~/~/~*~*/inventory/get_history.php?company~*~*=RTI_COMPANYKEY~*~*&import~*~*=RTI_IMPORTKEY~/~/ | ||
| 8 | |||
| 9 | ~= Parameter = | ||
| 10 | ~|=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
| 11 | ~|company|RTI Firmenschlüssel|string||ja | ||
| 12 | ~|import|RTI Importschlüssel|string||ja | ||
| 13 | ~|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 | ||
| 14 | ~|date_from|Format: ISO 8601 | ||
| 15 | (YYYY-MM-DD)|datestring|Startzeit, ab wann Buchungen abgerufen werden sollen. | ||
| 16 | Ist kein Wert für date_from und date_to gesetzt, wird einen Monat zurück gegangen.|nein | ||
| 17 | ~|date_to|datestring|Endzeit, bis wann Buchungen abgerufen werden sollen. Ist keine Zeit angegeben, wird der Zeitpunkt der Abfrage verwendet.|nein | ||
| 18 | ~|profiles[]|Profiles UUID|[] string|optionale Einschränkung auf eine Liste an Objektprofilen|nein | ||
| 19 | ~|objects[]|Objects UUID|[] string|optionale Einschränkung auf eine Liste an Objekten|nein | ||
| 20 | ~|groups[]|Gruppenname UUID|[] string|optionale Einschränkung auf eine Liste an Objektgruppen|nein | ||
| 21 | ~|with_beacon|Beacon Positionsmeldungen|bool| ~(~(~( | ||
| 22 | ~* false: nur gebuchte Objekt- oder Statusänderungen werden zurückgegeben | ||
| 23 | ~* true: alle Positionsaktualisierungen durch Beacons werden mit zurückgegeben.~(~(~( | ||
| 24 | ~* Achtung: Dadurch können schnell große Datenmengen entstehen. | ||
| 25 | ~)~)~) | ||
| 26 | ~)~)~)|nein | ||
| 27 | |||
| 28 | ~(% class="box" %) | ||
| 29 | ~(~(~( | ||
| 30 | ~*~*Hinweis zur Datumseingrenzung | ||
| 31 | ~*~*Sie können 3 verschiedene Modi nutzen: | ||
| 32 | a) ohne Datumsangabe (date_from, date_to) werden die Daten des letzten Monats abgerufen | ||
| 33 | b) mit gesetztem Startdatum (date_from) werden alle Daten ab diesem Datum abgerufen (maximal 1 Monat) | ||
| 34 | c) mit gesetztem Start- und Enddatum werden alle Daten im angegebenen Zeitraum abgerufen (maximal 1 Monat) | ||
| 35 | ~)~)~) | ||
| 36 | |||
| 37 | ~= Rückgabe = | ||
| 38 | Bei Erfolg erhalten Sie die Rückgabe im JSON Format. Bei fehlenden Pflichtparametern oder Fehlern wird ein "~(% class="error" %)~*~*ERROR:Beschreibung~*~*~(%%)" zurückgegeben. | ||
| 39 | |||
| 40 | ~== Mögliche Fehlerwerte == | ||
| 41 | ~|=Fehler|=Beschreibung | ||
| 42 | ~|MISSING_COMPANY|Firmenschlüssel fehlt | ||
| 43 | ~|INVALID_COMPANY|Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen. | ||
| 44 | ~|ERROR_MAINTENANCE|Ihre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich. | ||
| 45 | ~|MISSING_IMPORT|Import-Schlüssel fehlt. | ||
| 46 | ~|INVENTORY_NOT_ACTIVATED|Objektverwaltung ist für ihre Firma nicht aktiviert. | ||
| 47 | ~|INVALID_DATE_RANGE|Zeitraum wurde überschreiten. | ||
| 48 | ~|MISSING_DATE_FROM|DateFrom fehlt | ||
| 49 | ~|INVALID_FORMAT_OFFSET|Offset ist falsch | ||
| 50 | |||
| 51 | ~== JSON == | ||
| 52 | Die genaue Spezifikation finden Sie anhand einer JSON Schema Datei ~[~[hier>>https:~/~/map.yellowfox.de/rti/schema/get_history_schema.json]]. | ||
| 53 | |||
| 54 | ~*~*Beispiel Ausgabe~*~* | ||
| 55 | |||
| 56 | ~{~{code language="js"}}{ | ||
| 57 | "_date": "2025-02-26T10:13:17+01:00", | ||
| 58 | "_links": { | ||
| 59 | "next": { | ||
| 60 | "href": null | ||
| 61 | } | ||
| 62 | }, | ||
| 63 | "events": [ | ||
| 64 | { | ||
| 65 | "uuid": "7d64c6ac-49fd-0d4e-27e6-f7c1ea727b2b", | ||
| 66 | "gpsdate": "2025-02-25T11:59:20+01", | ||
| 67 | "data_source": "booking", | ||
| 68 | "driver_name": null, | ||
| 69 | "vehicle_sign": null, | ||
| 70 | "lat": 0, | ||
| 71 | "lon": 0, | ||
| 72 | "satellites": 0, | ||
| 73 | "text_position": "", | ||
| 74 | "customer_text": null, | ||
| 75 | "activities": [ | ||
| 76 | { | ||
| 77 | "value": "Abgesetzt", | ||
| 78 | "description": "Status" | ||
| 79 | }, | ||
| 80 | { | ||
| 81 | "value": "Bauhof", | ||
| 82 | "description": "Status" | ||
| 83 | }, | ||
| 84 | { | ||
| 85 | "value": 1, | ||
| 86 | "description": "Betriebsgewicht" | ||
| 87 | }, | ||
| 88 | { | ||
| 89 | "value": 12, | ||
| 90 | "description": "Verdichtungstiefe" | ||
| 91 | }, | ||
| 92 | { | ||
| 93 | "value": 22, | ||
| 94 | "description": "Flächenleistung" | ||
| 95 | }, | ||
| 96 | { | ||
| 97 | "value": "Hallo", | ||
| 98 | "description": "Status 2" | ||
| 99 | }, | ||
| 100 | { | ||
| 101 | "value": 1, | ||
| 102 | "description": "test" | ||
| 103 | } | ||
| 104 | ] | ||
| 105 | }, | ||
| 106 | { | ||
| 107 | "uuid": "a5ddb6a3-20ad-a418-5236-bc7e6a229b55", | ||
| 108 | "gpsdate": "2025-02-25T11:58:29+01", | ||
| 109 | "data_source": "position", | ||
| 110 | "driver_name": null, | ||
| 111 | "vehicle_sign": null, | ||
| 112 | "lat": 51.03629, | ||
| 113 | "lon": 13.59799, | ||
| 114 | "satellites": 8, | ||
| 115 | "text_position": null, | ||
| 116 | "customer_text": "test", | ||
| 117 | "activities": [] | ||
| 118 | } | ||
| 119 | |||
| 120 | ] | ||
| 121 | }~{~{/code}} | ||
| 122 | |||
| 123 | ~= Beispielaufrufe = | ||
| 124 | ~{~{code language="js"}}https:~/~/map.yellowfox.de/rti/inventory/get_history.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY~{~{/code}} |